net.sf.jaccumulator.reals

Interface RealInductor<REAL extends RealInductor<REAL>>

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, Real<REAL>

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 RealInductor<REAL extends RealInductor<REAL>>

Imparts real values into other reals

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
<R extends Real<?>> R	inducePostDecrement(R aTarget) Decrement the value of this real then induce its original value into the specified target
<R extends Real<?>> R	inducePostIncrement(R aTarget) Increment the value of this real then induce its original value into the specified target
<R extends Real<?>> R	induceRealValue(R aTarget) Induce the current value of this real into the specified target

Method Detail

inducePostDecrement

<R extends Real<?>> R inducePostDecrement(R aTarget)
                                   throws NullPointerException,
                                          NoSuchElementException,
                                          UnsupportedOperationException,
                                          IllegalStateException

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

Type Parameters:

R - the target type

Parameters:

aTarget - a target into which the current value of this real 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

<R extends Real<?>> R inducePostIncrement(R aTarget)
                                   throws NullPointerException,
                                          NoSuchElementException,
                                          UnsupportedOperationException,
                                          IllegalStateException

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

Type Parameters:

R - the target type

Parameters:

aTarget - a target into which the current value of this real 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

induceRealValue

<R extends Real<?>> R induceRealValue(R aTarget)
                               throws NullPointerException,
                                      NoSuchElementException,
                                      UnsupportedOperationException,
                                      IllegalStateException

Induce the current value of this real into the specified target

Type Parameters:

R - the target type

Parameters:

aTarget - a target into which the current value of this real 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