1 /*******************************************************************************
2 * Copyright (c) 2012, 2014 Ericsson
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
10 * Alexandre Montplaisir - Initial API
11 ******************************************************************************/
13 package org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
;
15 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.StateValueTypeException
;
18 * This is the interface for using state values and reading their contents.
20 * @author Alexandre Montplaisir
22 public interface ITmfStateValue
extends Comparable
<ITmfStateValue
> {
25 * The supported types of state values
28 /** Null value, for an interval not carrying any information */
30 /** 32-bit integer value */
32 /** 64-bit integer value */
34 /** IEEE 754 double precision number */
36 /** Variable-length string value */
41 * Each implementation has to define which one (among the supported types)
42 * they implement. There could be more than one implementation of each type,
43 * depending on the needs of the different users.
45 * @return The ITmfStateValue.Type enum representing the type of this value
50 * Only "null values" should return true here
52 * @return True if this type of SV is considered "null", false if it
53 * contains a real value.
58 * Read the contained value as an 'int' primitive
60 * @return The integer contained in the state value
61 * @throws StateValueTypeException
62 * If the contained value cannot be read as an integer
67 * Read the contained value as a 'long' primitive
69 * @return The long contained in the state value
70 * @throws StateValueTypeException
71 * If the contained value cannot be read as a long
76 * Read the contained value as a 'double' primitive
78 * @return The double contained in the state value
79 * @throws StateValueTypeException
80 * If the contained value cannot be read as a double
85 * Read the contained value as a String
87 * @return The String contained in the state value
88 * @throws StateValueTypeException
89 * If the contained value cannot be read as a String
This page took 0.034666 seconds and 6 git commands to generate.