net.sf.jaccumulator.unlimiteds

Interface MutableUnlimitedDecimalValue<VALUE extends MutableUnlimitedDecimalValue<VALUE>>

Type Parameters:

VALUE - this value type (used to facilitate operation chaining)

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, MutableAccumulator<ACCUMULATOR>, MutablePrimitive<PRIMITIVE>, MutableReal<REAL>, Primitive<PRIMITIVE>, Real<REAL>, UnlimitedDecimalValue<VALUE>

All Known Implementing Classes:

AbstractAccumulator, AbstractBooleanPrimitive, AbstractBytePrimitive, AbstractCharacterPrimitive, AbstractConstant, AbstractConstantAccumulator, AbstractDoublePrimitive, AbstractFloatPrimitive, AbstractIntegerPrimitive, AbstractLongPrimitive, AbstractModuloIntegerPrimitive, AbstractNumericPrimitive, AbstractPrimitive, AbstractPrimitiveWrapper, AbstractReal, AbstractShortPrimitive, AbstractSimpleAccumulator, AbstractStickyTarget, AbstractTextPrimitive, AbstractUnlimitedDecimalPrimitive, AbstractUnlimitedIntegerPrimitive, BooleanArrayCursor, BooleanPrimitive, ByteArrayCursor, BytePrimitive, CharacterArrayCursor, CharacterPrimitive, Constant, ConstantAccumulator, DoublePrimitive, EnumerationPrimitive, FloatPrimitive, GaussianRandomPrimitive, IntegerPrimitive, LongPrimitive, Milliseconds, ModuloIntegerPrimitive, Nanoseconds, RandomPrimitive, ShortPrimitive, SimpleAccumulator, TextPrimitive, UnlimitedDecimalPrimitive, UnlimitedIntegerPrimitive, Variant

public interface MutableUnlimitedDecimalValue<VALUE extends MutableUnlimitedDecimalValue<VALUE>>

A changeable unlimited decimal property value

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
VALUE	setReal(BigDecimal aValue) Set this property to the specified unlimited decimal value and answer this object (facilitates chaining)
BigDecimal	unlimitedDecimalPostDecrement() Decrement the real value of this object then return the original value prior to decrementing
BigDecimal	unlimitedDecimalPostIncrement() Increment the real value of this object then return the original value prior to incrementing

Method Detail

setReal

VALUE setReal(BigDecimal aValue)
                                                          throws UnsupportedOperationException,
                                                                 IllegalArgumentException,
                                                                 ArithmeticException,
                                                                 NullPointerException

Set this property to the specified unlimited decimal value and answer this object (facilitates chaining)

Parameters:

aValue - an unlimited decimal value

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the specified value was incommensurate with this object's specification

ArithmeticException - the numeric value provided was incompatible with with algebraic interpretation of this object

NullPointerException - a null value was provided though this object does not accept null values

unlimitedDecimalPostDecrement

BigDecimal unlimitedDecimalPostDecrement()
                                         throws UnsupportedOperationException,
                                                ArithmeticException,
                                                IllegalArgumentException

Decrement the real value of this object then return the original value prior to decrementing

Returns:

the original value of this real

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object

unlimitedDecimalPostIncrement

BigDecimal unlimitedDecimalPostIncrement()
                                         throws UnsupportedOperationException,
                                                ArithmeticException,
                                                IllegalArgumentException

Increment the real value of this object then return the original value prior to incrementing

Returns:

the original value of this real

Throws:

UnsupportedOperationException - if this object's value cannot be changed

IllegalArgumentException - if the new value was incommensurate with this object's specification

ArithmeticException - the new numeric value was incompatible with with algebraic interpretation of this object