Package me.datafox.dfxengine.values.api

Interface Value

All Superinterfaces:
Comparable<Handled>, Dependency, Dependent, Handled
All Known Implementing Classes:
MappingOperationModifier.SpecialValue, StaticValue, ValueImpl
public interface Value extends Dependent, Dependency, Handled

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 convert(NumeralType), convertIfAllowed(NumeralType), toInteger(), toDecimal(), set(Numeral), 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 Numeral should be lazily calculated when getValue() is called, but only when the base Numeral or any of the Modifiers have changed. It is recommended for the implementation to extend DependencyDependent to simplify invalidating the cached value.

Values can be immutable. The base Numeral of an immutable value can not be changed, but immutable values can still have Modifiers. Calling convert(NumeralType), toInteger(), toDecimal(), set(Numeral) or any of the apply(...) methods should throw UnsupportedOperationException, and calling convertIfAllowed(NumeralType) or toSmallestType() should return false with no other action.

Values can also be considered static. A static value should be immutable, unmodifiable and not identified by a Handle. In addition to the rules for immutable values, getHandle() should return null and all Modifier-related methods should return false with no other action.