Package me.datafox.dfxengine.values

Class StaticValue

java.lang.Object

me.datafox.dfxengine.values.StaticValue

All Implemented Interfaces:

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

Direct Known Subclasses:

MappingOperationModifier.SpecialValue

public class StaticValue
extends Object
implements Value

A numeric value backed with a Numeral. A static value is immutable, unmodifiable and not identified by a Handle. More specifically, getHandle() return null, any calls to set(Numeral) and all apply(...) methods throw UnsupportedOperationException, and all Modifier-related methods return false with no other action. Static values are primarily meant to be used as immutable parameters for Modifier implementations in this module (AbstractModifier, OperationModifier and MappingOperationModifier).

Constructor Summary

Constructors

Constructor	Description
StaticValue(Numeral value)

Method Summary

Modifier and Type	Method	Description
boolean	addDependent(Dependent dependent)	This implementation will always return false.
boolean	addDependents(Collection<? extends Dependent> dependencies)	This implementation will always return false.
boolean	addModifier(Modifier modifier)	This implementation will always return false.
boolean	addModifiers(Collection<? extends Modifier> modifiers)	This implementation will always return false.
void	apply(DualParameterOperation operation, MathContext context, Numeral parameter1, Numeral parameter2)	This implementation will always throw UnsupportedOperationException.
void	apply(Operation operation, MathContext context, Numeral... parameters)	This implementation will always throw UnsupportedOperationException.
void	apply(SingleParameterOperation operation, MathContext context, Numeral parameter)	This implementation will always throw UnsupportedOperationException.
void	apply(SourceOperation operation, MathContext context)	This implementation will always throw UnsupportedOperationException.
boolean	canConvert(NumeralType type)	This implementation will always return false.
boolean	compare(Comparison comparison, ComparisonContext context, Numeral other)
boolean	containsDependent(Dependent dependent)	This implementation will always return false.
boolean	containsDependentRecursive(Dependent dependent)	This implementation will always return false.
boolean	containsDependents(Collection<? extends Dependent> dependents)	This implementation will always return false.
boolean	containsDependentsRecursive(Collection<? extends Dependent> dependents)	This implementation will always return false.
boolean	containsModifier(Modifier modifier)	This implementation will always return false.
boolean	containsModifiers(Collection<? extends Modifier> modifiers)	This implementation will always return false.
boolean	convert(NumeralType type)	This implementation always throws UnsupportedOperationException.
boolean	convertIfAllowed(NumeralType type)	This implementation will always return false.
Stream<Dependent>	dependentStream()	This implementation will always return an empty Stream.
Numeral	getBase()
Collection<Dependent>	getDependents()	This implementation will always return an empty collection.
Handle	getHandle()	This implementation always returns null
Collection<Modifier>	getModifiers()	This implementation will always return an empty collection.
Numeral	getValue()
void	invalidate()	Static values do not need to be invalidated.
void	invalidateDependents()	Static values do not need to be invalidated.
boolean	isImmutable()	This implementation always returns true.
boolean	isStatic()	This implementation always returns true.
Stream<Dependent>	recursiveDependentStream()	This implementation will always return an empty Stream.
boolean	removeDependent(Dependent dependent)	This implementation will always return false.
boolean	removeDependents(Collection<? extends Dependent> dependents)	This implementation will always return false.
boolean	removeModifier(Modifier modifier)	This implementation will always return false.
boolean	removeModifiers(Collection<? extends Modifier> modifiers)	This implementation will always return false.
void	set(Numeral value)	This implementation will always throw UnsupportedOperationException.
boolean	toDecimal()	This implementation will always throw UnsupportedOperationException.
boolean	toInteger()	This implementation will always throw UnsupportedOperationException.
boolean	toSmallestType()	This implementation will always return false.
String	toString()

Methods inherited from class java.lang.Object

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

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

StaticValue

public StaticValue(Numeral value)

Parameters:

value - Numeral to initialize this value with

Method Details

getHandle

public Handle getHandle()

This implementation always returns null

Specified by:

getHandle in interface Handled

Specified by:

getHandle in interface Value

Returns:

Handle associated with this value, or null if this value is static

getBase

public Numeral getBase()

Specified by:

getBase in interface Value

Returns:

Numeral value of this value

getValue

public Numeral getValue()

Specified by:

getValue in interface Value

Returns:

Numeral value of this value

isStatic

public boolean isStatic()

This implementation always returns true.

Specified by:

isStatic in interface Value

Returns:

true if this value is static

isImmutable

public boolean isImmutable()

This implementation always returns true.

Specified by:

isImmutable in interface Value

Returns:

true if this value is static

canConvert

public boolean canConvert(NumeralType type)

This implementation will always return false.

Specified by:

canConvert in interface Value

Parameters:

type - ignored parameter

Returns:

false

convert

public boolean convert(NumeralType type)

This implementation always throws UnsupportedOperationException.

Specified by:

convert in interface Value

Parameters:

type - ignored parameter

Returns:

nothing

Throws:

UnsupportedOperationException - when called

convertIfAllowed

public boolean convertIfAllowed(NumeralType type)

This implementation will always return false.

Specified by:

convertIfAllowed in interface Value

Parameters:

type - ignored parameter

Returns:

false

toInteger

public boolean toInteger()

This implementation will always throw UnsupportedOperationException.

Specified by:

toInteger in interface Value

