| 1 | /******************************************************************************* |
| 2 | * Copyright (c) 2009, 2014 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.tracecompass.tmf.core.trace.location; |
| 15 | |
| 16 | import java.nio.ByteBuffer; |
| 17 | |
| 18 | /** |
| 19 | * The generic trace location in TMF. |
| 20 | * <p> |
| 21 | * An ITmfLocation is the equivalent of a random-access file position, holding |
| 22 | * enough information to allow the positioning of the trace 'pointer' to read an |
| 23 | * arbitrary event. |
| 24 | * <p> |
| 25 | * This location is trace-specific, must be comparable and immutable. |
| 26 | * |
| 27 | * @author Francois Chouinard |
| 28 | * @since 3.0 |
| 29 | */ |
| 30 | public interface ITmfLocation { |
| 31 | |
| 32 | // ------------------------------------------------------------------------ |
| 33 | // Getters |
| 34 | // ------------------------------------------------------------------------ |
| 35 | |
| 36 | /** |
| 37 | * Returns the concrete trace location information |
| 38 | * |
| 39 | * @return the location information |
| 40 | * @since 2.0 |
| 41 | */ |
| 42 | Comparable<?> getLocationInfo(); |
| 43 | |
| 44 | /** |
| 45 | * Write the location to the ByteBuffer so that it can be saved to disk. |
| 46 | * @param bufferOut the buffer to write to |
| 47 | * |
| 48 | * @since 3.0 |
| 49 | */ |
| 50 | void serialize(ByteBuffer bufferOut); |
| 51 | } |