com.neeve.sma
Interface MessageChannel.RawKeyResolutionTable

Enclosing interface:

MessageChannel

public static interface MessageChannel.RawKeyResolutionTable

A MessageChannel.RawKeyResolutionTable is used to build a message key from a given channel key, by providing substitution values for variable components in the key.

A MessageChannel.RawKeyResolutionTable doesn't produce garbage for inserts and removes, and contains substitution values that are XStrings which allow the key to be build without producing garbage.

Threading:

A MessageChannel.RawKeyResolutionTable is not safe for concurrent access by multiple threads.

Method Summary

boolean	containsKey(String key) Tests if the key resolution table contains the provided substitution key.
XString	get(String key) Gets a key substitution value.
XString	getProperty(String key) Gets a key substitution value.
XString	put(String key, XString value) Adds a key resolution property.
XString	remove(String key) Removes a substitution value.
XString	setProperty(String key, XString value) Adds a key resolution property.

Method Detail

put

XString put(String key,
            XString value)

Adds a key resolution property.

Parameters:

key - The key.

value - The value.

Returns:

The previous value if it exists.

setProperty

XString setProperty(String key,
                    XString value)

Adds a key resolution property.

Parameters:

key - The key.

value - The value.

Returns:

The previous value if it exists.

get

XString get(String key)

Gets a key substitution value.

Parameters:

key - The key to lookup.

Returns:

The raw substitution value.

getProperty

XString getProperty(String key)

Gets a key substitution value.

Parameters:

key - The key to lookup.

Returns:

The raw substitution value.

remove

XString remove(String key)

Removes a substitution value.

Parameters:

key - The key to remove

Returns:

The previous value or null if there is none.

containsKey

boolean containsKey(String key)

Tests if the key resolution table contains the provided substitution key.

Parameters:

key - The key to test for

Returns:

true if this table contains the substitution key.