com.solacesystems.jcsmp.impl.sdt

Class MapImpl

java.lang.Object

com.solacesystems.jcsmp.impl.sdt.MapImpl

All Implemented Interfaces:

SDTMapIF, SDTSerializable, SDTMap

public class MapImpl
extends Object
implements SDTMapIF, SDTSerializable

Constructor Summary

Constructors

Constructor and Description
MapImpl() For Writable Maps
MapImpl(int capacity) For Writable Maps
MapImpl(MapTLVBuffer buffer) For Readable Maps

Method Summary

Modifier and Type	Method and Description
ByteArray	asByteArray()
void	clear() Removes all mappings from the map.
boolean	containsKey(String key) Returns true if this map contains a mapping with the specified key.
boolean	containsValue(Object value) Returns true if this map contains one or more mappings with the specified value.
boolean	equals(Object obj)
Object	get(String key) Returns the value mapped to the specified case-sensitive key.
Boolean	getBoolean(String key) Returns the Boolean value mapped to the specified case-sensitive key.
Byte	getByte(String key) Returns the Byte value mapped to the specified case-sensitive key.
ByteArray	getByteArray(String key)
byte[]	getBytes(String key) Returns the byte[] value mapped to the specified case-sensitive key.
Character	getCharacter(String key) Returns the Character value mapped to the specified case-sensitive key.
Destination	getDestination(String key) Returns the Destination value mapped to the specified case-sensitive key.
Double	getDouble(String key) Returns the Double value mapped to the specified case-sensitive key.
Float	getFloat(String key) Returns the Float value mapped to the specified case-sensitive key.
Integer	getInteger(String key) Returns the Integer value mapped to the specified case-sensitive key.
Long	getLong(String key) Returns the Long value mapped to the specified case-sensitive key.
Map<String,Object>	getMap()
SDTMap	getMap(String key) Returns the SDTMap value mapped to the specified case-sensitive key.
RawSMFMessage	getMessage(String key) SolReserved - Returns the RawSMFMessage value mapped to the specified case-sensitive key.
Short	getShort(String key) Returns the Short value mapped to the specified case-sensitive key.
SDTStream	getStream(String key) Returns the SDTStream value mapped to the specified case-sensitive key.
String	getString(String key) Returns the String value mapped to the specified case-sensitive key.
long	getVersion()
int	hashCode()
void	invalidateChangedBuffers()
boolean	isEmpty() Returns true if there are no mappings.
Set<String>	keySet() Returns a Set of all the keys in the map.
void	putAll(SDTMap map) Copies the mappings from the given SDTMap and puts them in this SDTMap.
void	putBigInteger(String key, BigInteger value)
void	putBoolean(String key, Boolean value) Associates the specified case-sensitive key with the value in the map.
void	putByte(String key, Byte value) Associates the specified case-sensitive key with the value in the map.
void	putByteArray(String key, ByteArray value)
void	putBytes(String key, byte[] value) Associates the specified case-sensitive key with the value in the map.
void	putBytes(String key, byte[] value, int offset, int length) Associates the specified case-sensitive key with the value in the map.
void	putCharacter(String key, Character value) Associates the specified case-sensitive key with the value in the map.
void	putDestination(String key, Destination value) Associates the specified case-sensitive key with the value in the map.
void	putDouble(String key, Double value) Associates the specified case-sensitive key with the value in the map.
void	putFloat(String key, Float value) Associates the specified case-sensitive key with the value in the map.
void	putInteger(String key, Integer value) Associates the specified case-sensitive key with the value in the map.
void	putLong(String key, Long value) Associates the specified case-sensitive key with the value in the map.
void	putMap(String key, SDTMap value) Associates the specified case-sensitive key with the value in the map.
void	putMessage(String key, RawSMFMessage value) SolReserved - Associates the specified case-sensitive key with the value in the map.
void	putObject(String key, Object value) Associates the specified case-sensitive key with the value in the map.
void	putShort(String key, Short value) Associates the specified case-sensitive key with the value in the map.
void	putStream(String key, SDTStream value) Associates the specified case-sensitive key with the value in the map.
void	putString(String key, String value) Associates the specified case-sensitive key with the value in the map.
void	putUnknownType(String key, SDTUnknownType value)
void	remove(String key) Removes the mapping for the specified key if present.
void	serialize(TLVBuffer buffer)
void	setFormatter(Formatter fmter)
int	size() Returns the number of mappings.
String	toString()
static SDTMap	valueOf(Map<String,Object> map)
Collection<Object>	values() Returns a collection of all the values in the map.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapImpl

