statesystem/org.eclipse.tracecompass.statesystem.core/src/org/eclipse/tracecompass/statesystem/core/interval/ITmfStateInterval.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 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  *   Alexandre Montplaisir - Initial API
  11  ******************************************************************************/
  12
  13 package org.eclipse.tracecompass.statesystem.core.interval;
  14
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
  17
  18 /**
  19  * This is the basic interface for accessing state intervals. See
  20  * StateInterval.java for a basic implementation.
  21  *
  22  * A StateInterval is meant to be immutable. All implementing (non-abstract)
  23  * classes should ideally be marked as 'final'.
  24  *
  25  * @author Alexandre Montplaisir
  26  */
  27 public interface ITmfStateInterval {
  28
  29     /**
  30      * Retrieve the start time of the interval
  31      *
  32      * @return the start time of the interval
  33      */
  34     long getStartTime();
  35
  36     /**
  37      * Retrieve the end time of the interval
  38      *
  39      * @return the end time of the interval
  40      */
  41     long getEndTime();
  42
  43     /**
  44      * Retrieve the quark of the attribute this state interval refers to
  45      *
  46      * @return the quark of the attribute this state interval refers to
  47      */
  48     int getAttribute();
  49
  50     /**
  51      * Retrieve the state value represented by this interval
  52      *
  53      * @return the state value represented by this interval
  54      */
  55     @NonNull ITmfStateValue getStateValue();
  56
  57     /**
  58      * Test if this interval intersects another timestamp, inclusively.
  59      *
  60      * @param timestamp
  61      *            The target timestamp
  62      * @return True if the interval and timestamp intersect, false if they don't
  63      */
  64     boolean intersects(long timestamp);
  65 }