com.solacesystems.jcsmp

Interface SDTMap

public interface SDTMap

Map Structured Data Type (SDT) that maps case-sensitive Strings to a supported data type. The list of supported data types are:

• Boolean,
• Byte,
• byte[],
• Character,
• Destination,
• Double,
• Float,
• Integer,
• Long,
• SDTMap,
• Short,
• SDTStream,
• String.

For values written as the row type, they can be read as the column type according to the following table.

 |        | boolean byte byte[] char dest double float int long Map  short Stream String 
 |--------------------------------------------------------------------------------------
 |boolean |    X                                                                    X
 |byte    |          X                                  X   X          X            X
 |byte[]  |                X
 |char    |                      X                                                  X
 |dest    |                           X
 |double  |                                 X                                       X
 |float   |                                 X      X                                X
 |int     |          X                                  X   X          X            X
 |long    |          X                                  X   X          X            X
 |Map     |                                                      X
 |SMFMsg  |                                                          
 |short   |          X                                  X   X          X            X
 |Stream  |                                                                  X
 |String  |    X     X                      X      X    X   X          X            X 
 |--------------------------------------------------------------------------------------
 

A SDTMap may not contain itself as a value.

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
SDTMap	getMap(String key) Returns the SDTMap 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.
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	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	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	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	remove(String key) Removes the mapping for the specified key if present.
int	size() Returns the number of mappings.
Collection<Object>	values() Returns a collection of all the values in the map.

Method Detail

clear

void clear()

Removes all mappings from the map.

containsKey

boolean containsKey(String key)

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

Parameters:

key - Mapping key to search for.

Returns:

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

containsValue

boolean containsValue(Object value)

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

Parameters:

value - The mapping value to search for.

Returns:

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

remove

void remove(String key)

Removes the mapping for the specified key if present.

Parameters:

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

get

Object get(String key)
    throws SDTException

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.

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

Boolean getBoolean(String key)
            throws SDTException

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.

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

Byte getByte(String key)
      throws SDTException

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.

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

byte[] getBytes(String key)
         throws SDTException

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.

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.

getCharacter

Character getCharacter(String key)
                throws SDTException

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.

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

Destination getDestination(String key)
                    throws SDTException

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.

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

Double getDouble(String key)
          throws SDTException

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.

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

Float getFloat(String key)
        throws SDTException

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.

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

Integer getInteger(String key)
            throws SDTException

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.

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

Long getLong(String key)
      throws SDTException

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.

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

SDTMap getMap(String key)
       throws SDTException

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.

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.

getShort

Short getShort(String key)
        throws SDTException

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.

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

SDTStream getStream(String key)
             throws SDTException

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.

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

String getString(String key)
          throws SDTException

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.

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

boolean isEmpty()

Returns true if there are no mappings.

Returns:

True, if there are no mappings.

keySet

Set<String> keySet()

Returns a Set of all the keys in the map.

Returns:

A Set of all the keys in the map.

size

int size()

Returns the number of mappings.

Returns:

The number of mappings.

values

Collection<Object> values()

Returns a collection of all the values in the map.

Returns:

A collection of all the values in the map.

putBoolean

void putBoolean(String key,
                Boolean value)
         throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map

IllegalArgumentException - if the key is null or an empty string.

putByte

void putByte(String key,
             Byte value)
      throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putBytes

void putBytes(String key,
              byte[] value)
       throws SDTException

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[].

Parameters:

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

value - The value to associate with the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map

IllegalArgumentException - if the key is null or an empty string.

putBytes

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

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[].

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putCharacter

void putCharacter(String key,
                  Character value)
           throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putDestination

void putDestination(String key,
                    Destination value)
             throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putDouble

void putDouble(String key,
               Double value)
        throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

SDTException - Thrown if an internal error occurs accessing the map

IllegalArgumentException - if the key is null or an empty string.

putFloat

void putFloat(String key,
              Float value)
       throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putInteger

void putInteger(String key,
                Integer value)
         throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putLong

void putLong(String key,
             Long value)
      throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putMap

void putMap(String key,
            SDTMap value)
     throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putShort

void putShort(String key,
              Short value)
       throws SDTException

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.

Parameters:

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

value - Value to be associated with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putStream

void putStream(String key,
               SDTStream value)
        throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putString

void putString(String key,
               String value)
        throws SDTException

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.

Parameters:

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

value - the value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string.

putObject

void putObject(String key,
               Object value)
        throws SDTException

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.

Parameters:

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

value - The value to associate with the specified key.

Throws:

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

IllegalArgumentException - if the key is null or an empty string; or if the value is an unsupported type.

putAll

void putAll(SDTMap map)
     throws SDTException

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.

Parameters:

map - SDTMap with the mappings to add.

Throws:

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