net.sf.jaccumulator.shorts

Interface MutableShortValue<VALUE extends MutableShortValue<VALUE>>

Type Parameters:

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

All Known Subinterfaces:

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

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 MutableShortValue<VALUE extends MutableShortValue<VALUE>>

A changeable short property value

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

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

Method Detail

setScalar

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

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

Parameters:

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

shortPostDecrement

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

shortPostIncrement

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