com.latencybusters.lbm
Class LBMEventQueueAttributes

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<java.lang.Object,java.lang.Object>
          java.util.Properties
              com.latencybusters.lbm.LBMEventQueueAttributes

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class LBMEventQueueAttributes
extends java.util.Properties

Encapsulates the set of default LBM event queue attributes.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

LBMEventQueueAttributes()
Create an LBMEventQueueAttributes object with the current default values

LBMEventQueueAttributes(java.lang.String eventQueueName)
Create and fill an LBMEventQueueAttributes object with the current default values for the given event queue name.

Method Summary

void	dispose() Free memory associated with this set of attributes.
LBMConfigOption[]	dumpAttributeList() Returns an array of LBMConfigOptions.
protected void	finalize()
java.lang.String	getValue(java.lang.String attributeName) Returns the current value of an attribute from this set of event queue attributes.
void	load(java.io.InputStream inStream) Reads a property (attribute) list (key and element pairs) from the input stream.
void	setFromXml(java.lang.String eventQueueName) Fill an LBMEventQueueAttributes object with the default values for the given event queue name specified by the XML configuration.
void	setObjectRecycler(LBMObjectRecyclerBase objRec, java.lang.Object objRecCbArg) Set the LBM object recycler that can be used by the event queue to reuse statistics objects.
java.lang.Object	setProperty(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of event queue attributes.
void	setValue(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of event queue attributes.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LBMEventQueueAttributes

public LBMEventQueueAttributes(java.lang.String eventQueueName)
                        throws LBMException

Create and fill an LBMEventQueueAttributes object with the current default values for the given event queue name.

Parameters:

eventQueueName - Event queue name string. Is written into the attributes object.

Throws:

LBMException - if the eventQueueName is not permitted by the configuration or other operational failure.

LBMEventQueueAttributes

public LBMEventQueueAttributes()
                        throws LBMException

Create an LBMEventQueueAttributes object with the current default values

Throws:

LBMException - for operational failure.

Method Detail

setFromXml

public void setFromXml(java.lang.String eventQueueName)
                throws LBMException

Fill an LBMEventQueueAttributes object with the default values for the given event queue name specified by the XML configuration.

Parameters:

eventQueueName - Event queue name string. Is written into the attributes object.

Throws:

LBMException - if the eventQueueName is not permitted by the configuration or other operational failure.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

dispose

public void dispose()

Free memory associated with this set of attributes.

dumpAttributeList

public LBMConfigOption[] dumpAttributeList()

Returns an array of LBMConfigOptions.

Returns:

Array of LBMConfigOption

getValue

public java.lang.String getValue(java.lang.String attributeName)
                          throws LBMException

Returns the current value of an attribute from this set of event queue attributes.

Parameters:

attributeName - Name of the attribute to retrieve

Returns:

Value corresponding to the specified attribute name

Throws:

LBMException - if attributeName is not a valid attribute.

setValue

public void setValue(java.lang.String attributeName,
                     java.lang.String attributeValue)
              throws LBMException

Set the current value of an attribute in this set of event queue attributes. Note that this method bypasses the property list. As such no attributes configured using this method will appear in the property list.

Parameters:

attributeName - Name of the attribute to set

attributeValue - New attribute value

Throws:

LBMException - if attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

See Also:

setProperty(java.lang.String, java.lang.String)

setProperty

public java.lang.Object setProperty(java.lang.String attributeName,
                                    java.lang.String attributeValue)

Set the current value of an attribute in this set of event queue attributes.

Overrides:

setProperty in class java.util.Properties

Parameters:

attributeName - Name of the attribute to set

attributeValue - New attribute value

Throws:

LBMRuntimeException - if attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

load

public void load(java.io.InputStream inStream)
          throws java.io.IOException

Reads a property (attribute) list (key and element pairs) from the input stream.

Overrides:

load in class java.util.Properties

Parameters:

inStream - Input stream of bytes

Throws:

java.io.IOException - if any I/O error occurs.

LBMRuntimeException - if any invalid attribute is detected in inStream.

setObjectRecycler

public void setObjectRecycler(LBMObjectRecyclerBase objRec,
                              java.lang.Object objRecCbArg)

Set the LBM object recycler that can be used by the event queue to reuse statistics objects.

Parameters:

objRec - an LBM object recycler that will be called when objects need to be retrieved

objRecCbArg - a callback object token that will be passed in the retrieve method