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  * The generic trace location in TMF.
  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 and must be comparable.
  24  *
  25  * @version 2.0
  26  * @author Francois Chouinard
  27  */
  28 public interface ITmfLocation {
  29
  30     // ------------------------------------------------------------------------
  31     // Getters
  32     // ------------------------------------------------------------------------
  33
  34     /**
  35      * Returns the concrete trace location information
  36      *
  37      * @return the location information
  38      * @since 2.0
  39      */
  40     public Comparable<?> getLocationInfo();
  41
  42     // ------------------------------------------------------------------------
  43     // Operations
  44     // ------------------------------------------------------------------------
  45
  46     /**
  47      * @return a clone of the location
  48      */
  49     public ITmfLocation clone();
  50
  51 }