com.latencybusters.lbm
Class LBMMessageProperties

java.lang.Object
  com.latencybusters.lbm.LBMMessageProperties

All Implemented Interfaces:

java.lang.Iterable<LBMMessageProperty>

public class LBMMessageProperties
extends java.lang.Object
implements java.lang.Iterable<LBMMessageProperty>

Constructor Summary

LBMMessageProperties()
Create an LBMMessageProperties object, used to associate properties with an outgoing message

Method Summary

void	clear() Clear all properties from this object.
void	clear(java.lang.String key) Clear the property with the specified key from this object.
boolean	containsKey(java.lang.String key) Test if the specified key is contained in the properties object.
java.util.Enumeration	elements() Returns an enumeration of all LBMMessageProperty objects contained in this collection.
boolean	getBoolean(java.lang.String key) Get the property with the specified key as a boolean.
byte	getByte(java.lang.String key) Get the property with the specified key as a byte.
double	getDouble(java.lang.String key) Get the property with the specified key as a double.
float	getFloat(java.lang.String key) Get the property with the specified key as a float.
int	getInteger(java.lang.String key) Get the property with the specified key as a integer.
long	getLong(java.lang.String key) Get the property with the specified key as a long.
java.lang.Object	getObject(java.lang.String key) Get the property with the specified key as an object.
short	getShort(java.lang.String key) Get the property with the specified key as a short.
java.lang.String	getString(java.lang.String key) Get the property with the specified key as a string.
java.util.Iterator<LBMMessageProperty>	iterator() Returns an iterator over all LBMMessageProperty objects contained in this collection.
void	set(java.lang.String key, boolean value) Set a property to the provided boolean value.
void	set(java.lang.String key, byte value) Set a property to the provided byte value.
void	set(java.lang.String key, double value) Set a property to the provided double value.
void	set(java.lang.String key, float value) Set a property to the provided float value.
void	set(java.lang.String key, int value) Set a property to the provided int value.
void	set(java.lang.String key, long value) Set a property to the provided long value.
void	set(java.lang.String key, java.lang.Object value) Set a property to the provided object value.
void	set(java.lang.String key, short value) Set a property to the provided short value.
void	set(java.lang.String key, java.lang.String value) Set a property to the provided string value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMMessageProperties

public LBMMessageProperties()

Create an LBMMessageProperties object, used to associate properties with an outgoing message

Since:

UMS 5.1

Method Detail

iterator

public java.util.Iterator<LBMMessageProperty> iterator()

Returns an iterator over all LBMMessageProperty objects contained in this collection.

Specified by:

iterator in interface java.lang.Iterable<LBMMessageProperty>

Returns:

An iterator over the collection.

elements

public java.util.Enumeration elements()

Returns an enumeration of all LBMMessageProperty objects contained in this collection.

Returns:

An enumeration of the collection.

clear

public void clear()

Clear all properties from this object.

clear

public void clear(java.lang.String key)

Clear the property with the specified key from this object.

set

public void set(java.lang.String key,
                byte value)

Set a property to the provided byte value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                short value)

Set a property to the provided short value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                int value)

Set a property to the provided int value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                long value)

Set a property to the provided long value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                float value)

Set a property to the provided float value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                double value)

Set a property to the provided double value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                boolean value)

Set a property to the provided boolean value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                java.lang.String value)

Set a property to the provided string value.

Parameters:

key - The name of the property to be set

value - The value to be set

set

public void set(java.lang.String key,
                java.lang.Object value)
         throws LBMEInvalException

Set a property to the provided object value.

Parameters:

key - The name of the property to be set

value - The value to be set

Throws:

LBMEInvalException

containsKey

public boolean containsKey(java.lang.String key)

Test if the specified key is contained in the properties object.

Parameters:

key - The name of the property

Returns:

True if the property has been set, False if the property isn't set.

getBoolean

public boolean getBoolean(java.lang.String key)
                   throws LBMEInvalException,
                          java.lang.IllegalArgumentException

Get the property with the specified key as a boolean.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a boolean if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a boolean, or if the value cannot be converted to a boolean.

getByte

public byte getByte(java.lang.String key)
             throws LBMEInvalException,
                    java.lang.IllegalArgumentException

Get the property with the specified key as a byte.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a byte if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a byte, or if the value cannot be converted to a byte.

getShort

public short getShort(java.lang.String key)
               throws LBMEInvalException,
                      java.lang.IllegalArgumentException

Get the property with the specified key as a short.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a short if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a short, or if the value cannot be converted to a short.

getInteger

public int getInteger(java.lang.String key)
               throws LBMEInvalException,
                      java.lang.IllegalArgumentException

Get the property with the specified key as a integer.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a integer if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a integer, or if the value cannot be converted to a integer.

getLong

public long getLong(java.lang.String key)
             throws LBMEInvalException,
                    java.lang.IllegalArgumentException

Get the property with the specified key as a long.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a long if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a long, or if the value cannot be converted to a long.

getFloat

public float getFloat(java.lang.String key)
               throws LBMEInvalException,
                      java.lang.IllegalArgumentException

Get the property with the specified key as a float.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a float if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a float, or if the value cannot be converted to a float.

getDouble

public double getDouble(java.lang.String key)
                 throws LBMEInvalException,
                        java.lang.IllegalArgumentException

Get the property with the specified key as a double.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a double if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the value is a String, and cannot be converted to a double, or if the value cannot be converted to a double.

getString

public java.lang.String getString(java.lang.String key)
                           throws LBMEInvalException,
                                  java.lang.IllegalArgumentException

Get the property with the specified key as a string.

Parameters:

key - The name of the property

Returns:

The value of the property, converted to a string if necessary.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the property cannot be converted to a string.

getObject

public java.lang.Object getObject(java.lang.String key)
                           throws java.lang.IllegalArgumentException

Get the property with the specified key as an object.

Parameters:

key - The name of the property

Returns:

The value of the property as an object.

Throws:

java.lang.IllegalArgumentException - if the key is not set.

LBMEInvalException - if the property cannot be converted to a string.