org.jscsi.parser.datasegment

Class SettingsMap

java.lang.Object

org.jscsi.parser.datasegment.SettingsMap

public final class SettingsMap
extends Object

SettingsMap

This class stores all text parameters and allows an easy access to these.

Author:

Volker Wildi

Constructor Summary

Constructors

Constructor and Description
SettingsMap() Default constructor to create a new, empty SettingsMap object.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(OperationalTextKey textKey, String textValue) Adds a parameter to this SettingsMap.
ByteBuffer	asByteBuffer() Returns a buffer of the serialized key-value pairs, which are contained in this instance.
void	clear() Removes all stored settings from this SettingsMap.
Set<Map.Entry<OperationalTextKey,String>>	entrySet() Returns a set of an key-value pair of this OperationTextKeys object.
boolean	equals(Map<OperationalTextKey,String> aMap) This method compares the text parameters of this object with the ones given by a Map object.
boolean	equals(SettingsMap aSettingsMap) This method compares the text parameters of this object with the ones given by a Map object.
String	get(OperationalTextKey textKey) Returns the value of the given parameter, which is not parsed.
int	hashCode()
String	remove(OperationalTextKey textKey) Removes the given parameter from this SettingsMap.
int	size()
String	toString()
void	update(OperationalTextKey textKey, String newTextValue, IResultFunction resultFunction) Update the stored value with the given one.

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingsMap

public SettingsMap()

Default constructor to create a new, empty SettingsMap object.

Method Detail

add

public final void add(OperationalTextKey textKey,
       String textValue)

Adds a parameter to this SettingsMap.

Parameters:

textKey - The name of the parameter to add.

textValue - The value of the parameter to add.

get

public final String get(OperationalTextKey textKey)

Returns the value of the given parameter, which is not parsed.

Parameters:

textKey - The name of the parameter.

Returns:

The value of this parameter.

remove

public final String remove(OperationalTextKey textKey)

Removes the given parameter from this SettingsMap.

Parameters:

textKey - The name of the parameter.

Returns:

The value of the removed parameter.

update

public final void update(OperationalTextKey textKey,
          String newTextValue,
          IResultFunction resultFunction)

Update the stored value with the given one. The result is dependant on the IResultFunction instance.

Parameters:

textKey - The OperationalTextKey to update.

newTextValue - The new value, which is interpreted as response.

resultFunction - The IResultFunction to use to obtaining the result.

equals

public final boolean equals(SettingsMap aSettingsMap)

This method compares the text parameters of this object with the ones given by a Map object.

Parameters:

aSettingsMap - A SettingsMap object, which should be used for the comparsion.

Returns:

true, if the all keys are equal with the ones of the aSettingsMap object. Else false.

equals

public final boolean equals(Map<OperationalTextKey,String> aMap)

This method compares the text parameters of this object with the ones given by a Map object.

Parameters:

aMap - A Map<String, String> object, which should be used for the comparsion.

Returns:

true, if the all keys are equal with the ones of the aMap object. Else false.

entrySet

public final Set<Map.Entry<OperationalTextKey,String>> entrySet()

Returns a set of an key-value pair of this OperationTextKeys object.

Returns:

a set view of the mappings (key-value-pair) contained in this map.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

clear

public final void clear()

Removes all stored settings from this SettingsMap.

asByteBuffer

public final ByteBuffer asByteBuffer()

Returns a buffer of the serialized key-value pairs, which are contained in this instance.

Returns:

The serialized key-value pairs.

size

public int size()