net.sf.jaccumulator.doubles

Interface MutableDoubleValue<VALUE extends MutableDoubleValue<VALUE>>

Type Parameters:

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

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, DoubleValue<VALUE>, MutableAccumulator<ACCUMULATOR>, MutablePrimitive<PRIMITIVE>, MutableReal<REAL>, MutableScalar<SCALAR>, Primitive<PRIMITIVE>, Real<REAL>, Scalar<SCALAR>

All Known Implementing Classes:

AbstractAccumulator, AbstractBooleanPrimitive, AbstractBytePrimitive, AbstractCharacterPrimitive, AbstractConstant, AbstractConstantAccumulator, AbstractDoublePrimitive, AbstractFloatPrimitive, AbstractIntegerPrimitive, AbstractLongPrimitive, AbstractModuloIntegerPrimitive, AbstractNumericPrimitive, AbstractPrimitive, AbstractPrimitiveWrapper, AbstractReal, AbstractScalar, 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 MutableDoubleValue<VALUE extends MutableDoubleValue<VALUE>>

A changeable double property value

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
double	doublePostDecrement() Decrement the scalar value of this object then return the original value prior to decrementing
double	doublePostIncrement() Increment the scalar value of this object then return the original value prior to incrementing
VALUE	setScalar(double aValue) Set this property to the specified double value and answer this object (facilitates chaining)

Method Detail

doublePostDecrement

double doublePostDecrement()
                           throws UnsupportedOperationException,
                                  ArithmeticException,
                                  IllegalArgumentException

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

Returns:

the original value of this scalar

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

doublePostIncrement

double doublePostIncrement()
                           throws UnsupportedOperationException,
                                  ArithmeticException,
                                  IllegalArgumentException

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

Returns:

the original value of this scalar

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

setScalar

VALUE setScalar(double aValue)
                                                  throws UnsupportedOperationException,
                                                         IllegalArgumentException,
                                                         ArithmeticException

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

Parameters:

aValue - a double 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