Package me.datafox.dfxengine.values.api

Interface ValueMap

All Superinterfaces:

HandleMap<Value>, Map<Handle,Value>

All Known Implementing Classes:

DelegatedValueMap

public interface ValueMap
extends HandleMap<Value>

An extension of HandleMap for storing and manipulating multiple Values simultaneously. A value map may only contain either only mutable Values or only immutable Values. A value map may not contain static Values.

Nested Class Summary

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

Map.Entry<K,V>

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.
default void	apply(DualParameterOperation operation, Collection<? extends Handle> handles, Numeral parameter1, Numeral parameter2)	Handles that are not a part of this map's associated Space are ignored.
default void	apply(DualParameterOperation operation, Numeral parameter1, Numeral parameter2)	Uses MathContext.defaults() for context.
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)
default void	apply(Operation operation, Collection<? extends Handle> handles, Numeral... parameters)	Handles that are not a part of this map's associated Space are ignored.
default void	apply(Operation operation, Map<? extends Handle,Numeral[]> parameters)	Handles that are not a part of this map's associated Space are ignored.
default void	apply(Operation operation, Numeral... parameters)	Uses MathContext.defaults() for context.
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)
default void	apply(SingleParameterOperation operation, Collection<? extends Handle> handles, Numeral parameter)	Handles that are not a part of this map's associated Space are ignored.
default void	apply(SingleParameterOperation operation, Map<? extends Handle,Numeral> parameters)	Handles that are not a part of this map's associated Space are ignored.
default void	apply(SingleParameterOperation operation, Numeral parameter)	Uses MathContext.defaults() for context.
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)
default void	apply(SourceOperation operation)	Uses MathContext.defaults() for context.
default void	apply(SourceOperation operation, Collection<? extends Handle> handles)	Handles that are not a part of this map's associated Space are ignored.
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)
default boolean	compare(Comparison comparison, Collection<? extends Handle> handles, Numeral other)	Uses MapComparisonContext.defaults() for context.
default boolean	compare(Comparison comparison, Map<? extends Handle,Numeral> others)	Uses MapComparisonContext.defaults() for context.
default boolean	compare(Comparison comparison, Numeral other)	Uses ComparisonContext.defaults() for context.
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	containsModifier(Modifier modifier)
boolean	containsModifiers(Collection<? extends Modifier> modifiers)
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.
Map<Handle,Numeral>	getBaseNumeralMap()
Collection<Modifier>	getModifiers()
Map<Handle,Numeral>	getValueNumeralMap()
boolean	isImmutable()
boolean	removeModifier(Modifier modifier)
boolean	removeModifiers(Collection<? extends Modifier> modifiers)
default void	set(Collection<? extends Handle> handles, Numeral value)	Handles that are not a part of this map's associated Space are ignored.
default void	set(Map<? extends Handle,Numeral> values)	Handles that are not a part of this map's associated Space are ignored.
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.
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.

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

containsKey, containsKeys, get, getByTag, getByTags, getOrDefault, getSpace, put, putAll, putHandled, putIfAbsent, remove, remove, unmodifiable

Methods inherited from interface java.util.Map

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

Method Details

isImmutable

boolean isImmutable()

Returns:

true if this map is for immutable Values

convert

void convert(NumeralType type)

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

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

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

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

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

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

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

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.

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

void toInteger()

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

Throws:

UnsupportedOperationException - if this map is for immutable Values

toDecimal

void toDecimal()

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

Throws:

UnsupportedOperationException - if this map is for immutable Values

toSmallestType

void toSmallestType()

Converts all Values to the smallest type that can hold its represented value. Will not convert between integer and decimal representations.

toSmallestType

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.

Parameters:

handles - Handles of the values to be converted

set

void set(Numeral value)

Parameters:

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

Throws:

UnsupportedOperationException - if this map is for immutable Values

set

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

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

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

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

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

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

void apply(SourceOperation operation,
 MathContext context)

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

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

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

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

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

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

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.

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

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.

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

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

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

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.

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

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

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

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.

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

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.

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

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

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

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

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

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

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

Map<Handle,Numeral> getBaseNumeralMap()

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

Map<Handle,Numeral> getValueNumeralMap()

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

Collection<Modifier> getModifiers()

Returns:

Modifiers associated with this map

addModifier

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.

Parameters:

modifier - Modifier to be added

Returns:

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

addModifiers

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.

Parameters:

modifiers - Modifiers to be added

Returns:

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

removeModifier

boolean removeModifier(Modifier modifier)

Parameters:

modifier - Modifier to be removed

Returns:

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

removeModifiers

boolean removeModifiers(Collection<? extends Modifier> modifiers)

Parameters:

modifiers - Modifiers to be removed

Returns:

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

containsModifier

boolean containsModifier(Modifier modifier)

Parameters:

modifier - Modifier to be checked for

Returns:

true if the specified Modifier is associated with this map

containsModifiers

boolean containsModifiers(Collection<? extends Modifier> modifiers)

Parameters:

modifiers - Modifiers to be checked for

Returns:

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

set

default void set(Collection<? extends Handle> handles,
 Numeral value)

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

handles - Handles of the values to be changed

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

set

default void set(Map<? extends Handle,Numeral> values)

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

apply

default void apply(SourceOperation operation)

Uses MathContext.defaults() for context.

Parameters:

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

apply

default void apply(SourceOperation operation,
 Collection<? extends Handle> handles)

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

handles - Handles of the Values to be modified

apply

default void apply(SingleParameterOperation operation,
 Numeral parameter)

Uses MathContext.defaults() for context.

Parameters:

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

parameter - parameter for the operation

apply

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

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

handles - Handles of the Values to be modified

parameter - parameter for the operation

apply

default void apply(SingleParameterOperation operation,
 Map<? extends Handle,Numeral> parameters)

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

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

apply

default void apply(DualParameterOperation operation,
 Numeral parameter1,
 Numeral parameter2)

Uses MathContext.defaults() for context.

Parameters:

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

parameter1 - first parameter for the operation

parameter2 - second parameter for the operation

apply

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

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

handles - Handles of the Values to be modified

parameter1 - first parameter for the operation

parameter2 - second parameter for the operation

apply

default void apply(Operation operation,
 Numeral... parameters)

Uses MathContext.defaults() for context.

Parameters:

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

parameters - parameters for the operation

Throws:

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

apply

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

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

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

apply

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

Handles that are not a part of this map's associated Space are ignored. Uses MapMathContext.defaults() for context.

Parameters:

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

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

compare

default boolean compare(Comparison comparison,
 Numeral other)

Uses ComparisonContext.defaults() for context.

Parameters:

comparison - Comparison to be used

other - Numeral to be compared to

Returns:

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

compare

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

Uses MapComparisonContext.defaults() for context.

Parameters:

comparison - Comparison to be used

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

default boolean compare(Comparison comparison,
 Map<? extends Handle,Numeral> others)

Uses MapComparisonContext.defaults() for context.

Parameters:

comparison - Comparison to be used

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