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

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 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  *   Alexandre Montplaisir - Initial API
  11  ******************************************************************************/
  12
  13 package org.eclipse.linuxtools.statesystem.core.interval;
  14
  15 import org.eclipse.linuxtools.statesystem.core.statevalue.ITmfStateValue;
  16
  17 /**
  18  * This is the basic interface for accessing state intervals. See
  19  * StateInterval.java for a basic implementation.
  20  *
  21  * A StateInterval is meant to be immutable. All implementing (non-abstract)
  22  * classes should ideally be marked as 'final'.
  23  *
  24  * @author Alexandre Montplaisir
  25  * @since 3.0
  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      * In case the "real" end time of the interval is not exactly the same as
  45      * the end time you want to show in views, you can implement this method to
  46      * assign a different value that the viewer can use.
  47      *
  48      * If not, you can simply have it return the same as getEndTime().
  49      *
  50      * @return The end time that views should use
  51      */
  52     long getViewerEndTime();
  53
  54     /**
  55      * Retrieve the quark of the attribute this state interval refers to
  56      *
  57      * @return the quark of the attribute this state interval refers to
  58      */
  59     int getAttribute();
  60
  61     /**
  62      * Retrieve the state value represented by this interval
  63      *
  64      * @return the state value represented by this interval
  65      */
  66     ITmfStateValue getStateValue();
  67
  68     /**
  69      * Test if this interval intersects another timestamp, inclusively.
  70      *
  71      * @param timestamp
  72      *            The target timestamp
  73      * @return True if the interval and timestamp intersect, false if they don't
  74      */
  75     boolean intersects(long timestamp);
  76 }