org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfLocation.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010, 2012 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *   Francois Chouinard - Updated as per TMF Trace Model 1.0
  12  *******************************************************************************/
  13
  14 package org.eclipse.linuxtools.tmf.core.trace;
  15
  16 /**
  17  * <b><u>ITmfLocation</u></b>
  18  * <p>
  19  * An ITmfLocation is the equivalent of a random-access file position, holding
  20  * enough information to allow the positioning of the trace 'pointer' to read an
  21  * arbitrary event.
  22  * <p>
  23  * This location is trace-specific but must be comparable.
  24  */
  25 public interface ITmfLocation<L extends Comparable<?>> extends Cloneable {
  26
  27     // ------------------------------------------------------------------------
  28     // Getters
  29     // ------------------------------------------------------------------------
  30
  31     /**
  32      * @return the location
  33      */
  34     public L getLocation();
  35
  36     // ------------------------------------------------------------------------
  37     // Cloneable
  38     // ------------------------------------------------------------------------
  39
  40     /**
  41      * @return a clone of the location
  42      */
  43     public ITmfLocation<L> clone();
  44
  45 }