1 /*******************************************************************************
2 * Copyright (c) 2012, 2013 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
.linuxtools
.tmf
.core
.statevalue
;
15 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.StateValueTypeException
;
18 * This is the interface for using state values and reading their contents.
21 * @author Alexandre Montplaisir
23 public interface ITmfStateValue
{
26 * The supported types of state values
30 /** Null value, for an interval not carrying any information */
32 /** 32-bit integer value */
34 /** 64-bit integer value */
36 /** IEEE 754 double precision number */
38 /** Variable-length string value */
43 * Each implementation has to define which one (among the supported types)
44 * they implement. There could be more than one implementation of each type,
45 * depending on the needs of the different users.
47 * @return The ITmfStateValue.Type enum representing the type of this value
53 * Only "null values" should return true here
55 * @return True if this type of SV is considered "null", false if it
56 * contains a real value.
61 * Read the contained value as an 'int' primitive
63 * @return The integer contained in the state value
64 * @throws StateValueTypeException
65 * If the contained value cannot be read as an integer
67 int unboxInt() throws StateValueTypeException
;
70 * Read the contained value as a 'long' primitive
72 * @return The long contained in the state value
73 * @throws StateValueTypeException
74 * If the contained value cannot be read as a long
77 long unboxLong() throws StateValueTypeException
;
80 * Read the contained value as a 'double' primitive
82 * @return The double contained in the state value
83 * @throws StateValueTypeException
84 * If the contained value cannot be read as a double
86 double unboxDouble() throws StateValueTypeException
;
89 * Read the contained value as a String
91 * @return The String contained in the state value
92 * @throws StateValueTypeException
93 * If the contained value cannot be read as a String
95 String
unboxStr() throws StateValueTypeException
;
This page took 0.117753 seconds and 6 git commands to generate.