[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / trace / ITmfLocation.java

/*******************************************************************************
 * Copyright (c) 2009, 2010, 2012 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Francois Chouinard - Initial API and implementation
 *   Francois Chouinard - Updated as per TMF Trace Model 1.0
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.core.trace;

/**
 * The generic trace location in TMF.
 * <p>
 * An ITmfLocation is the equivalent of a random-access file position, holding
 * enough information to allow the positioning of the trace 'pointer' to read an
 * arbitrary event.
 * <p>
 * This location is trace-specific, must be comparable and immutable.
 *
 * @version 2.0
 * @author Francois Chouinard
 */
public interface ITmfLocation {

    // ------------------------------------------------------------------------
    // Getters
    // ------------------------------------------------------------------------

    /**
     * Returns the concrete trace location information
     *
     * @return the location information
     * @since 2.0
     */
    public Comparable<?> getLocationInfo();

}
Commit	Line	Data
8c8bf09f	1	/*******************************************************************************
fcccd900	2	* Copyright (c) 2009, 2010, 2012 Ericsson
0283f7ff	3	*
8c8bf09f ASL	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
0283f7ff	8	*
8c8bf09f ASL	9	* Contributors:
8c8bf09f ASL	10	* Francois Chouinard - Initial API and implementation
fcccd900	11	* Francois Chouinard - Updated as per TMF Trace Model 1.0
8c8bf09f ASL	12	*******************************************************************************/
8c8bf09f ASL	13
6c13869b	14	package org.eclipse.linuxtools.tmf.core.trace;
8c8bf09f ASL	15
8c8bf09f ASL	16	/**
2848c377 FC	17	* The generic trace location in TMF.
2848c377 FC	18	* <p>
fcccd900 FC	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>
d62bb185	23	* This location is trace-specific, must be comparable and immutable.
0283f7ff	24	*
5976d44a	25	* @version 2.0
f7703ed6	26	* @author Francois Chouinard
8c8bf09f	27	*/
1e1bef82	28	public interface ITmfLocation {
452ad365	29
fcccd900 FC	30	// ------------------------------------------------------------------------
	31	// Getters
	32	// ------------------------------------------------------------------------
	33
	34	/**
5976d44a FC	35	* Returns the concrete trace location information
	36	*
	37	* @return the location information
6bab4511	38	* @since 2.0
fcccd900	39	*/
5976d44a	40	public Comparable<?> getLocationInfo();
452ad365	41
8c8bf09f	42	}