org.eclipse.tracecompass.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/indexer/ITmfPersistentlyIndexable.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013 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  *     Marc-Andre Laperle - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.core.trace.indexer;
  14
  15 import java.nio.ByteBuffer;
  16
  17 import org.eclipse.linuxtools.tmf.core.trace.location.ITmfLocation;
  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  * @since 3.0
  25  */
  26 public interface ITmfPersistentlyIndexable {
  27
  28     /**
  29      * Instantiate a ITmfLocation from a ByteBuffer, typically from disk.
  30      *
  31      * @param bufferIn
  32      *            the buffer to read from
  33      * @return the instantiated location
  34      *
  35      * @since 3.0
  36      */
  37     ITmfLocation restoreLocation(ByteBuffer bufferIn);
  38
  39     /**
  40      * Get the checkpoint size for this trace
  41      *
  42      * @return the checkpoint size
  43      *
  44      * @since 3.0
  45      */
  46     public int getCheckpointSize();
  47 }