org.fujion.common

Interface IAttributeMap<K,V>

Type Parameters:

K - The type of attribute key.

V - The type of attribute value.

public interface IAttributeMap<K,V>

Implemented by classes that support attribute maps. Implementers need only implement the getAttributes method. All other methods have default implementations.

Method Summary

Modifier and Type	Method and Description
default V	getAttribute(K key) Returns the value of the keyed attribute.
Map<K,V>	getAttributes() Returns the attribute map.
default boolean	hasAttribute(K key) Returns true if the keyed attribute exists.
default V	removeAttribute(K key) Removes the keyed attribute.
default V	setAttribute(K key, V value) Sets the value of the keyed attribute.

Method Detail

getAttributes

Map<K,V> getAttributes()

Returns the attribute map.

Returns:

The attribute map.

hasAttribute

default boolean hasAttribute(K key)

Returns true if the keyed attribute exists.

Parameters:

key - The attribute key.

Returns:

True if the keyed attribute exists.

getAttribute

default V getAttribute(K key)

Returns the value of the keyed attribute.

Parameters:

key - The attribute key.

Returns:

The value of the keyed attribute, or null if not found.

setAttribute

default V setAttribute(K key,
                       V value)

Sets the value of the keyed attribute.

Parameters:

key - The attribute key.

value - The new value.

Returns:

The previous value, or null if none.

removeAttribute

default V removeAttribute(K key)

Removes the keyed attribute.

Parameters:

key - The attribute key.

Returns:

The previous value, or null if none.