public MapImpl()

For Writable Maps

MapImpl

public MapImpl(int capacity)

For Writable Maps

MapImpl

public MapImpl(MapTLVBuffer buffer)

For Readable Maps

Parameters:

buffer - parameter

Method Detail

getVersion

public long getVersion()

setFormatter

public void setFormatter(Formatter fmter)

Specified by:

setFormatter in interface SDTMapIF

invalidateChangedBuffers

public void invalidateChangedBuffers()

serialize

public void serialize(TLVBuffer buffer)

Specified by:

serialize in interface SDTSerializable

asByteArray

public ByteArray asByteArray()

Specified by:

asByteArray in interface SDTMapIF

containsKey

public boolean containsKey(String key)

Description copied from interface: SDTMap

Returns true if this map contains a mapping with the specified key.

Specified by:

containsKey in interface SDTMap

Parameters:

key - Mapping key to search for.

Returns:

True, if this map contains a mapping with the specified key.

containsValue

public boolean containsValue(Object value)

Description copied from interface: SDTMap

Returns true if this map contains one or more mappings with the specified value.

Specified by:

containsValue in interface SDTMap

Parameters:

value - The mapping value to search for.

Returns:

True, if this map contains one or more mappings with the specified value.

remove

public void remove(String key)

Description copied from interface: SDTMap

Removes the mapping for the specified key if present.

Specified by:

remove in interface SDTMap

Parameters:

key - Case-sensitive key of the mapping to remove.

clear

public void clear()

Description copied from interface: SDTMap

Removes all mappings from the map.

Specified by:

clear in interface SDTMap

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get

public Object get(String key)
           throws SDTException

Description copied from interface: SDTMap

Returns the value mapped to the specified case-sensitive key. If null is returned, it may mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

get in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

getBoolean

public Boolean getBoolean(String key)
                   throws SDTException

Description copied from interface: SDTMap

Returns the Boolean value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getBoolean in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to Boolean is invalid.

getByte

public Byte getByte(String key)
             throws SDTException

Description copied from interface: SDTMap

Returns the Byte value mapped to the specified case-sensitive key. If null is returned, it may mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getByte in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map

SDTFormatException - If the conversion from the mapped type to Byte is invalid.

getBytes

public byte[] getBytes(String key)
                throws SDTException

Description copied from interface: SDTMap

Returns the byte[] value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getBytes in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to byte[] is invalid.

getByteArray

public ByteArray getByteArray(String key)
                       throws SDTException

Specified by:

getByteArray in interface SDTMap

Throws:

SDTException

getCharacter

public Character getCharacter(String key)
                       throws SDTException

Description copied from interface: SDTMap

Returns the Character value mapped to the specified case-sensitive key. If null is returned, it may mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getCharacter in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to Character is invalid.

getDestination

public Destination getDestination(String key)
                           throws SDTException

Description copied from interface: SDTMap

Returns the Destination value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getDestination in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map

SDTFormatException - If the conversion from the mapped type to Destination is invalid.

getDouble

public Double getDouble(String key)
                 throws SDTException

Description copied from interface: SDTMap

Returns the Double value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getDouble in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to Double is invalid.

getFloat

public Float getFloat(String key)
               throws SDTException

Description copied from interface: SDTMap

Returns the Float value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getFloat in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map

SDTFormatException - If the conversion from the mapped type to Float is invalid.

getInteger

public Integer getInteger(String key)
                   throws SDTException

Description copied from interface: SDTMap

Returns the Integer value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getInteger in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to Integer is invalid.

getLong

public Long getLong(String key)
             throws SDTException

Description copied from interface: SDTMap

Returns the Long value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getLong in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to Long is invalid.

getMap

public SDTMap getMap(String key)
              throws SDTException

Description copied from interface: SDTMap

Returns the SDTMap value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

The returned SDTMap is backed by this SDTMap, so changes to it will modify the SDTMap.

Specified by:

getMap in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to a SDTMap is invalid.

getMessage

public RawSMFMessage getMessage(String key)
                         throws SDTException

Description copied from interface: SDTMap

SolReserved - Returns the RawSMFMessage value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getMessage in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to a RawSMFMessage is invalid.

getShort

public Short getShort(String key)
               throws SDTException

Description copied from interface: SDTMap

Returns the Short value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getShort in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to Short is invalid.

getStream

public SDTStream getStream(String key)
                    throws SDTException

Description copied from interface: SDTMap

Returns the SDTStream value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

