Remove the generic location (replace by Comparable)
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / trace / ITmfTrace.java
index 79dcf55a6afc13f1e2a9f74f65242e7f76e5e57a..ec087bea23f05da4a3bf74fef847924f563fe7ee 100644 (file)
@@ -1,11 +1,11 @@
 /*******************************************************************************
  * Copyright (c) 2009, 2011, 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
  * accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
- * 
+ *
  * Contributors:
  *   Francois Chouinard - Initial API and implementation
  *   Francois Chouinard - Updated as per TMF Trace Model 1.0
@@ -32,7 +32,7 @@ import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
  * </ul>
  * Concrete ITmfTrace classes have to provide a parameter-less constructor and
  * an initialization method (<i>initTrace</i>) if they are to be opened from
- * the Project View. Also, a validation method (<i>validate</i>) has to be 
+ * the Project View. Also, a validation method (<i>validate</i>) has to be
  * provided to ensure that the trace is of the correct type.
  * <p>
  * A trace can be accessed simultaneously from multiple threads by various
@@ -92,22 +92,22 @@ import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
  *         super.handleCompleted();
  *     }
  * };
- * 
+ *
  * fTrace.handleRequest(request);
  * if (youWant) {
  *     request.waitForCompletion();
- * } 
+ * }
  * </pre>
- * 
+ *
  * @version 1.0
  * @author Francois Chouinard
- * 
+ *
  * @see ITmfContext
  * @see ITmfEvent
  * @see ITmfTraceIndexer
  * @see ITmfEventParser
  */
-public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
+public interface ITmfTrace extends ITmfDataProvider {
 
     // ------------------------------------------------------------------------
     // Constants
@@ -129,20 +129,20 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
      * <p>
      * Typically, the parameterless constructor will provide the block size
      * and its associated parser and indexer.
-     * 
+     *
      * @param resource the trace resource
      * @param path the trace path
      * @param type the trace event type
-     * @throws TmfTraceException
+     * @throws TmfTraceException If we couldn't open the trace
      */
-    public void initTrace(IResource resource, String path, Class<T> type) throws TmfTraceException;
+    public void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
 
     /**
      * Validate that the trace is of the correct type.
-     * 
+     *
      * @param project the eclipse project
      * @param path the trace path
-     * 
+     *
      * @return true if trace is valid
      */
     public boolean validate(IProject project, String path);
@@ -154,7 +154,7 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
     /**
      * @return the trace event type
      */
-    public Class<T> getEventType();
+    public Class<? extends ITmfEvent> getEventType();
 
     /**
      * @return the associated trace resource
@@ -207,15 +207,15 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
     /**
      * @return the current trace location
      */
-    public ITmfLocation<?> getCurrentLocation();
+    public ITmfLocation getCurrentLocation();
 
     /**
      * Returns the ratio (proportion) corresponding to the specified location.
-     * 
+     *
      * @param location a trace specific location
      * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
      */
-    public double getLocationRatio(ITmfLocation<?> location);
+    public double getLocationRatio(ITmfLocation location);
 
     // ------------------------------------------------------------------------
     // SeekEvent operations (returning a trace context)
@@ -233,7 +233,7 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
      * @param location the trace specific location
      * @return a context which can later be used to read the corresponding event
      */
-    public ITmfContext seekEvent(ITmfLocation<?> location);
+    public ITmfContext seekEvent(ITmfLocation location);
 
     /**
      * Position the trace at the 'rank'th event in the trace.
@@ -243,7 +243,7 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
      * <p>
      * If the requested rank is beyond the last trace event, the context
      * returned will yield a null event if used in a subsequent read.
-     * 
+     *
      * @param rank the event rank
      * @return a context which can later be used to read the corresponding event
      */
@@ -259,7 +259,7 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
      * <p>
      * If the requested timestamp is beyond the last trace event, the context
      * returned will yield a null event if used in a subsequent read.
-     * 
+     *
      * @param timestamp the timestamp of desired event
      * @return a context which can later be used to read the corresponding event
      */
@@ -272,7 +272,7 @@ public interface ITmfTrace<T extends ITmfEvent> extends ITmfDataProvider<T> {
      * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
      * voluntarily vague. Typically, it would refer to the event proportional
      * rank (arguably more intuitive) or timestamp in the trace file.
-     * 
+     *
      * @param ratio the proportional 'rank' in the trace
      * @return a context which can later be used to read the corresponding event
      */
This page took 0.026584 seconds and 5 git commands to generate.