ctf: Don't include all test traces in jar

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / statevalue / ITmfStateValue.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java
index 2f4a2058965c8dd4b01c7e491cf6a163b33a1572..6ec3a330f5ddfde3563e27bbbd28ab6819e4e021 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statevalue/ITmfStateValue.java
@@ -1,11 +1,11 @@
 /*******************************************************************************
- * Copyright (c) 2012 Ericsson
- * 
+ * Copyright (c) 2012, 2014 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:
  *   Alexandre Montplaisir - Initial API
  ******************************************************************************/
@@ -14,50 +14,85 @@ package org.eclipse.linuxtools.tmf.core.statevalue;
 
 import org.eclipse.linuxtools.tmf.core.exceptions.StateValueTypeException;
 
-
 /**
  * This is the interface for using state values and reading their contents.
- * 
- * @author alexmont
- * 
+ *
+ * @version 1.0
+ * @author Alexandre Montplaisir
  */
 public interface ITmfStateValue {
 
-    public static final byte TYPE_NULL = -1;
-    public static final byte TYPE_INTEGER = 0;
-    public static final byte TYPE_STRING = 1;
+    /**
+     * The supported types of state values
+     * @since 2.0
+     */
+    public enum Type {
+        /** Null value, for an interval not carrying any information */
+        NULL,
+        /** 32-bit integer value */
+        INTEGER,
+        /** 64-bit integer value */
+        LONG,
+        /** IEEE 754 double precision number
+         * @since 3.0*/
+        DOUBLE,
+        /** Variable-length string value */
+        STRING,
+    }
 
     /**
-     * Each implementation has to supply a "type" number. This will get written
-     * as-is in the History file to recognize the type, so it needs to be unique
-     * 
-     * @return The unique "int8" assigned to this state value type
+     * Each implementation has to define which one (among the supported types)
+     * they implement. There could be more than one implementation of each type,
+     * depending on the needs of the different users.
+     *
+     * @return The ITmfStateValue.Type enum representing the type of this value
+     * @since 2.0
      */
-    public byte getType();
+    Type getType();
 
     /**
      * Only "null values" should return true here
-     * 
+     *
      * @return True if this type of SV is considered "null", false if it
      *         contains a real value.
      */
-    public boolean isNull();
+    boolean isNull();
 
     /**
      * Read the contained value as an 'int' primitive
-     * 
+     *
      * @return The integer contained in the state value
      * @throws StateValueTypeException
      *             If the contained value cannot be read as an integer
      */
-    public int unboxInt() throws StateValueTypeException;
+    int unboxInt();
+
+    /**
+     * Read the contained value as a 'long' primitive
+     *
+     * @return The long contained in the state value
+     * @throws StateValueTypeException
+     *             If the contained value cannot be read as a long
+     * @since 2.0
+     */
+    long unboxLong();
+
+    /**
+     * Read the contained value as a 'double' primitive
+     *
+     * @return The double contained in the state value
+     * @throws StateValueTypeException
+     *             If the contained value cannot be read as a double
+     * @since 3.0
+     */
+    double unboxDouble();
 
     /**
      * Read the contained value as a String
-     * 
+     *
      * @return The String contained in the state value
      * @throws StateValueTypeException
      *             If the contained value cannot be read as a String
      */
-    public String unboxStr() throws StateValueTypeException;
+    String unboxStr();
 }