Package me.datafox.dfxengine.handles

Class TreeHandleMap<T>

java.lang.Object

java.util.AbstractMap<Handle,T>

java.util.TreeMap<Handle,T>

me.datafox.dfxengine.handles.TreeHandleMap<T>

Type Parameters:

T - the type of mapped values

All Implemented Interfaces:

Serializable, Cloneable, Map<Handle,T>, NavigableMap<Handle,T>, SequencedMap<Handle,T>, SortedMap<Handle,T>, HandleMap<T>

public class TreeHandleMap<T>
extends TreeMap<Handle,T>
implements HandleMap<T>

An ordered implementation of HandleMap backed with a TreeMap.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
TreeHandleMap(Space space)	Uses LoggerFactory.getLogger(Class) with TreeHandleMap.class.
TreeHandleMap(Space space, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object key)	Returns true if this map contains a mapping for the specified key.
boolean	containsKeys(Collection<?> keys)	Returns true if this map contains a mapping for all the specified keys.
T	get(Object key)	Returns the value to which the specified key is mapped, or null if none is present.
Collection<T>	getByTag(Object tag)	Returns all values mapped to keys containing the specified tag.
Collection<T>	getByTags(Collection<?> tags)	Returns all values mapped to keys containing the specified tag.
T	getOrDefault(Object key, T defaultValue)	Returns true if this map contains a mapping for the specified key, or the specified default value if none is present.
T	put(Handle key, T value)	Associates the specified value with the specified key in this map.
void	putAll(Map<? extends Handle,? extends T> map)	Copies all of the mappings from the specified map to this map.
T	putHandled(T value)	Associates a Handled value with its associated Handle.
T	putIfAbsent(Handle key, T value)	Associates the specified key with the specified value and returns null if the specified key is not already associated with a value, otherwise returns the current value.
T	remove(Object key)	Removes the mapping for a key from this map if it is present.
boolean	remove(Object key, Object value)	Removes the entry for the specified key only if it is currently mapped to the specified value.
HandleMap<T>	unmodifiable()	Returns an unmodifiable version of this map.

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, compute, computeIfAbsent, computeIfPresent, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, merge, navigableKeySet, pollFirstEntry, pollLastEntry, putFirst, putLast, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface me.datafox.dfxengine.handles.api.HandleMap

getSpace

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, hashCode, isEmpty, merge, replace, replace, replaceAll, size

Methods inherited from interface java.util.NavigableMap

reversed

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Constructor Details

TreeHandleMap

public TreeHandleMap(Space space,
 org.slf4j.Logger logger)

Parameters:

space - Space to be associated with this map

logger - Logger for this map

TreeHandleMap

public TreeHandleMap(Space space)

Uses LoggerFactory.getLogger(Class) with TreeHandleMap.class.

Parameters:

space - Space to be associated with this map

Method Details

containsKeys

public boolean containsKeys(Collection<?> keys)

Returns true if this map contains a mapping for all the specified keys. The keys may either be Handles or their String ids.

Specified by:

containsKeys in interface HandleMap<T>

Parameters:

keys - Handle keys or their String ids whose presence in this map is to be tested

Returns:

true if this map contains a mapping for all the specified keys

Throws:

ClassCastException - if any of the keys are of an inappropriate type for this map

NullPointerException - if any of the keys is null

putHandled

public T putHandled(T value)

Associates a Handled value with its associated Handle. If the map previously contained a mapping for the key, the old value is replaced by the specified value. The Handle key must be present in this map's associated Space.

Specified by:

putHandled in interface HandleMap<T>

Parameters:

value - Handled value to be associated with its associated Handle key

Returns:

the previous value associated with the key, or null if none was present

Throws:

UnsupportedOperationException - if the put operation is not supported by this map

ClassCastException - if the value does not implement Handled

NullPointerException - if the specified value is null

IllegalArgumentException - if the value's associated Handle is not present in this map's associated Space

unmodifiable

public HandleMap<T> unmodifiable()

Returns an unmodifiable version of this map. All changes made to the original map will be reflected in the returned one.

Specified by:

unmodifiable in interface HandleMap<T>

Returns:

unmodifiable version of this map

getByTag

public Collection<T> getByTag(Object tag)

Returns all values mapped to keys containing the specified tag. The tag may be a Handle or its String id.

Specified by:

getByTag in interface HandleMap<T>

Parameters:

tag - tag Handle or its String id

Returns:

all values mapped to keys containing the specified tag

Throws:

ClassCastException - if the tag is not a Handle or a String

NullPointerException - if the tag is null

IllegalArgumentException - if the Handle is not a tag

getByTags

public Collection<T> getByTags(Collection<?> tags)

Returns all values mapped to keys containing the specified tag. The tags may be Handles or their String ids.

Specified by:

getByTags in interface HandleMap<T>

