Commit | Line | Data |
---|---|---|
032ecd45 | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2013, 2014 Ericsson |
032ecd45 MAL |
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 | * Marc-Andre Laperle - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.core.trace.indexer; |
032ecd45 MAL |
14 | |
15 | import java.nio.ByteBuffer; | |
16 | ||
2bdf0193 | 17 | import org.eclipse.tracecompass.tmf.core.trace.location.ITmfLocation; |
032ecd45 MAL |
18 | |
19 | /** | |
20 | * A trace implementing this interface can be indexed and its index can be | |
21 | * persisted to disk. | |
22 | * | |
23 | * @author Marc-Andre Laperle | |
24 | */ | |
25 | public interface ITmfPersistentlyIndexable { | |
26 | ||
27 | /** | |
28 | * Instantiate a ITmfLocation from a ByteBuffer, typically from disk. | |
29 | * | |
30 | * @param bufferIn | |
31 | * the buffer to read from | |
32 | * @return the instantiated location | |
032ecd45 MAL |
33 | */ |
34 | ITmfLocation restoreLocation(ByteBuffer bufferIn); | |
35 | ||
36 | /** | |
37 | * Get the checkpoint size for this trace | |
38 | * | |
39 | * @return the checkpoint size | |
032ecd45 MAL |
40 | */ |
41 | public int getCheckpointSize(); | |
42 | } |