net.sf.jaccumulator.primitives

Interface PrimitiveInductor<PRIMITIVE extends PrimitiveInductor<PRIMITIVE>>

Type Parameters:

PRIMITIVE - this type (used to facilitate operation chaining)

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>

All Known Implementing Classes:

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

Imparts Primitive values into other Primitives

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
<P extends Primitive<?>> P	inducePostDecrement(P aTarget) Decrement the value of this Primitive then induce its original value into the specified target
<P extends Primitive<?>> P	inducePostIncrement(P aTarget) Increment the value of this Primitive then induce its original value into the specified target
<P extends Primitive<?>> P	inducePrimitiveMaximum(P aTarget) Induce the maximum numeric value of the Primitive into the specified target
<P extends Primitive<?>> P	inducePrimitiveMinimum(P aTarget) Induce the minimum numeric value of the Primitive into the specified target
<P extends Primitive<?>> P	inducePrimitiveValue(P aTarget) Induce the current value of this Primitive into the specified target

Method Detail

inducePostDecrement

<P extends Primitive<?>> P inducePostDecrement(P aTarget)
                                        throws NullPointerException,
                                               NoSuchElementException,
                                               UnsupportedOperationException,
                                               IllegalStateException

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

Type Parameters:

P - the target type

Parameters:

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

<P extends Primitive<?>> P inducePostIncrement(P aTarget)
                                        throws NullPointerException,
                                               NoSuchElementException,
                                               UnsupportedOperationException,
                                               IllegalStateException

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

Type Parameters:

P - the target type

Parameters:

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

inducePrimitiveMaximum

<P extends Primitive<?>> P inducePrimitiveMaximum(P aTarget)
                                           throws NullPointerException,
                                                  NoSuchElementException,
                                                  UnsupportedOperationException,
                                                  IllegalStateException

Induce the maximum numeric value of the Primitive into the specified target

Type Parameters:

P - the target type

Parameters:

aTarget - a target into which the maximum numeric value of the Primitive will be induced

Returns:

the target

Throws:

NullPointerException

NoSuchElementException

UnsupportedOperationException

IllegalStateException

inducePrimitiveMinimum

<P extends Primitive<?>> P inducePrimitiveMinimum(P aTarget)
                                           throws NullPointerException,
                                                  NoSuchElementException,
                                                  UnsupportedOperationException,
                                                  IllegalStateException

Induce the minimum numeric value of the Primitive into the specified target

Type Parameters:

P - the target type

Parameters:

aTarget - a target into which the minimum numeric value of the Primitive 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

inducePrimitiveValue

<P extends Primitive<?>> P inducePrimitiveValue(P aTarget)
                                         throws NullPointerException,
                                                NoSuchElementException,
                                                UnsupportedOperationException,
                                                IllegalStateException

Induce the current value of this Primitive into the specified target

Type Parameters:

P - the target type

Parameters:

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