The returned SDTStream is backed by the SDTMap, so changes to it will modify the SDTMap.

Specified by:

getStream in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to a SDTStream is invalid.

getString

public String getString(String key)
                 throws SDTException

Description copied from interface: SDTMap

Returns the String value mapped to the specified case-sensitive key. If null is returned, it might mean that the specified mapping does not exist, or that the key is mapped to null. Use containsKey to distinguish the two cases.

Specified by:

getString in interface SDTMap

Parameters:

key - The case-sensitive key of the mapping value to return.

Returns:

Returns the value mapped to the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

SDTFormatException - If the conversion from the mapped type to String is invalid.

isEmpty

public boolean isEmpty()

Description copied from interface: SDTMap

Returns true if there are no mappings.

Specified by:

isEmpty in interface SDTMap

Returns:

True, if there are no mappings.

keySet

public Set<String> keySet()

Description copied from interface: SDTMap

Returns a Set of all the keys in the map.

Specified by:

keySet in interface SDTMap

Returns:

A Set of all the keys in the map.

putAll

public void putAll(SDTMap map)
            throws SDTException

Description copied from interface: SDTMap

Copies the mappings from the given SDTMap and puts them in this SDTMap. This is equivalent to calling put(String key, Object value) on all the mappings.

Specified by:

putAll in interface SDTMap

Parameters:

map - SDTMap with the mappings to add.

Throws:

SDTException - Thrown if an internal error occurs accessing the map.

putBigInteger

public void putBigInteger(String key,
                          BigInteger value)

putBoolean

public void putBoolean(String key,
                       Boolean value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putBoolean in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putByte

public void putByte(String key,
                    Byte value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putByte in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putBytes

public void putBytes(String key,
                     byte[] value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null. A reference to the byte[] argument is stored so any changes to the argument byte[] will be reflected when getting the byte[].

Specified by:

putBytes in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putBytes

public void putBytes(String key,
                     byte[] value,
                     int offset,
                     int length)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null. A reference to the byte[] argument is stored so any changes to the argument byte[] will be reflected when getting the byte[].

Specified by:

putBytes in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putByteArray

public void putByteArray(String key,
                         ByteArray value)

Specified by:

putByteArray in interface SDTMap

putCharacter

public void putCharacter(String key,
                         Character value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putCharacter in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putDestination

public void putDestination(String key,
                           Destination value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putDestination in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putDouble

public void putDouble(String key,
                      Double value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putDouble in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putFloat

public void putFloat(String key,
                     Float value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putFloat in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putInteger

public void putInteger(String key,
                       Integer value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putInteger in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putLong

public void putLong(String key,
                    Long value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putLong in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putMap

public void putMap(String key,
                   SDTMap value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already, the value is replaced. The value can be null. A reference to the SDTMap argument is stored so any changes to the argument SDTMap are reflected when getting the SDTMap.

Specified by:

putMap in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putMessage

public void putMessage(String key,
                       RawSMFMessage value)

Description copied from interface: SDTMap

SolReserved - Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null. A reference to the RawSMFMessage argument is stored so any changes to the argument RawSMFMessage will be reflected when getting the RawSMFMessage.

Specified by:

putMessage in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putUnknownType

public void putUnknownType(String key,
                           SDTUnknownType value)

putObject

public void putObject(String key,
                      Object value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already, the value is replaced. The value can be null.

Specified by:

putObject in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putShort

public void putShort(String key,
                     Short value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putShort in interface SDTMap

Parameters:

key - Case-sensitive key that the value is associated with.

value - Value to be associated with the specified key.

putStream

public void putStream(String key,
                      SDTStream value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null. A reference to the SDTStream argument is stored so any changes to the argument SDTStream will be reflected when getting the SDTStream.

Specified by:

putStream in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - The value to associate with the specified key.

putString

public void putString(String key,
                      String value)

Description copied from interface: SDTMap

Associates the specified case-sensitive key with the value in the map. If there is a mapping with this key already the value is replaced. The value can be null.

Specified by:

putString in interface SDTMap

Parameters:

key - The case-sensitive key that the value is associated with.

value - the value to associate with the specified key.

size

public int size()

Description copied from interface: SDTMap

Returns the number of mappings.

Specified by:

size in interface SDTMap

Returns:

The number of mappings.

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<Object> values()

Description copied from interface: SDTMap

Returns a collection of all the values in the map.

Specified by:

values in interface SDTMap

Returns:

A collection of all the values in the map.

getMap

public Map<String,Object> getMap()

valueOf

public static SDTMap valueOf(Map<String,Object> map)