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