org.adroitlogic.ultraesb.api.format

Interface MapMessage<K,V>

public interface MapMessage<K,V>

A message where the payload is held within a Map

e.g. JMS Map messages

Author:

asankha

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	asSerializableObject() Return payload as a Serialable object
void	clear()
boolean	containsKey(K key)
boolean	containsValue(V value)
Set<Map.Entry<K,V>>	entrySet()
V	get(K key)
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(K key)
int	size()
Collection<V>	values()
void	writeTo(OutputStream os) Serialize the payload into the given OutputStream

Method Detail

writeTo

void writeTo(OutputStream os)
             throws IOException

Serialize the payload into the given OutputStream

Parameters:

os - the OutputStream to serialize the message into

Throws:

IOException - on failure

asSerializableObject

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(K key)

Parameters:

key -

Returns:

true if the key is present within the Map

See Also:

Map

containsValue

boolean containsValue(V value)

Parameters:

value -

Returns:

true if the value is contained within the Map

See Also:

Map

get

V get(K key)

Parameters:

key -

Returns:

the Object mapped against the key

See Also:

Map

put

V put(K key,
    V value)

Parameters:

key -

value -

Returns:

put the object against the key

See Also:

Map

remove

V remove(K key)

Parameters:

key -

Returns:

remove the object mapped against the key

See Also:

Map

putAll

void putAll(Map<? extends K,? extends V> m)

Parameters:

m -

See Also:

Map

clear

void clear()

See Also:

Map

keySet

Set<K> keySet()

Returns:

key set of the Map as a Set

See Also:

Map

values

Collection<V> values()

Returns:

values of the Map as a collection

See Also:

Map

entrySet

Set<Map.Entry<K,V>> entrySet()

Returns:

the entry set of the Map

See Also:

Map