com.latencybusters.lbm
Class LBMMessageProperty

java.lang.Object
  com.latencybusters.lbm.LBMMessageProperty

public class LBMMessageProperty
extends java.lang.Object

Method Summary

boolean	getBoolean() Retrieve the value stored in this object as a boolean.
byte	getByte() Retrieve the value stored in this object as a byte.
double	getDouble() Retrieve the value stored in this object as a double.
float	getFloat() Retrieve the value stored in this object as a float.
int	getInteger() Retrieve the value stored in this object as a integer.
long	getLong() Retrieve the value stored in this object as a long.
java.lang.Object	getObject() Retrieve the value stored in this object as an Object.
short	getShort() Retrieve the value stored in this object as a short.
java.lang.String	getString() Retrieve the value stored in this object as a string.
java.lang.String	key() Retrieve the name of the property represented by this object.
int	type() Retrieve the type of the property represented by this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

key

public java.lang.String key()

Retrieve the name of the property represented by this object.

type

public int type()

Retrieve the type of the property represented by this object.

getBoolean

public boolean getBoolean()
                   throws LBMEInvalException

Retrieve the value stored in this object as a boolean. Only properties of type LBM.MSG_PROPERTY_BOOLEAN and LBM.MSG_PROPERTY_STRING can be retrieved as a boolean.

Throws:

LBMEInvalException

getByte

public byte getByte()
             throws LBMEInvalException

Retrieve the value stored in this object as a byte. Only properties of type LBM.MSG_PROPERTY_BYTE and LBM.MSG_PROPERTY_STRING can be retrieved as a byte.

Returns:

The stored value, converted to a java.lang.Byte.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.Byte, or if the stored value is a string and does not contain the string representation of a java.lang.Byte.

getShort

public short getShort()
               throws LBMEInvalException

Retrieve the value stored in this object as a short. Only properties of type LBM.MSG_PROPERTY_BYTE, LBM.MSG_PROPERTY_SHORT, and LBM.MSG_PROPERTY_STRING can be retrieved as a short.

Returns:

The stored value, converted to a java.lang.Short.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.Short, or if the stored value is a string and does not contain the string representation of a java.lang.Short.

getInteger

public int getInteger()
               throws LBMEInvalException

Retrieve the value stored in this object as a integer. Only properties of type LBM.MSG_PROPERTY_BYTE, LBM.MSG_PROPERTY_SHORT, LBM.MSG_PROPERTY_INT, and LBM.MSG_PROPERTY_STRING can be retrieved as a integer.

Returns:

The stored value, converted to a java.lang.Integer.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.Integer. or if the stored value is a string and does not contain the string representation of a java.lang.Integer.

getLong

public long getLong()
             throws LBMEInvalException

Retrieve the value stored in this object as a long. Only properties of type LBM.MSG_PROPERTY_BYTE, LBM.MSG_PROPERTY_SHORT, LBM.MSG_PROPERTY_INT, LBM.MSG_PROPERTY_LONG and LBM.MSG_PROPERTY_STRING can be retrieved as a long.

Returns:

The stored value, converted to a java.lang.Long.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.Long, or if the stored value is a string and does not contain the string representation of a java.lang.Long.

getFloat

public float getFloat()
               throws LBMEInvalException

Retrieve the value stored in this object as a float. Only properties of type LBM.MSG_PROPERTY_FLOAT and LBM.MSG_PROPERTY_STRING can be retrieved as a float.

Returns:

The stored value, converted to a java.lang.Float.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.Float, or if the stored value is a string and does not contain the string representation of a java.lang.Float.

getDouble

public double getDouble()
                 throws LBMEInvalException,
                        java.lang.NumberFormatException

Retrieve the value stored in this object as a double. Only properties of type LBM.MSG_PROPERTY_FLOAT, LBM.MSG_PROPERTY_DOUBLE and LBM.MSG_PROPERTY_STRING can be retrieved as a double.

Returns:

The stored value, converted to a java.lang.Double.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.Double, or if the stored value is a string and does not contain the string representation of a java.lang.Double.

java.lang.NumberFormatException

getString

public java.lang.String getString()
                           throws LBMEInvalException

Retrieve the value stored in this object as a string. Any type may be retrieved as a string.

Returns:

The stored value, converted to a java.lang.String.

Throws:

LBMEInvalException - if the stored value is of a type that cannot be converted to a java.lang.String.

getObject

public java.lang.Object getObject()

Retrieve the value stored in this object as an Object. Any type may be retrieved as a Object.

Returns:

The stored value, converted to a java.lang.Object.