net.sf.jaccumulator.texts

Interface TextInductor

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, Primitive<PRIMITIVE>, Text<TEXT>

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 TextInductor

Imparts text values into other text

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
<SCALAR extends Scalar<?>> SCALAR	induceTextSize(SCALAR aTarget) Induce the current value of this text into the scalar target
<TEXT extends Text<?>> TEXT	induceTextValue(TEXT aTarget) Induce the current value of this text into the specified target

Method Detail

induceTextSize

<SCALAR extends Scalar<?>> SCALAR induceTextSize(SCALAR aTarget)
                                     throws NullPointerException,
                                            NoSuchElementException,
                                            UnsupportedOperationException,
                                            IllegalStateException

Induce the current value of this text into the scalar target

Type Parameters:

SCALAR - the scalar target type

Parameters:

aTarget - a scalar target into which the current size of this text 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

induceTextValue

<TEXT extends Text<?>> TEXT induceTextValue(TEXT aTarget)
                                  throws NullPointerException,
                                         NoSuchElementException,
                                         UnsupportedOperationException,
                                         IllegalStateException

Induce the current value of this text into the specified target

Type Parameters:

TEXT - the target type

Parameters:

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