Package me.datafox.dfxengine.values

Class ValueImpl

java.lang.Object

me.datafox.dfxengine.dependencies.AbstractDependency

me.datafox.dfxengine.dependencies.DependencyDependent

me.datafox.dfxengine.values.ValueImpl

All Implemented Interfaces:

Comparable<Handled>, Dependency, Dependent, Handled, Value

public class ValueImpl
extends DependencyDependent
implements Value

A mutable numeric value identified by a Handle and backed with a Numeral that supports dynamic Modifiers. Each value contains a base Numeral that can be changed with set(Numeral) and apply(Operation, MathContext, Numeral...) and other apply(...) methods. Each value also contains a value Numeral, which represents the base Numeral with all the Modifiers applied to it. This value is lazily calculated when getValue() is called, but only when the base Numeral or any of the Modifiers have changed. These changes are tracked with Dependencies and Dependents.

Field Summary

Fields inherited from class me.datafox.dfxengine.dependencies.AbstractDependency

dependents, logger

Constructor Summary

Constructors

Constructor	Description
ValueImpl(Handle handle, Numeral value, boolean immutable)

Method Summary

Modifier and Type	Method	Description
boolean	addModifier(Modifier modifier)
boolean	addModifiers(Collection<? extends Modifier> modifiers)
void	apply(DualParameterOperation operation, MathContext context, Numeral parameter1, Numeral parameter2)
void	apply(Operation operation, MathContext context, Numeral... parameters)
void	apply(SingleParameterOperation operation, MathContext context, Numeral parameter)
void	apply(SourceOperation operation, MathContext context)
boolean	canConvert(NumeralType type)
boolean	compare(Comparison comparison, ComparisonContext context, Numeral other)
boolean	containsModifier(Modifier modifier)
boolean	containsModifiers(Collection<? extends Modifier> modifiers)
boolean	convert(NumeralType type)
boolean	convertIfAllowed(NumeralType type)
Numeral	getBase()
Handle	getHandle()
Collection<Modifier>	getModifiers()
Numeral	getValue()
boolean	isImmutable()	Static values are always immutable.
boolean	isStatic()	This implementation always returns false.
protected void	onInvalidate()	This method should be treated as the equivalent of Dependent.invalidate() for classes extending DependencyDependent.
boolean	removeModifier(Modifier modifier)
boolean	removeModifiers(Collection<? extends Modifier> modifiers)
void	set(Numeral value)
boolean	toDecimal()	If the base Numeral does not represent a decimal value (NumeralType.isDecimal() is false for Numeral.getType()), converts it to the smallest decimal type that hold the represented value.
boolean	toInteger()	If the base Numeral does not represent an integer value (NumeralType.isInteger() is false for Numeral.getType()), converts it to the smallest integer type that hold the represented value.
boolean	toSmallestType()	Converts the base Numeral to the smallest type that can hold its represented value.
String	toString()

Methods inherited from class me.datafox.dfxengine.dependencies.DependencyDependent

invalidate

Methods inherited from class me.datafox.dfxengine.dependencies.AbstractDependency

addDependent, addDependents, containsDependent, containsDependentRecursive, containsDependents, containsDependentsRecursive, dependentStream, getDependents, invalidateDependents, recursiveDependentStream, removeDependent, removeDependents

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.datafox.dfxengine.dependencies.Dependency

addDependent, addDependents, containsDependent, containsDependentRecursive, containsDependents, containsDependentsRecursive, dependentStream, getDependents, invalidateDependents, recursiveDependentStream, removeDependent, removeDependents

Methods inherited from interface me.datafox.dfxengine.dependencies.Dependent

invalidate

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

compareTo

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

apply, apply, apply, apply, compare

Constructor Details

ValueImpl

public ValueImpl(Handle handle,
 Numeral value,
 boolean immutable)

Parameters:

handle - Handle identifier for this value

value - Numeral to initialize this value with

immutable - true if this value should be immutable

Method Details

getHandle

public Handle getHandle()

Specified by:

getHandle in interface Handled

Specified by:

getHandle in interface Value

Returns:

Handle associated with this value

getBase

public Numeral getBase()

Specified by:

getBase in interface Value

Returns:

base Numeral of this value

getValue

public Numeral getValue()

Specified by:

getValue in interface Value

Returns:

base Numeral of this value with all Modifiers of this value applied to it

isStatic

public boolean isStatic()

This implementation always returns false.

Specified by:

isStatic in interface Value

Returns:

true if this value is static

isImmutable

public boolean isImmutable()

Description copied from interface: Value

Static values are always immutable.

Specified by:

