tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/ITmfTraceKnownSize.java

   1 /**********************************************************************
   2  * Copyright (c) 2016 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
  10 package org.eclipse.tracecompass.tmf.core.trace;
  11
  12 /**
  13  * An interface that trace classes can implement if they have a known size, so
  14  * that reading progress can be shown.
  15  *
  16  * @author Matthew Khouzam
  17  * @since 2.1
  18  */
  19 public interface ITmfTraceKnownSize {
  20     /**
  21      * Get the size of the trace. The units of this value are not important, but
  22      * they should always be the same as {@link #progress()}
  23      *
  24      * @return the size of the trace. This can change from one call to the
  25      *         other, but a later call to this method should not see a decrease
  26      *         in size.
  27      */
  28     int size();
  29
  30     /**
  31      * How much of the trace is read. The units of this value are not important,
  32      * but they should always be the same as {@link #size()}
  33      *
  34      * @return how much of the trace is read. This should not exceed
  35      *         {@link #size()}
  36      */
  37     int progress();
  38 }