com.solace.messaging.util

Class SolaceSDTMap

java.lang.Object

com.solace.messaging.util.SolaceSDTMap

All Implemented Interfaces:

Serializable

@ProviderType
public class SolaceSDTMap
extends Object
implements Serializable

Adapter for JCSMP SDTMap type. SolaceSDTMap is for legacy interaction with the Solace JCSMP API's com.solacesystems.jcsmp.SDTMap

Since:

1.0

See Also:

MessageToSDTMapConverter, SolaceSDTMapToMessageConverter, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SolaceSDTMap()

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 Boolean 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.
com.solacesystems.jcsmp.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.
com.solacesystems.jcsmp.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.
com.solacesystems.jcsmp.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(com.solacesystems.jcsmp.SDTMap sdtMap) Copies the mappings from the given SDTMap and puts them in this SDTMap.
void	putBoolean(String key, Boolean aBoolean) Associates the specified case-sensitive key with the value in the map.
void	putByte(String key, Byte aByte) Associates the specified case-sensitive key with the value in the map.
void	putBytes(String key, byte[] bytes) Associates the specified case-sensitive key with the value in the map.
void	putBytes(String key, byte[] bytes, int offset, int length) Associates the specified case-sensitive key with the value in the map.
void	putCharacter(String key, Character character) Associates the specified case-sensitive key with the value in the map.
void	putDestination(String key, com.solacesystems.jcsmp.Destination destination) Associates the specified case-sensitive key with the value in the map.
void	putDouble(String key, Double aDouble) Associates the specified case-sensitive key with the value in the map.
void	putFloat(String key, Float aFloat) Associates the specified case-sensitive key with the value in the map.
void	putInteger(String key, Integer integer) Associates the specified case-sensitive key with the value in the map.
void	putLong(String key, Long aLong) Associates the specified case-sensitive key with the value in the map.
void	putMap(String key, com.solacesystems.jcsmp.SDTMap sdtMap) 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 aShort) Associates the specified case-sensitive key with the value in the map.
void	putStream(String key, com.solacesystems.jcsmp.SDTStream sdtStream) 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.
String	toString()
Collection<Object>	values() Returns a collection of all the values in the map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SolaceSDTMap

public SolaceSDTMap()

Method Detail

clear

public void clear()

Removes all mappings from the map.

Since:

1.0

containsKey

public 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.

Since:

1.0

containsValue

public 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.

Since:

1.0

get

public Object get(String key)
           throws PubSubPlusClientException

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:

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

Since:

1.0

getBoolean

public Boolean getBoolean(String key)
                   throws PubSubPlusClientException

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:

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

Since:

1.0

getByte

public Byte getByte(String key)
             throws PubSubPlusClientException

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:

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

Since:

1.0

getBytes

public byte[] getBytes(String key)
                throws PubSubPlusClientException

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:

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

Since:

1.0

getCharacter

public Character getCharacter(String key)
                       throws PubSubPlusClientException

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:

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

Since:

1.0

getDestination

public com.solacesystems.jcsmp.Destination getDestination(String key)
                                                   throws PubSubPlusClientException

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:

PubSubPlusClientException - Thrown if an internal error occurs accessing the map

Since:

1.0

getDouble

public Double getDouble(String key)
                 throws PubSubPlusClientException

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:

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

Since:

1.0

getFloat

public Float getFloat(String key)
               throws PubSubPlusClientException

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:

PubSubPlusClientException - Thrown if an internal error occurs accessing the map

Since:

1.0

getInteger

public Integer getInteger(String key)
                   throws PubSubPlusClientException

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:

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

Since:

1.0

getLong

public Long getLong(String key)
             throws PubSubPlusClientException

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:

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

Since:

1.0

getMap

public com.solacesystems.jcsmp.SDTMap getMap(String key)
                                      throws PubSubPlusClientException

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:

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

Since:

1.0

getShort

public Short getShort(String key)
               throws PubSubPlusClientException

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:

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

Since:

1.0

getStream

public com.solacesystems.jcsmp.SDTStream getStream(String key)
                                            throws PubSubPlusClientException

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:

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

Since:

