net.sf.jaccumulator.characters

Interface MutableCharacterValue<VALUE extends MutableCharacterValue<VALUE>>

Type Parameters:

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

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, CharacterValue<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 MutableCharacterValue<VALUE extends MutableCharacterValue<VALUE>>

A changeable char property value

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

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

Method Detail

charPostDecrement

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

charPostIncrement

char charPostIncrement()
                       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(char aValue)
                                                     throws UnsupportedOperationException,
                                                            IllegalArgumentException,
                                                            ArithmeticException

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

Parameters:

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