net.sf.jaccumulator.scalars

Interface ScalarInductor<SCALAR extends ScalarInductor<SCALAR>>

Type Parameters:

SCALAR - this scalar type (used to facilitate operation chaining)

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, 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 ScalarInductor<SCALAR extends ScalarInductor<SCALAR>>

Imparts scalar values into other scalars

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
<S extends Scalar<?>> S	inducePostDecrement(S aTarget) Decrement the value of this scalar then induce its original value into the specified target
<S extends Scalar<?>> S	inducePostIncrement(S aTarget) Increment the value of this scalar then induce its original value into the specified target
<S extends Scalar<?>> S	induceScalarValue(S aTarget) Induce the current value of this scalar into the specified target

Method Detail

inducePostDecrement

<S extends Scalar<?>> S inducePostDecrement(S aTarget)
                                     throws NullPointerException,
                                            NoSuchElementException,
                                            UnsupportedOperationException,
                                            IllegalStateException

Decrement the value of this scalar then induce its original value into the specified target

Type Parameters:

S - the target type

Parameters:

aTarget - a target into which the current value of this scalar will be induced, prior to decrementing

Returns:

the target

Throws:

UnsupportedOperationException - this target primitive cannot be changed

IllegalStateException - this target primitive cannot be changed at this time

NullPointerException - a null value was provided when none was expected

NoSuchElementException - an expected parameter was not found in the parameter source

inducePostIncrement

<S extends Scalar<?>> S inducePostIncrement(S aTarget)
                                     throws NullPointerException,
                                            NoSuchElementException,
                                            UnsupportedOperationException,
                                            IllegalStateException

Increment the value of this scalar then induce its original value into the specified target

Type Parameters:

S - the target type

Parameters:

aTarget - a target into which the current value of this scalar will be induced, prior to incrementing

Returns:

the target

Throws:

UnsupportedOperationException - this target primitive cannot be changed

IllegalStateException - this target primitive cannot be changed at this time

NullPointerException - a null value was provided when none was expected

NoSuchElementException - an expected parameter was not found in the parameter source

induceScalarValue

<S extends Scalar<?>> S induceScalarValue(S aTarget)
                                   throws NullPointerException,
                                          NoSuchElementException,
                                          UnsupportedOperationException,
                                          IllegalStateException

Induce the current value of this scalar into the specified target

Type Parameters:

S - the target type

Parameters:

aTarget - a target into which the current value of this scalar will be induced

Returns:

the target

Throws:

UnsupportedOperationException - this target primitive cannot be changed

IllegalStateException - this target primitive cannot be changed at this time

NullPointerException - a null value was provided when none was expected

NoSuchElementException - an expected parameter was not found in the parameter source