com.latencybusters.lbm
Class LBMHFXAttributes

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

All Implemented Interfaces:

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

public class LBMHFXAttributes
extends java.util.Properties

Encapsulates the set of default LBM receiver attributes.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

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

LBMHFXAttributes(java.lang.String topicName)
Create and fill an LBMHFXAttributes object with the current default values for the given HFX topic 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 HFX 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 topicName) Fill an LBMHFXAttributes object with the default values for the given HFX topic name specified by XML configuration.
void	setObjectRecycler(LBMObjectRecyclerBase objRec, java.lang.Object objRecCbArg) Set the LBM object recycler that can be used by the context to reuse LBMMessage objects as well as LBM Context/Receiver/Source 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 HFX attributes.
void	setValue(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of HFX 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

LBMHFXAttributes

public LBMHFXAttributes()
                 throws LBMException

Create an LBMHFXAttributes object with the current default values

Throws:

LBMException

LBMHFXAttributes

public LBMHFXAttributes(java.lang.String topicName)
                 throws LBMException

Create and fill an LBMHFXAttributes object with the current default values for the given HFX topic name.

Parameters:

topicName - The topic name to be used to create the LBMHFX object.

Throws:

LBMException - if the HFX topic name is not permitted by the XML configuration.

Method Detail

setFromXml

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

Fill an LBMHFXAttributes object with the default values for the given HFX topic name specified by XML configuration.

Parameters:

topicName - The topic name to be used to create the LBMHFX object.

Throws:

LBMException - if the HFX topic name is not permitted by the XML configuration.

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 HFX 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 HFX 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 HFX 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 context to reuse LBMMessage objects as well as LBM Context/Receiver/Source 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