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 /**
  18  * The generic trace location in TMF.
  19  * <p>
  20  * An ITmfLocation is the equivalent of a random-access file position, holding
  21  * enough information to allow the positioning of the trace 'pointer' to read an
  22  * arbitrary event.
  23  * <p>
  24  * This location is trace-specific and must be comparable.
  25  *
  26  * @version 1.0
  27  * @author Francois Chouinard
  28  */
  29 public interface ITmfLocation {
  30
  31     // ------------------------------------------------------------------------
  32     // Getters
  33     // ------------------------------------------------------------------------
  34
  35     /**
  36      * @return the location
  37      * @since 2.0
  38      */
  39     public Comparable<?> getLocationData();
  40
  41     // ------------------------------------------------------------------------
  42     // Operations
  43     // ------------------------------------------------------------------------
  44
  45     /**
  46      * @return a clone of the location
  47      */
  48     public ITmfLocation clone();
  49
  50 }