Refactor ITmfContext and fix dependencies

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / trace / ITmfContext.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java
index 4606ef1eebcd93c91a491b4bd739a695843106b9..2d7aed53660aa126178d8ab057bcc5dc29299eca 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/ITmfContext.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2010 Ericsson
+ * Copyright (c) 2009, 2010, 2012 Ericsson
  * 
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License v1.0 which
@@ -8,6 +8,7 @@
  * 
  * Contributors:
  *   Francois Chouinard - Initial API and implementation
+ *   Francois Chouinard - Updated as per TMF Trace Model 1.0
  *******************************************************************************/
 
 package org.eclipse.linuxtools.tmf.core.trace;
@@ -15,28 +16,78 @@ package org.eclipse.linuxtools.tmf.core.trace;
 /**
  * <b><u>ITmfContext</u></b>
  * <p>
- * This is a place-holder for the context objects.
+ * The basic trace context structure in TMF. The purpose of the context is to
+ * associate a trace location to an event of a specific rank (order).
+ * <p>
+ * The context should be sufficient to allow the trace to position itself so
+ * that performing a trace read operation will yield the corresponding event.
  */
 public interface ITmfContext extends Cloneable {
 
-    public long UNKNOWN_RANK = -2L;
+    // ------------------------------------------------------------------------
+    // Constants
+    // ------------------------------------------------------------------------
+
+    /**
+     * The initial context event rank, before anything is read from the trace
+     */
     public long INITIAL_RANK = -1L;
 
-    public void dispose();
+    /**
+     * The unknown event rank
+     */
+    public long UNKNOWN_RANK = -2L;
+
+    // ------------------------------------------------------------------------
+    // Getters
+    // ------------------------------------------------------------------------
 
-    public void setLocation(ITmfLocation<?> location);
+    /**
+     * @return the rank of the event referred to by the context
+     */
+    public long getRank();
+
+    /**
+     * @return the location of the event referred to by the context
+     */
+    public ITmfLocation<? extends Comparable<?>> getLocation();
+
+    /**
+     * @return indicates if the context rank is valid (!= UNKNOWN_RANK)
+     */
+    public boolean hasValidRank();
 
-    @SuppressWarnings("rawtypes")
-    public ITmfLocation<? extends Comparable> getLocation();
+    // ------------------------------------------------------------------------
+    // Operations
+    // ------------------------------------------------------------------------
 
+    /**
+     * @param location the new location
+     */
+    public void setLocation(ITmfLocation<? extends Comparable<?>> location);
+
+    /**
+     * @param rank the new rank
+     */
     public void setRank(long rank);
 
-    public long getRank();
+    /**
+     * Increment the context rank
+     */
+    public void increaseRank();
 
-    public void updateRank(int rank);
+    /**
+     * Cleanup hook
+     */
+    public void dispose();
 
-    public boolean isValidRank();
+    // ------------------------------------------------------------------------
+    // Cloneable
+    // ------------------------------------------------------------------------
 
+    /**
+     * @return a clone of the context
+     */
     public ITmfContext clone();
 
 }