org.osgi.service.monitor
Class StatusVariable

java.lang.Object
org.osgi.service.monitor.StatusVariable

public final class StatusVariable

extends java.lang.Object

A StatusVariable object represents the value of a status
variable taken with a certain collection method at a certain point of time.
The type of the StatusVariable can be int,
float, boolean or String.

A StatusVariable is identified by an ID string that is unique
within the scope of a Monitorable. The ID must be a non-
null, non-empty string that conforms to the "symbolic-name"
definition in the OSGi core specification. This means that only the
characters [-_.a-zA-Z0-9] may be used. The length of the ID must not exceed
32 bytes when UTF-8 encoded.

getString

java.lang.IllegalStateException - if the type of the
StatusVariable is not String

getInteger

public int getInteger()
throws java.lang.IllegalStateException

Returns the StatusVariable value if its type is
int.

Returns:

the StatusVariable value as an int

Throws:

java.lang.IllegalStateException - if the type of this
StatusVariable is not int

getFloat

public float getFloat()
throws java.lang.IllegalStateException

Returns the StatusVariable value if its type is
float.

Returns:

the StatusVariable value as a float

Throws:

java.lang.IllegalStateException - if the type of this
StatusVariable is not float

getBoolean

public boolean getBoolean()
throws java.lang.IllegalStateException

Returns the StatusVariable value if its type is
boolean.

Returns:

the StatusVariable value as a boolean

Throws:

java.lang.IllegalStateException - if the type of this
StatusVariable is not boolean

getCollectionMethod

public int getCollectionMethod()

Returns the collection method of this StatusVariable. See
section 3.3 b) in [ETSI TS 132 403]

Returns:

one of the CM_ constants

equals

public boolean equals(java.lang.Object obj)

Compares the specified object with this StatusVariable.
Two StatusVariable objects are considered equal if their
full path, collection method and type are identical, and the data
(selected by their type) is equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare with this StatusVariable

Returns:

true if the argument represents the same
StatusVariable as this object

hashCode

public int hashCode()

Returns the hash code value for this StatusVariable. The
hash code is calculated based on the full path, collection method and
value of the StatusVariable.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this object

toString

public java.lang.String toString()

Returns a String representation of this
StatusVariable. The returned String
contains the full path, collection method, timestamp, type and value
parameters of the StatusVariable in the following format:

StatusVariable(<path>, <cm>, <timestamp>, <type>, <value>)

The collection method identifiers used in the string representation are
"CC", "DER", "GAUGE" and "SI" (without the quotes). The format of the
timestamp is defined by the Date.toString method, while the
type is identified by one of the strings "INTEGER", "FLOAT", "STRING" and
"BOOLEAN". The final field contains the string representation of the
value of the status variable.