1.0

getString

public String getString(String key)
                 throws PubSubPlusClientException

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:

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

Since:

1.0

isEmpty

public boolean isEmpty()

Returns true if there are no mappings.

Returns:

true, if there are no mappings.

Since:

1.0

keySet

public Set<String> keySet()

Returns a Set of all the keys in the map.

Returns:

A Set of all the keys in the map.

Since:

1.0

putAll

public void putAll(com.solacesystems.jcsmp.SDTMap sdtMap)
            throws PubSubPlusClientException

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:

sdtMap - SDTMap with the mappings to add.

Throws:

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

Since:

1.0

putBoolean

public void putBoolean(String key,
                       Boolean aBoolean)
                throws PubSubPlusClientException,
                       IllegalArgumentException

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.

aBoolean - The value to associate with the specified key.

Throws:

PubSubPlusClientException - Thrown if an internal error occurs accessing the map

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

Since:

1.0

putByte

public void putByte(String key,
                    Byte aByte)
             throws PubSubPlusClientException,
                    IllegalArgumentException

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.

aByte - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putBytes

public void putBytes(String key,
                     byte[] bytes)
              throws PubSubPlusClientException,
                     IllegalArgumentException

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.

bytes - The value to associate with the specified key.

Throws:

PubSubPlusClientException - Thrown if an internal error occurs accessing the map

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

Since:

1.0

putBytes

public void putBytes(String key,
                     byte[] bytes,
                     int offset,
                     int length)
              throws PubSubPlusClientException,
                     IllegalArgumentException

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.

bytes - The value to associate with the specified key.

offset - offset of the entry in side of the array

length - evtry length

Throws:

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

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

Since:

1.0

putCharacter

public void putCharacter(String key,
                         Character character)
                  throws PubSubPlusClientException,
                         IllegalArgumentException

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.

character - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putDestination

public void putDestination(String key,
                           com.solacesystems.jcsmp.Destination destination)
                    throws PubSubPlusClientException,
                           IllegalArgumentException

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.

destination - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putDouble

public void putDouble(String key,
                      Double aDouble)
               throws PubSubPlusClientException,
                      IllegalArgumentException

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.

aDouble - The value to associate with the specified key.

Throws:

PubSubPlusClientException - Thrown if an internal error occurs accessing the map

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

Since:

1.0

putFloat

public void putFloat(String key,
                     Float aFloat)
              throws PubSubPlusClientException,
                     IllegalArgumentException

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.

aFloat - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putInteger

public void putInteger(String key,
                       Integer integer)
                throws PubSubPlusClientException,
                       IllegalArgumentException

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.

integer - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putLong

public void putLong(String key,
                    Long aLong)
             throws PubSubPlusClientException,
                    IllegalArgumentException

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.

aLong - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putMap

public void putMap(String key,
                   com.solacesystems.jcsmp.SDTMap sdtMap)
            throws PubSubPlusClientException,
                   IllegalArgumentException

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.

sdtMap - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putObject

public void putObject(String key,
                      Object value)
               throws PubSubPlusClientException,
                      IllegalArgumentException

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:

PubSubPlusClientException - 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.

Since:

1.0

putShort

public void putShort(String key,
                     Short aShort)
              throws PubSubPlusClientException,
                     IllegalArgumentException

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.

aShort - Value to be associated with the specified key.

Throws:

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

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

Since:

1.0

putStream

public void putStream(String key,
                      com.solacesystems.jcsmp.SDTStream sdtStream)
               throws PubSubPlusClientException,
                      IllegalArgumentException

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.

sdtStream - The value to associate with the specified key.

Throws:

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

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

Since:

1.0

putString

public void putString(String key,
                      String value)
               throws PubSubPlusClientException,
                      IllegalArgumentException

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:

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

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

Since:

1.0

remove

public void remove(String key)

Removes the mapping for the specified key if present.

Parameters:

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

Since:

1.0

size

public int size()

Returns the number of mappings.

Returns:

The number of mappings.

Since:

1.0

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<Object> values()

Returns a collection of all the values in the map.

Returns:

A collection of all the values in the map.

Since:

1.0