isImmutable in interface Value

Returns:

true if this value is immutable

canConvert

public boolean canConvert(NumeralType type)

Specified by:

canConvert in interface Value

Parameters:

type - NumeralType to be checked for

Returns:

true if the base Numeral of this value can be converted to the specified type

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

convert

public boolean convert(NumeralType type)

Specified by:

convert in interface Value

Parameters:

type - NumeralType for the base Numeral of this value to be converted to

Returns:

true if the base Numeral of this value was changed as a result of this operation

Throws:

ExtendedArithmeticException - if the base Numeral of this value is outside the specified type's bounds

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 value is immutable

convertIfAllowed

public boolean convertIfAllowed(NumeralType type)

Specified by:

convertIfAllowed in interface Value

Parameters:

type - NumeralType for the base Numeral of this value to be converted to

Returns:

true if the base Numeral of this value was changed as a result of this operation

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

If the base Numeral does not represent an integer value (NumeralType.isInteger() is false for Numeral.getType()), converts it to the smallest integer type that hold the represented value.

Specified by:

toInteger in interface Value

Returns:

true if the base Numeral was changed as a result of this operation

Throws:

UnsupportedOperationException - if this value is immutable

toDecimal

public boolean toDecimal()

If the base Numeral does not represent a decimal value (NumeralType.isDecimal() is false for Numeral.getType()), converts it to the smallest decimal type that hold the represented value.

Specified by:

toDecimal in interface Value

Returns:

true if the base Numeral was changed as a result of this operation

Throws:

UnsupportedOperationException - if this value is immutable

toSmallestType

public boolean toSmallestType()

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

Specified by:

toSmallestType in interface Value

Returns:

true if the base Numeral was changed as a result of this operation

set

public void set(Numeral value)

Specified by:

set in interface Value

Parameters:

value - value to replace the current base Numeral

Throws:

UnsupportedOperationException - if this value is immutable

apply

public void apply(SourceOperation operation,
 MathContext context)

Specified by:

apply in interface Value

Parameters:

operation - SourceOperation to be applied to the base Numeral

context - MathContext for the operation

Throws:

UnsupportedOperationException - if this value is immutable

apply

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

Specified by:

apply in interface Value

Parameters:

operation - SingleParameterOperation to be applied to the base Numeral

context - MathContext for the operation

parameter - parameter for the operation

Throws:

UnsupportedOperationException - if this value is immutable

apply

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

Specified by:

apply in interface Value

Parameters:

operation - DualParameterOperation to be applied to the base Numeral

context - MathContext for the operation

parameter1 - first parameter for the operation

parameter2 - second parameter for the operation

Throws:

UnsupportedOperationException - if this value is immutable

apply

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

Specified by:

apply in interface Value

Parameters:

operation - Operation to be applied to the base Numeral

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 value is immutable

compare

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

Specified by:

compare in interface Value

Parameters:

comparison - Comparison to be used

context - ComparisonContext for the comparison

other - Numeral to be compared with

Returns:

true if the specified Comparison returns true

getModifiers

public Collection<Modifier> getModifiers()

Specified by:

getModifiers in interface Value

Returns:

Modifiers associated with this value

addModifier

public boolean addModifier(Modifier modifier)

Specified by:

addModifier in interface Value

Parameters:

modifier - Modifier to be added

Returns:

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

addModifiers

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

Specified by:

addModifiers in interface Value

Parameters:

modifiers - Modifiers to be added

Returns:

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

removeModifier

public boolean removeModifier(Modifier modifier)

Specified by:

removeModifier in interface Value

Parameters:

modifier - Modifier to be removed

Returns:

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

removeModifiers

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

Specified by:

removeModifiers in interface Value

Parameters:

modifiers - Modifiers to be removed

Returns:

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

containsModifier

public boolean containsModifier(Modifier modifier)

Specified by:

containsModifier in interface Value

Parameters:

modifier - Modifier to be checked for

Returns:

true if the specified Modifier is associated with this value

containsModifiers

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

Specified by:

containsModifiers in interface Value

Parameters:

modifiers - Modifiers to be checked for

Returns:

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

onInvalidate

protected void onInvalidate()

Description copied from class: DependencyDependent

This method should be treated as the equivalent of Dependent.invalidate() for classes extending DependencyDependent. This exists to avoid the need for calling super.invalidate() or AbstractDependency.invalidateDependents() which may cause hidden or hard to find bugs when forgotten.

Specified by:

onInvalidate in class DependencyDependent

toString

public String toString()

Overrides:

toString in class Object

Returns:

String representation of this value in format Value(base,value,[mutable/immutable])