Returns:

nothing

Throws:

UnsupportedOperationException - when called

toDecimal

public boolean toDecimal()

This implementation will always throw UnsupportedOperationException.

Specified by:

toDecimal in interface Value

Returns:

nothing

Throws:

UnsupportedOperationException - when called

toSmallestType

public boolean toSmallestType()

This implementation will always return false.

Specified by:

toSmallestType in interface Value

Returns:

false

set

public void set(Numeral value)

This implementation will always throw UnsupportedOperationException.

Specified by:

set in interface Value

Parameters:

value - ignored parameter

Throws:

UnsupportedOperationException - when called

apply

public void apply(SourceOperation operation,
 MathContext context)

This implementation will always throw UnsupportedOperationException.

Specified by:

apply in interface Value

Parameters:

operation - ignored parameter

context - ignored parameter

Throws:

UnsupportedOperationException - when called

apply

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

This implementation will always throw UnsupportedOperationException.

Specified by:

apply in interface Value

Parameters:

operation - ignored parameter

context - ignored parameter

parameter - ignored parameter

Throws:

UnsupportedOperationException - when called

apply

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

This implementation will always throw UnsupportedOperationException.

Specified by:

apply in interface Value

Parameters:

operation - ignored parameter

context - ignored parameter

parameter1 - ignored parameter

parameter2 - ignored parameter

Throws:

UnsupportedOperationException - when called

apply

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

This implementation will always throw UnsupportedOperationException.

Specified by:

apply in interface Value

Parameters:

operation - ignored parameter

context - ignored parameter

parameters - ignored parameter

Throws:

UnsupportedOperationException - when called

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

This implementation will always return an empty collection.

Specified by:

getModifiers in interface Value

Returns:

Set.of()

addModifier

public boolean addModifier(Modifier modifier)

This implementation will always return false.

Specified by:

addModifier in interface Value

Parameters:

modifier - ignored parameter

Returns:

false

addModifiers

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

This implementation will always return false.

Specified by:

addModifiers in interface Value

Parameters:

modifiers - ignored parameter

Returns:

false

removeModifier

public boolean removeModifier(Modifier modifier)

This implementation will always return false.

Specified by:

removeModifier in interface Value

Parameters:

modifier - ignored parameter

Returns:

false

removeModifiers

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

This implementation will always return false.

Specified by:

removeModifiers in interface Value

Parameters:

modifiers - ignored parameter

Returns:

false

containsModifier

public boolean containsModifier(Modifier modifier)

This implementation will always return false.

Specified by:

containsModifier in interface Value

Parameters:

modifier - ignored parameter

Returns:

false

containsModifiers

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

This implementation will always return false.

Specified by:

containsModifiers in interface Value

Parameters:

modifiers - ignored parameter

Returns:

false

invalidate

public void invalidate()

Static values do not need to be invalidated.

Specified by:

invalidate in interface Dependent

getDependents

public Collection<Dependent> getDependents()

This implementation will always return an empty collection.

Specified by:

getDependents in interface Dependency

Returns:

Set.of()

invalidateDependents

public void invalidateDependents()

Static values do not need to be invalidated.

Specified by:

invalidateDependents in interface Dependency

addDependent

public boolean addDependent(Dependent dependent)

This implementation will always return false.

Specified by:

addDependent in interface Dependency

Parameters:

dependent - ignored parameter

Returns:

false

addDependents

public boolean addDependents(Collection<? extends Dependent> dependencies)

This implementation will always return false.

Specified by:

addDependents in interface Dependency

Parameters:

dependencies - ignored parameter

Returns:

false

removeDependent

public boolean removeDependent(Dependent dependent)

This implementation will always return false.

Specified by:

removeDependent in interface Dependency

Parameters:

dependent - ignored parameter

Returns:

false

removeDependents

public boolean removeDependents(Collection<? extends Dependent> dependents)

This implementation will always return false.

Specified by:

removeDependents in interface Dependency

Parameters:

dependents - ignored parameter

Returns:

false

containsDependent

public boolean containsDependent(Dependent dependent)

This implementation will always return false.

Specified by:

containsDependent in interface Dependency

Parameters:

dependent - ignored parameter

Returns:

false

containsDependents

public boolean containsDependents(Collection<? extends Dependent> dependents)

This implementation will always return false.

Specified by:

containsDependents in interface Dependency

Parameters:

dependents - ignored parameter

Returns:

false

containsDependentRecursive

public boolean containsDependentRecursive(Dependent dependent)

This implementation will always return false.

Specified by:

containsDependentRecursive in interface Dependency

Parameters:

dependent - ignored parameter

Returns:

false

containsDependentsRecursive

public boolean containsDependentsRecursive(Collection<? extends Dependent> dependents)

This implementation will always return false.

Specified by:

containsDependentsRecursive in interface Dependency

Parameters:

dependents - ignored parameter

Returns:

false

dependentStream

public Stream<Dependent> dependentStream()

This implementation will always return an empty Stream.

Specified by:

dependentStream in interface Dependency

Returns:

Stream.empty()

recursiveDependentStream

public Stream<Dependent> recursiveDependentStream()

This implementation will always return an empty Stream.

Specified by:

recursiveDependentStream in interface Dependency

Returns:

Stream.empty()

toString

public String toString()

Overrides:

toString in class Object

Returns:

String representation of this value in format StaticValue(value)