Package me.datafox.dfxengine.values

Class DelegatedValueMap

java.lang.Object

me.datafox.dfxengine.values.DelegatedValueMap

All Implemented Interfaces:

Map<Handle,Value>, HandleMap<Value>, ValueMap

public class DelegatedValueMap
extends Object
implements ValueMap

An implementation of ValueMap that can be backed with any implementation of HandleMap. Includes a DelegatedValueMap.Builder for easy instantiation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DelegatedValueMap.Builder	A builder for ValueMap.
class	DelegatedValueMap.NumeralMap	A view to a ValueMap with the Numeral representations of the Values.

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
DelegatedValueMap(HandleMap<Value> map, boolean immutable, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method	Description
boolean	addModifier(Modifier modifier)	Modifiers added to this map will be added to all Values of this map, including ones that are added to this map after this operation.
boolean	addModifiers(Collection<? extends Modifier> modifiers)	Modifiers added to this map will be added to all Values of this map, including ones that are added to this map after this operation.
void	apply(DualParameterOperation operation, MapMathContext context, Collection<? extends Handle> handles, Numeral parameter1, Numeral parameter2)	Handles that are not a part of this map's associated Space are ignored.
void	apply(DualParameterOperation operation, MathContext context, Numeral parameter1, Numeral parameter2)
void	apply(Operation operation, MapMathContext context, Collection<? extends Handle> handles, Numeral... parameters)	Handles that are not a part of this map's associated Space are ignored.
void	apply(Operation operation, MapMathContext context, Map<? extends Handle,Numeral[]> parameters)	Handles that are not a part of this map's associated Space are ignored.
void	apply(Operation operation, MathContext context, Numeral... parameters)
void	apply(SingleParameterOperation operation, MapMathContext context, Collection<? extends Handle> handles, Numeral parameter)	Handles that are not a part of this map's associated Space are ignored.
void	apply(SingleParameterOperation operation, MapMathContext context, Map<? extends Handle,Numeral> parameters)	Handles that are not a part of this map's associated Space are ignored.
void	apply(SingleParameterOperation operation, MathContext context, Numeral parameter)
void	apply(SourceOperation operation, MapMathContext context, Collection<? extends Handle> handles)	Handles that are not a part of this map's associated Space are ignored.
void	apply(SourceOperation operation, MathContext context)
static DelegatedValueMap.Builder	builder(Space space)
void	clear()	Removes all of the Values from this map.
boolean	compare(Comparison comparison, ComparisonContext context, Numeral other)
boolean	compare(Comparison comparison, MapComparisonContext context, Collection<? extends Handle> handles, Numeral other)
boolean	compare(Comparison comparison, MapComparisonContext context, Map<? extends Handle,Numeral> others)
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.
boolean	containsModifier(Modifier modifier)
boolean	containsModifiers(Collection<? extends Modifier> modifiers)
boolean	containsValue(Object value)
void	convert(Collection<? extends Handle> handles, NumeralType type)	Handles that are not a part of this map's associated Space are ignored.
void	convert(Map<? extends Handle,NumeralType> types)	Handles that are not a part of this map's associated Space are ignored.
void	convert(NumeralType type)
void	convertAllowed(NumeralType type)	Only converts Values of this map that can be converted to the specified type.
Set<Map.Entry<Handle,Value>>	entrySet()
Value	get(Object key)	Returns the value to which the specified key is mapped, or null if none is present.
Map<Handle,Numeral>	getBaseNumeralMap()
Collection<Value>	getByTag(Object tag)	Returns all values mapped to keys containing the specified tag.
Collection<Value>	getByTags(Collection<?> tags)	Returns all values mapped to keys containing the specified tag.
Collection<Modifier>	getModifiers()
Value	getOrDefault(Object key, Value defaultValue)	Returns true if this map contains a mapping for the specified key, or the specified default value if none is present.
Space	getSpace()	Returns the Space associated with this map.
Map<Handle,Numeral>	getValueNumeralMap()
boolean	isEmpty()
boolean	isImmutable()
Set<Handle>	keySet()
Value	put(Handle key, Value value)	This method ignores the key parameter, it is recommended to use putHandled(Value) instead.
void	putAll(Map<? extends Handle,? extends Value> m)	Copies all of the mappings from the specified map to this map.
Value	putHandled(Value value)	Associates a Value in this map.
Value	putIfAbsent(Handle key, Value 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.
Value	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.
boolean	removeModifier(Modifier modifier)
boolean	removeModifiers(Collection<? extends Modifier> modifiers)
void	set(Numeral value)
void	set(MapMathContext context, Collection<? extends Handle> handles, Numeral value)	Handles that are not a part of this map's associated Space are ignored.
void	set(MapMathContext context, Map<? extends Handle,Numeral> values)	Handles that are not a part of this map's associated Space are ignored.
int	size()
void	toDecimal()	Converts all Values to the smallest decimal type that can hold its represented value.
void	toInteger()	Converts all Values to the smallest integer type that can hold its represented value.
void	toSmallestType()	Converts all Values to the smallest type that can hold its represented value.
void	toSmallestType(Collection<? extends Handle> handles)	Converts specified Values to the smallest type that can hold its represented value.
String	toString()
HandleMap<Value>	unmodifiable()	Returns an unmodifiable version of this map.
Collection<Value>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, hashCode, merge, replace, replace, replaceAll

Methods inherited from interface me.datafox.dfxengine.values.api.ValueMap

apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, compare, compare, compare, set, set

Constructor Details

DelegatedValueMap

public DelegatedValueMap(HandleMap<Value> map,
 boolean immutable,
 org.slf4j.Logger logger)

Parameters:

map - HandleMap to back this map with

immutable - true if this map should contain immutable Values

logger - Logger for this map

Method Details

isImmutable

public boolean isImmutable()

Specified by:

isImmutable in interface ValueMap

Returns:

true if this map is for immutable Values

convert

public void convert(NumeralType type)

Specified by:

convert in interface ValueMap

Parameters:

type - NumeralType for the Values to be converted to

Throws:

ExtendedArithmeticException - if any of the Values in this map cannot be converted to the specified type

NullPointerException - if the specified type is null

IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

UnsupportedOperationException - if this map is for immutable Values

convert

public void convert(Collection<? extends Handle> handles,
 NumeralType type)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

convert in interface ValueMap

Parameters:

handles - Handles of the Values to be converted

type - NumeralType for the Values to be converted to

Throws:

ExtendedArithmeticException - if any of the specified values in this map cannot be converted to the specified type

NullPointerException - if the specified type is null

IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

UnsupportedOperationException - if this map is for immutable Values

convert

public void convert(Map<? extends Handle,NumeralType> types)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

convert in interface ValueMap

Parameters:

types - map of Handles and NumeralTypes for the Values represented by those Handles to be converted to.

Throws:

ExtendedArithmeticException - if any of the specified values in this map cannot be converted to the specified type

NullPointerException - if the specified type is null

IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

UnsupportedOperationException - if this map is for immutable Values

convertAllowed

public void convertAllowed(NumeralType type)

Only converts Values of this map that can be converted to the specified type. In other words, calls Numeral.convertIfAllowed(NumeralType) on every Value of this map. If this map is for immutable Values, this method does nothing.

Specified by:

convertAllowed in interface ValueMap

Parameters:

type - NumeralType for the Values to be converted to

Throws:

NullPointerException - if the specified type is null

IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

toInteger

public void toInteger()

Converts all Values to the smallest integer type that can hold its represented value. Values that are already integers are not converted.

Specified by:

toInteger in interface ValueMap

Throws:

UnsupportedOperationException - if this map is for immutable Values

toDecimal

public void toDecimal()

Converts all Values to the smallest decimal type that can hold its represented value. Values that are already decimals are not converted.

Specified by:

toDecimal in interface ValueMap

Throws:

UnsupportedOperationException - if this map is for immutable Values

toSmallestType

public void toSmallestType()

Converts all Values to the smallest type that can hold its represented value. Will not convert between integer and decimal representations. If this map is for immutable Values, this method does nothing.

Specified by:

toSmallestType in interface ValueMap

toSmallestType

public void toSmallestType(Collection<? extends Handle> handles)

Converts specified Values to the smallest type that can hold its represented value. Will not convert between integer and decimal representations. Handles that are not a part of this map's associated Space are ignored. If this map is for immutable Values, this method does nothing.

Specified by:

toSmallestType in interface ValueMap

Parameters:

handles - Handles of the values to be converted

set

public void set(Numeral value)

Specified by:

set in interface ValueMap

Parameters:

value - Numeral for all Values of this map to be set to

Throws:

UnsupportedOperationException - if this map is for immutable Values

set

public void set(MapMathContext context,
 Collection<? extends Handle> handles,
 Numeral value)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

set in interface ValueMap

Parameters:

context - MapMathContext for this operation

handles - Handles of the values to be changed

value - Numeral for specified Values of this map to be set to

Throws:

UnsupportedOperationException - if this map is for immutable Values

set

public void set(MapMathContext context,
 Map<? extends Handle,Numeral> values)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

set in interface ValueMap

Parameters:

context - MapMathContext for this operation

values - map of Handles to be changed and Numerals for the specified Values to be set to

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(SourceOperation operation,
 MathContext context)

Specified by:

apply in interface ValueMap

Parameters:

operation - SourceOperation to be applied to all Values of this map

context - MathContext for the operation

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(SourceOperation operation,
 MapMathContext context,
 Collection<? extends Handle> handles)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

apply in interface ValueMap

Parameters:

operation - SourceOperation to be applied to specified Values of this map

context - MapMathContext for the operation

handles - Handles of the Values to be modified

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(SingleParameterOperation operation,
 MathContext context,
 Numeral parameter)

Specified by:

apply in interface ValueMap

Parameters:

operation - SingleParameterOperation to be applied to all Values of this map

context - MathContext for the operation

parameter - parameter for the operation

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(SingleParameterOperation operation,
 MapMathContext context,
 Collection<? extends Handle> handles,
 Numeral parameter)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

apply in interface ValueMap

Parameters:

operation - SingleParameterOperation to be applied to specified Values of this map

context - MapMathContext for the operation

handles - Handles of the Values to be modified

parameter - parameter for the operation

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(SingleParameterOperation operation,
 MapMathContext context,
 Map<? extends Handle,Numeral> parameters)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

apply in interface ValueMap

Parameters:

operation - SingleParameterOperation to be applied to specified Values of this map

context - MapMathContext for the operation

parameters - map of Handles of the Values to be modified and Numerals to be used as parameters for the operation

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(DualParameterOperation operation,
 MathContext context,
 Numeral parameter1,
 Numeral parameter2)

Specified by:

apply in interface ValueMap

Parameters:

operation - DualParameterOperation to be applied to all Values of this map

context - MathContext for the operation

parameter1 - first parameter for the operation

parameter2 - second parameter for the operation

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(DualParameterOperation operation,
 MapMathContext context,
 Collection<? extends Handle> handles,
 Numeral parameter1,
 Numeral parameter2)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

apply in interface ValueMap

Parameters:

operation - DualParameterOperation to be applied to specified Values of this map

context - MapMathContext for the operation

handles - Handles of the Values to be modified

parameter1 - first parameter for the operation

parameter2 - second parameter for the operation

Throws:

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(Operation operation,
 MathContext context,
 Numeral... parameters)

Specified by:

apply in interface ValueMap

Parameters:

operation - Operation to be applied to all Values of this map

context - MathContext for the operation

parameters - parameters for the operation

Throws:

IllegalArgumentException - if the amount of parameters is not equal to Operation.getParameterCount()

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(Operation operation,
 MapMathContext context,
 Collection<? extends Handle> handles,
 Numeral... parameters)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

apply in interface ValueMap

Parameters:

operation - Operation to be applied to all Values of this map

context - MathContext for the operation

handles - Handles of the Values to be modified

parameters - parameters for the operation

Throws:

IllegalArgumentException - if the amount of parameters is not equal to Operation.getParameterCount()

UnsupportedOperationException - if this map is for immutable Values

apply

public void apply(Operation operation,
 MapMathContext context,
 Map<? extends Handle,Numeral[]> parameters)

Handles that are not a part of this map's associated Space are ignored.

Specified by:

apply in interface ValueMap

Parameters:

operation - Operation to be applied to all Values of this map

context - MathContext for the operation

parameters - map of Handles of the Values to be modified and Numerals to be used as parameters for the operation

Throws:

IllegalArgumentException - if the amount of parameters is not equal to Operation.getParameterCount()

UnsupportedOperationException - if this map is for immutable Values

compare

public boolean compare(Comparison comparison,
 ComparisonContext context,
 Numeral other)

Specified by:

compare in interface ValueMap

Parameters:

comparison - Comparison to be used

context - ComparisonContext for the comparison

other - Numeral to be compared to

Returns:

true if the Comparison returns true for all Values of this map

compare

public boolean compare(Comparison comparison,
 MapComparisonContext context,
 Collection<? extends Handle> handles,
 Numeral other)

Specified by:

compare in interface ValueMap

Parameters:

comparison - Comparison to be used

context - MapComparisonContext for the comparison

handles - Handles of the Values to be compared

other - Numeral to be compared to

Returns:

true if the Comparison returns true for all Values of this map represented by the specified keys

compare

public boolean compare(Comparison comparison,
 MapComparisonContext context,
 Map<? extends Handle,Numeral> others)

Specified by:

compare in interface ValueMap

Parameters:

comparison - Comparison to be used

context - MapComparisonContext for the comparison

others - map of Handles of the Values to be compared and Numerals to be compared to

Returns:

true if the Comparison returns true for all Values of this map represented by the specified keys

getBaseNumeralMap

public Map<Handle,Numeral> getBaseNumeralMap()

Specified by:

getBaseNumeralMap in interface ValueMap

Returns:

Map containing all entries of this map, but with the return value of Value.getBase() as the map values. The returned map does not have any state and instead provides a view to this map

getValueNumeralMap

public Map<Handle,Numeral> getValueNumeralMap()

Specified by:

getValueNumeralMap in interface ValueMap

Returns:

Map containing all entries of this map, but with the return value of Value.getValue() as the map values. The returned map does not have any state and instead provides a view to this map

getModifiers

public Collection<Modifier> getModifiers()

Specified by:

getModifiers in interface ValueMap

Returns:

Modifiers associated with this map

addModifier

public boolean addModifier(Modifier modifier)

Modifiers added to this map will be added to all Values of this map, including ones that are added to this map after this operation. To add a modifier to a single value, use Value.addModifier(Modifier) instead.

Specified by:

addModifier in interface ValueMap

Parameters:

modifier - Modifier to be added

Returns:

true if the Modifiers of this map changed as a result of this operation

addModifiers

public boolean addModifiers(Collection<? extends Modifier> modifiers)

Modifiers added to this map will be added to all Values of this map, including ones that are added to this map after this operation. To add modifiers to a single value, use Value.addModifiers(Collection)} instead.

Specified by:

addModifiers in interface ValueMap

Parameters:

modifiers - Modifiers to be added

Returns:

true if the Modifiers of this map changed as a result of this operation

removeModifier

public boolean removeModifier(Modifier modifier)

Specified by:

removeModifier in interface ValueMap

Parameters:

modifier - Modifier to be removed

Returns:

true if the Modifiers of this map changed as a result of this operation

removeModifiers

public boolean removeModifiers(Collection<? extends Modifier> modifiers)

Specified by:

removeModifiers in interface ValueMap

Parameters:

modifiers - Modifiers to be removed

Returns:

true if the Modifiers of this map changed as a result of this operation

containsModifier

public boolean containsModifier(Modifier modifier)

Specified by:

containsModifier in interface ValueMap

Parameters:

modifier - Modifier to be checked for

Returns:

true if the specified Modifier is associated with this map

containsModifiers

public boolean containsModifiers(Collection<? extends Modifier> modifiers)

Specified by:

containsModifiers in interface ValueMap

Parameters:

modifiers - Modifiers to be checked for

Returns:

true if all of the specified Modifiers are associated with this map

getSpace

public Space getSpace()

Returns the Space associated with this map. All Handle keys present in this map must be associated with this space.

Specified by:

getSpace in interface HandleMap<Value>

Returns:

Space associated with this map

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<Value>

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 Value putHandled(Value value)

Associates a Value in this map. If the map previously contained a mapping for the Handle, the old Value is replaced.

Specified by:

putHandled in interface HandleMap<Value>

Parameters:

value - Value to be associated in this map with its associated Handle as a key

Returns:

the previously associated Value in this map, or null if there was no previous association

Throws:

IllegalArgumentException - if the Value is static, if Value.isImmutable() is not the same as isImmutable() or if the associated Handle is not contained in the Space associated with this map

unmodifiable

public HandleMap<Value> 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<Value>

Returns:

unmodifiable version of this map

getByTag

public Collection<Value> 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<Value>

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<Value> 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<Value>

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

size

public int size()

Specified by:

size in interface Map<Handle,Value>

Returns:

number of Values in this map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Handle,Value>

Returns:

true if this map contains no Values

containsKey

public boolean containsKey(Object key)

Description copied from interface: HandleMap

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<Value>

Specified by:

containsKey in interface Map<Handle,Value>

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Handle,Value>

Parameters:

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

get

public Value get(Object key)

Description copied from interface: HandleMap

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<Value>

Specified by:

get in interface Map<Handle,Value>

Parameters:

key - the key whose associated value is to be returned

Returns:

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

put

public Value put(Handle key,
 Value value)

This method ignores the key parameter, it is recommended to use putHandled(Value) instead.

Specified by:

put in interface HandleMap<Value>

Specified by:

put in interface Map<Handle,Value>

Parameters:

key - ignored parameter

value - Value to be associated with this map

Returns:

previously associated Value in this map, or null if there was no previous association

Throws:

IllegalArgumentException - if the Value is static, if Value.isImmutable() is not the same as isImmutable() or if the associated Handle is not contained in the Space associated with this map

remove

public Value remove(Object key)

Description copied from interface: HandleMap

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<Value>

Specified by:

remove in interface Map<Handle,Value>

Parameters:

key - key whose mapping is to be removed from the map

Returns:

previous Value associated with the key, or null if there was no mapping

putAll

public void putAll(Map<? extends Handle,? extends Value> m)

Description copied from interface: HandleMap

Copies all of the mappings from the specified map to this map. The effect of this call is equivalent to that of calling HandleMap.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<Value>

Specified by:

putAll in interface Map<Handle,Value>

Parameters:

m - mappings to be stored in this map

getOrDefault

public Value getOrDefault(Object key,
 Value 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<Value>

Specified by:

getOrDefault in interface Map<Handle,Value>

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 an inappropriate type for this map

NullPointerException - if the specified key is null

putIfAbsent

public Value putIfAbsent(Handle key,
 Value 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<Value>

Specified by:

putIfAbsent in interface Map<Handle,Value>

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

ClassCastException - if the key or value is of an inappropriate type for 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<Value>

Specified by:

remove in interface Map<Handle,Value>

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 or value is of an inappropriate type for this map

NullPointerException - if the specified key or value is null

clear

public void clear()

Removes all of the Values from this map.

Specified by:

clear in interface Map<Handle,Value>

keySet

public Set<Handle> keySet()

Specified by:

keySet in interface Map<Handle,Value>

Returns:

Handles of the Values associated with this map

values

public Collection<Value> values()

Specified by:

values in interface Map<Handle,Value>

Returns:

Values associated with this map

entrySet

public Set<Map.Entry<Handle,Value>> entrySet()

Specified by:

entrySet in interface Map<Handle,Value>

Returns:

Handles and Values associated with this map

toString

public String toString()

Overrides:

toString in class Object

builder

public static DelegatedValueMap.Builder builder(Space space)

Parameters:

space - Space to be associated with the DelegatedValueMap.Builder

Returns:

DelegatedValueMap.Builder with the specified Space