Parameters:

tags - tag Handles or their String ids

Returns:

all values mapped to keys containing the specified tags

Throws:

ClassCastException - if any of the tags are not Handles or a Strings

NullPointerException - if any of the tags is null

IllegalArgumentException - if any of the Handles is not a tag

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key. The key may either be a Handle or its String id.

Specified by:

containsKey in interface HandleMap<T>

Specified by:

containsKey in interface Map<Handle,T>

Overrides:

containsKey in class TreeMap<Handle,T>

Parameters:

key - Handle key or its String id whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

Throws:

ClassCastException - if the key is of an inappropriate type for this map

NullPointerException - if the specified key is null

get

public T get(Object key)

Returns the value to which the specified key is mapped, or null if none is present. The key may either be a Handle or its String id.

Specified by:

get in interface HandleMap<T>

Specified by:

get in interface Map<Handle,T>

Overrides:

get in class TreeMap<Handle,T>

Parameters:

key - Handle key or its String id whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if none is present

Throws:

ClassCastException - if the key is of not a Handle or a String

NullPointerException - if the specified key is null

put

public T put(Handle key,
 T value)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value. The Handle key must be present in this map's associated Space.

Specified by:

put in interface HandleMap<T>

Specified by:

put in interface Map<Handle,T>

Overrides:

put in class TreeMap<Handle,T>

Parameters:

key - Handle key with which the specified value is to be associated with

value - value to be associated with the specified key

Returns:

the previous value associated with the key, or null if none was present

Throws:

UnsupportedOperationException - if the put operation is not supported by this map

NullPointerException - if the specified key or value is null

IllegalArgumentException - if the Handle key is not present in this map's associated Space

remove

public T remove(Object key)

Removes the mapping for a key from this map if it is present. Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key. The key may either be a Handle or its String id.

Specified by:

remove in interface HandleMap<T>

Specified by:

remove in interface Map<Handle,T>

Overrides:

remove in class TreeMap<Handle,T>

Parameters:

key - Handle key or its String id whose mapping is to be removed from this map

Returns:

the previous value associated with key, or null if none was present

Throws:

UnsupportedOperationException - if the remove operation is not supported by this map

ClassCastException - if the key is of not a Handle or a String

NullPointerException - if the specified key is null

putAll

public void putAll(Map<? extends Handle,? extends T> map)

Copies all of the mappings from the specified map to this map. The effect of this call is equivalent to that of calling put(Handle, Object) on this map once for each mapping from key to value in the specified map. All Handle keys must be present in this map's associated Space.

Specified by:

putAll in interface HandleMap<T>

Specified by:

putAll in interface Map<Handle,T>

Overrides:

putAll in class TreeMap<Handle,T>

Parameters:

map - mappings to be stored in this map

Throws:

UnsupportedOperationException - if the putAll operation is not supported by this map

NullPointerException - if the specified map is null or contains null keys or values

IllegalArgumentException - if the specified map contains a Handle key that is not present in this map's associated Space

getOrDefault

public T getOrDefault(Object key,
 T defaultValue)

Returns true if this map contains a mapping for the specified key, or the specified default value if none is present. The key may either be a Handle or its String id.

Specified by:

getOrDefault in interface HandleMap<T>

Specified by:

getOrDefault in interface Map<Handle,T>

Parameters:

key - Handle key or its String id whose associated value is to be returned

defaultValue - the default mapping of the key

Returns:

the value to which the specified key is mapped, or the specified default value if this map contains no mapping for the key

Throws:

ClassCastException - if the key is of not a Handle or a String

NullPointerException - if the specified key is null

putIfAbsent

public T putIfAbsent(Handle key,
 T value)

Associates the specified key with the specified value and returns null if the specified key is not already associated with a value, otherwise returns the current value.

Specified by:

putIfAbsent in interface HandleMap<T>

Specified by:

putIfAbsent in interface Map<Handle,T>

Overrides:

putIfAbsent in class TreeMap<Handle,T>

Parameters:

key - Handle key with which the specified value is to be associated with

value - value to be associated with the specified key

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key

Throws:

UnsupportedOperationException - if the put operation is not supported by this map

NullPointerException - if the specified key or value is null

IllegalArgumentException - if the Handle key is not present in this map's associated Space

remove

public boolean remove(Object key,
 Object value)

Removes the entry for the specified key only if it is currently mapped to the specified value. The key may either be a Handle or its String id.

Specified by:

remove in interface HandleMap<T>

Specified by:

remove in interface Map<Handle,T>

Parameters:

key - Handle key or its String id with which the specified value is associated

value - value expected to be associated with the specified key

Returns:

true if the value was removed

Throws:

UnsupportedOperationException - if the remove operation is not supported by this map

ClassCastException - if the key is of not a Handle or a String

NullPointerException - if the specified key or value is null