org.adroitlogic.ultraesb.api.format
Interface MapMessage

public interface MapMessage

A message where the payload is held within a Map

e.g. JMS Map messages

Method Summary

java.io.Serializable	asSerializableObject() Return payload as a Serialable object
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set	entrySet()
java.lang.Object	get(java.lang.Object key)
boolean	isEmpty()
java.util.Set	keySet()
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map m)
java.lang.Object	remove(java.lang.Object key)
int	size()
java.util.Collection	values()
void	writeTo(java.io.OutputStream os) Serialize the payload into the given OutputStream

Method Detail

writeTo

void writeTo(java.io.OutputStream os)
             throws java.io.IOException

Serialize the payload into the given OutputStream

Parameters:

os - the OutputStream to serialize the message into

Throws:

java.io.IOException - on failure

asSerializableObject

java.io.Serializable asSerializableObject()
                                          throws FormatConversionException

Return payload as a Serialable object

Returns:

the payload as a Serializable Map

Throws:

FormatConversionException - is not thrown

size

int size()

Returns:

size of the Map

See Also:

Map

isEmpty

boolean isEmpty()

Returns:

true if empty

See Also:

Map

containsKey

boolean containsKey(java.lang.Object key)

Parameters:

key -

Returns:

true if the key is present within the Map

See Also:

Map

containsValue

boolean containsValue(java.lang.Object value)

Parameters:

value -

Returns:

true if the value is contained within the Map

See Also:

Map

get

java.lang.Object get(java.lang.Object key)

Parameters:

key -

Returns:

the Object mapped against the key

See Also:

Map

put

java.lang.Object put(java.lang.Object key,
                     java.lang.Object value)

Parameters:

key -

value -

Returns:

put the object against the key

See Also:

Map

remove

java.lang.Object remove(java.lang.Object key)

Parameters:

key -

Returns:

remove the object mapped against the key

See Also:

Map

putAll

void putAll(java.util.Map m)

Parameters:

m -

See Also:

Map

clear

void clear()

See Also:

Map

keySet

java.util.Set keySet()

Returns:

keyset of the Map as a Set

See Also:

Map

values

java.util.Collection values()

Returns:

values of the Map as a collection

See Also:

Map

entrySet

java.util.Set entrySet()

Returns:

the entry set of the Map

See Also:

Map