net.sf.jaccumulator

Class AbstractAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

java.lang.Object

java.lang.Number

net.sf.jaccumulator.scalars.AbstractScalar<REAL>

net.sf.jaccumulator.reals.AbstractReal<PRIMITIVE>

net.sf.jaccumulator.primitives.AbstractPrimitive<PRIMITIVE>

net.sf.jaccumulator.primitives.AbstractPrimitiveWrapper<ACCUMULATOR>

net.sf.jaccumulator.AbstractAccumulator<ACCUMULATOR>

Type Parameters:

ACCUMULATOR - this Accumulator type

All Implemented Interfaces:

Serializable, Appendable, CharSequence, Comparable<SealedPrimitive<?>>, Iterable<Accumulator<?>>, Accumulator<ACCUMULATOR>, AccumulatorReplicator<ACCUMULATOR>, AlgebraicStructure<ACCUMULATOR>, BooleanValue<ACCUMULATOR>, MutableBooleanValue<ACCUMULATOR>, SealedBooleanValue, ByteValue<ACCUMULATOR>, MutableByteValue<ACCUMULATOR>, SealedByteValue, CharacterValue<ACCUMULATOR>, MutableCharacterValue<ACCUMULATOR>, SealedCharacterValue, DoubleValue<ACCUMULATOR>, MutableDoubleValue<ACCUMULATOR>, SealedDoubleValue, FloatValue<ACCUMULATOR>, MutableFloatValue<ACCUMULATOR>, SealedFloatValue, IntegerValue<ACCUMULATOR>, MutableIntegerValue<ACCUMULATOR>, SealedIntegerValue, LongValue<ACCUMULATOR>, MutableLongValue<ACCUMULATOR>, SealedLongValue, Mutable, MutableAccumulator<ACCUMULATOR>, MutableAlgebraicStructure<ACCUMULATOR>, MutableKernel<ACCUMULATOR>, MutablePrimitive<ACCUMULATOR>, Primitive<ACCUMULATOR>, PrimitiveInductor<ACCUMULATOR>, PrimitiveReplicator<ACCUMULATOR>, SealedPrimitive<ACCUMULATOR>, MutableReal<ACCUMULATOR>, MutableRealDomain<ACCUMULATOR>, Real<ACCUMULATOR>, RealDomain<ACCUMULATOR>, RealInductor<ACCUMULATOR>, RealReplicator<ACCUMULATOR>, SealedReal<ACCUMULATOR>, SealedRealBag, SealedRealDomain, Replicator<ACCUMULATOR>, CharacterProperties, MutableScalar<ACCUMULATOR>, MutableScalarDomain<ACCUMULATOR>, NumericProperties, Scalar<ACCUMULATOR>, ScalarDomain<ACCUMULATOR>, ScalarInductor<ACCUMULATOR>, ScalarReplicator<ACCUMULATOR>, SealedScalar<ACCUMULATOR>, SealedScalarBag, SealedScalarDomain, SealedAccumulator<ACCUMULATOR>, SealedAlgebraicStructure, SealedKernel, MutableShortValue<ACCUMULATOR>, SealedShortValue, ShortValue<ACCUMULATOR>, StructureProperties, MutableText<ACCUMULATOR>, MutableTextValue<ACCUMULATOR>, SealedText<ACCUMULATOR>, SealedTextValue, Text<ACCUMULATOR>, TextInductor, TextProperties, TextReplicator<ACCUMULATOR>, TextValue<ACCUMULATOR>, MutableUnlimitedDecimalValue<ACCUMULATOR>, MutableUnlimitedIntegerValue<ACCUMULATOR>, SealedUnlimitedDecimalValue, SealedUnlimitedIntegerValue, UnlimitedDecimalValue<ACCUMULATOR>, UnlimitedIntegerValue<ACCUMULATOR>

Direct Known Subclasses:

AbstractSimpleAccumulator, AbstractStickyTarget

public abstract class AbstractAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>
extends AbstractPrimitiveWrapper<ACCUMULATOR>
implements Accumulator<ACCUMULATOR>

Common Accumulator behavior

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (nicole@tedesco.name)

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.jaccumulator.scalars.AbstractScalar

NaN, ONEI, ZERO_DOUBLE_LONG_BITS, ZERO_FLOAT_INT_BITS, ZEROI

Constructor Summary

Constructors

Constructor and Description
AbstractAccumulator()
AbstractAccumulator(Accumulator<?> anAccumulator)
AbstractAccumulator(net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>> members)

Method Summary

Methods

Modifier and Type	Method and Description
ControlIntention	apply(Accumulator<?> aStack) Apply this Accumulator's association function to the specified Accumulator, using it as a parameter and result stack
void	clear() Same as Collection.clear().
ACCUMULATOR	clearContents() Clear all elements of this structure and answer this object (facilitates chaining}. For text primitives all characters will be removed in an exact analog to clear().
ACCUMULATOR	copy() Produce a replica of this object
ACCUMULATOR	copySharing(Accumulator<?> anAccumulator) Using this Accumulator as a factory, and where possible, produce a new Accumulator of the same type but directly sharing the target Primitive and its relationship collection.
ACCUMULATOR	copySharing(net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>> members) Using this Accumulator as a factory, and where possible, produce a new Accumulator of the same type but directly share the specified relationship collection.
ACCUMULATOR	copySharing(Primitive<?> aTarget) Using this Accumulator as a factory, and where possible, produce a new Accumulator of the same type but directly share the specified Primitive target.
ACCUMULATOR	copyUsing(BigDecimal aValue) Using this real as a factory, produce a new real of the same type but initialized with the value specified
ACCUMULATOR	copyUsing(BigInteger aValue) Using this real as a factory, produce a new real of the same type but initialized with the value specified
ACCUMULATOR	copyUsing(boolean aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(byte aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(char aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(double aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(float aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(int aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(long aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsing(short aValue) Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified
ACCUMULATOR	copyUsingAccumulator(SealedAccumulator<?> anAccumulator) Using this Accumulator as a factory, produce a new Accumulator of the same type but initialized with the target Primitive and a shallow copy of the members of the specified Accumulator
ACCUMULATOR	copyUsingPrimitive(SealedPrimitive<?> aValue) Using this primitive as a factory, produce a new primitive of the same type but initialized with the value specified
ACCUMULATOR	copyUsingReal(SealedReal<?> aValue) Using this real as a factory, produce a new real of the same type but initialized with the value specified
ACCUMULATOR	copyUsingScalar(SealedScalar<?> aValue) Using this scalar as a factory, produce a new scalar of the same type but initialized with the value specified
ACCUMULATOR	copyUsingText(CharSequence aValue) Using this text as a factory, produce new text of the same type but initialized with the value specified
boolean	equals(Object anObject)
Accumulator<?>	first() A convenience function to return the first, or zeroth, relationship in this Accumulator's #members() collection
Domain	getDomain()
StructureStrategy	getStructureStrategy()
int	hashCode()
boolean	isConfigurable() Answer true if the implementation of this object can be changed. A configurable object has a structure that can be expanded, or reduced, or has replaceable components.
boolean	isCountable() Answer true if this structure contains a countable number of elements.
boolean	isElastic() Answer true if this structure, in principle, can be reduced via element removal or expanded via element addition.
boolean	isEmpty() Answer true if this structure contains no elements.
boolean	isEqualToAccumulator(SealedAccumulator<?> anAccumulator) Compare this Accumulator for equality against another.
boolean	isExpandable()
boolean	isOrdered() Answer true if the elements of this structure necessarily share a partial or total order between each other within the context of this structure.
boolean	isReducible() Answer true if this structure, in principle, can be reduced via element removal.
boolean	isUnique()
Iterator<Accumulator<?>>	iterator()
Accumulator<?>	last() A convenience function to return the last, or highest order, relationship in this Accumulator's #members() collection
long	longSize() Returns the number of elements in this algebraic structure as a long scalar.
net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>>	members()
Accumulator<?>	peek() A convenience alias for SealedAccumulator.last()
Accumulator<?>	pop() Remove and return the last (highest order) member from this Accumulator's relationship collection
ACCUMULATOR	push(Accumulator<?> aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(Accumulator<?> aKey, Accumulator<?> aMember) A convenience function to append a new keyed (named) member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(BigDecimal aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(BigInteger aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(boolean aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(byte aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(char aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(double aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(float aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(int aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(long aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(short aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	push(String aKey, Accumulator<?> aMember) A convenience function to append a new keyed (named) member to the end of this Accumulator's relationship collection
ACCUMULATOR	pushPrimitive(Primitive<?> aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	pushText(CharSequence aMember) A convenience function to append a new member to the end of this Accumulator's relationship collection
ACCUMULATOR	replaceRelationshipsUsing(Accumulator<?> anAccumulator) Attempt to change this Accumulator's relationships to the relationships of the specified Accumulator (shallow copy)
ACCUMULATOR	setAccumulator(Accumulator<?> anAccumulator) Attempt to share the target of the specified Accumulator with this Accumulator, and also mirror this Accumulator's relationships to the relationship map of the specified Accumulator.
ACCUMULATOR	shareTargetWith(Accumulator<?> anAccumulator) Attempt to share the specified Accumulator's Primitive target with this Accumulator, or, if this Accumulator's target could not be replaced, attempt to change the current target's value
int	size() Returns the number of elements in this algebraic structure.
Accumulator<?>	toAccumulator() If this object is already Accumulator then simply call its AccumulatorReplicator.copy() function, otherwise convert it to a new Accumulator instance
String	toFunctionName() Answer the name of the function associated with this Accumulator type
String	toString()

Methods inherited from class net.sf.jaccumulator.primitives.AbstractPrimitiveWrapper

absoluteValue, and, and, and, and, and, and, and, angleWith, append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, arcCosine, arcSine, arcTangent, assertDomain, assertPrecision, base10Log, booleanPostDecrement, booleanPostIncrement, booleanValue, bytePostDecrement, bytePostIncrement, byteValue, charAt, charPostDecrement, charPostIncrement, charValue, clearText, codePointAt, codePointBefore, codePointCount, compareTo, compareToPrimitive, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToText, compareToZero, cosine, cube, cubeRoot, decrement, degrees, delete, deleteCharAt, difference, difference, difference, difference, difference, difference, difference, difference, difference, difference, doublePostDecrement, doublePostIncrement, doubleValue, exponential, exponentialLessOne, floatPostDecrement, floatPostIncrement, floatValue, gcd, gcd, gcd, gcd, gcd, gcd, getConcurrency, getPrecision, getTarget, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, increment, indexOfText, indexOfText, inducePostDecrement, inducePostDecrement, inducePostDecrement, inducePostIncrement, inducePostIncrement, inducePostIncrement, inducePrimitiveMaximum, inducePrimitiveMinimum, inducePrimitiveValue, induceRealMaximum, induceRealMinimum, induceRealSize, induceRealValue, induceScalarMaximum, induceScalarMinimum, induceScalarSize, induceScalarValue, induceTextSize, induceTextValue, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, intPostDecrement, intPostIncrement, intValue, invalidate, inverse, isAlphabetic, isBmpCodePoint, isDigit, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToPrimitive, isEqualToText, isFinite, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToPrimitive, isGreaterOrEqualToText, isGreaterThanPrimitive, isGreaterThanText, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isImaginary, isInfinity, isInvalid, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToPrimitive, isLessOrEqualToText, isLessThanPrimitive, isLessThanText, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMaximum, isMinimum, isMirrored, isModulo, isMutable, isNegative, isNegativeFinite, isNegativeInfinity, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToPrimitive, isNotEqualToText, isPositive, isPositiveFinite, isPositiveInfinity, isReal, isSupplementaryCodePoint, isSurrogate, isText, isTitleCase, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUnity, isUpperCase, isValidCodePoint, isWhitespace, isZero, length, longPostDecrement, longPostIncrement, longValue, lowerCase, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, mod, mod, nanoseconds, naturalLog, naturalLogPlusOne, negate, not, or, or, or, or, or, or, or, power, power, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, product, product, product, product, product, product, product, product, product, product, promoteTo, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, radians, random, replace, replace, replaceAll, replaceCharacter, replaceFirst, reverse, round, setBoolean, setCharacter, setCharAt, setE, setEnumeration, setFalse, setLength, setMaximum, setMinimum, setNegativeInfinity, setPi, setPositiveInfinity, setPrimitive, setReal, setReal, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setScalar, setText, setTrue, setUnity, setZero, shiftLeft, shiftRight, shiftRightExtendZero, shortPostDecrement, shortPostIncrement, shortValue, signum, sine, square, squareRoot, subSequence, substring, substring, sum, sum, sum, sum, sum, sum, sum, sum, sum, sum, swapPrimitives, tangent, textPostDecrement, textPostIncrement, titleCase, toBoolean, toCharacter, toCodePoint, toEnumeration, toNumber, toPrimitive, toReal, toScalar, toUnlimitedDecimal, toUnlimitedInteger, trim, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement, upperCase, xor, xor, xor, xor, xor, xor, xor

Methods inherited from class net.sf.jaccumulator.primitives.AbstractPrimitive

andOfPrimitive, angleWithPrimitive, differenceOfPrimitive, hypotenuseWithPrimitive, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, sumOfPrimitive, xorOfPrimitive

Methods inherited from class net.sf.jaccumulator.reals.AbstractReal

andOfNumber, andOfReal, angleWithReal, compareToNumber, compareToReal, compareToReal, compareToReal, differenceOfNumber, differenceOfReal, gcdOfNumber, gcdOfReal, hypotenuseWithReal, isEqualToNumber, isEqualToReal, isGreaterOrEqualToNumber, isGreaterOrEqualToReal, isGreaterThanNumber, isGreaterThanReal, isLessOrEqualToNumber, isLessOrEqualToReal, isLessThanNumber, isLessThanReal, isNotEqualToNumber, isNotEqualToReal, modOfNumber, modOfReal, orOfNumber, orOfReal, powerOfReal, productOfNumber, productOfReal, quotientOfNumber, quotientOfReal, setNumber, setReal, sumOfNumber, sumOfReal, unlimitedIntegerModularInverse, xorOfNumber, xorOfReal

Methods inherited from class net.sf.jaccumulator.scalars.AbstractScalar

andOfScalar, angleWithNumber, angleWithScalar, boundsCheck, byteMaskAt, byteNotMaskAt, byteValue, ceiling, charMaskAt, charNotMaskAt, charValue, clearByteBitAt, clearCharBitAt, clearDoubleBitAt, clearFloatBitAt, clearIntBitAt, clearLongBitAt, clearShortBitAt, clearUnlimitedDecimalBitAt, clearUnlimitedIntegerBitAt, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareTo, compareToScalar, differenceOfScalar, divideByZero, down, floor, gcdOfScalar, getBooleanBitAt, getByteBitAt, getCharBitAt, getDoubleBitAt, getFloatBitAt, getIntBitAt, getLongBitAt, getShortBitAt, getUnlimitedDecimalBitAt, getUnlimitedIntegerBitAt, halfDown, halfEven, halfUp, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hashCode, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, indexOutOfBoundsAt, intGCD, intMaskAt, intModularInverse, intModularQuotient, intNotMaskAt, intValue, isEqualToScalar, isFalse, isGreaterOrEqualToScalar, isGreaterThanScalar, isLessOrEqualToScalar, isLessThanScalar, isNotEqualToScalar, isTrue, isValid, longGCD, longMaskAt, longModularInverse, longModularQuotient, longNotMaskAt, longValue, modOfScalar, orOfScalar, powerOfNumber, powerOfScalar, productOfScalar, quotientOfScalar, setByteBitAt, setCharBitAt, setDoubleBitAt, setFloatBitAt, setIntBitAt, setLongBitAt, setShortBitAt, setUnlimitedDecimalBitAt, setUnlimitedIntegerBitAt, shortMaskAt, shortNotMaskAt, shortValue, sumOfScalar, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toBooleanArray, toByteArray, toUnlimitedInteger, unlimitedIntegerMaskAt, unlimitedIntegerNotMaskAt, up, xorOfScalar

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.jaccumulator.SealedAccumulator

getTarget, isTargetReplaceable

Methods inherited from interface net.sf.jaccumulator.AccumulatorReplicator

copySharing

Methods inherited from interface net.sf.jaccumulator.MutableAccumulator

shareTarget

Methods inherited from interface net.sf.jaccumulator.primitives.Primitive

swapPrimitives

Methods inherited from interface net.sf.jaccumulator.primitives.PrimitiveInductor

inducePostDecrement, inducePostIncrement, inducePrimitiveMaximum, inducePrimitiveMinimum, inducePrimitiveValue

Methods inherited from interface net.sf.jaccumulator.primitives.SealedPrimitive

compareToPrimitive, isEqualToPrimitive, isGreaterOrEqualToPrimitive, isGreaterThanPrimitive, isLessOrEqualToPrimitive, isLessThanPrimitive, isNotEqualToPrimitive

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.sf.jaccumulator.primitives.PrimitiveReplicator

toPrimitive

Methods inherited from interface net.sf.jaccumulator.primitives.MutablePrimitive

andOfPrimitive, angleWithPrimitive, differenceOfPrimitive, hypotenuseWithPrimitive, modOfPrimitive, orOfPrimitive, powerOfPrimitive, productOfPrimitive, quotientOfPrimitive, setBoolean, setCharacter, setPrimitive, sumOfPrimitive, xorOfPrimitive

Methods inherited from interface net.sf.jaccumulator.reals.RealInductor

inducePostDecrement, inducePostIncrement, induceRealValue

Methods inherited from interface net.sf.jaccumulator.scalars.ScalarInductor

inducePostDecrement, inducePostIncrement, induceScalarValue

Methods inherited from interface net.sf.jaccumulator.reals.SealedReal

compareToReal, compareToReal, compareToReal, isEqual, isEqual, isEqualToReal, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToReal, isGreaterThanReal, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqualToReal, isLessThanReal, isNotEqual, isNotEqual, isNotEqualToReal

Methods inherited from interface net.sf.jaccumulator.scalars.SealedScalar

compareToNumber, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToScalar, compareToZero, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqual, isEqualToNumber, isEqualToScalar, isFalse, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreater, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqual, isGreaterOrEqualToNumber, isGreaterOrEqualToScalar, isGreaterThanNumber, isGreaterThanScalar, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLess, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqual, isLessOrEqualToNumber, isLessOrEqualToScalar, isLessThanNumber, isLessThanScalar, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqual, isNotEqualToNumber, isNotEqualToScalar, isTrue, toBoolean, toCharacter, toCodePoint, toEnumeration, toNumber

Methods inherited from interface net.sf.jaccumulator.SealedKernel

getConcurrency

Methods inherited from interface net.sf.jaccumulator.scalars.NumericProperties

isFinite, isImaginary, isInfinity, isInvalid, isMaximum, isMinimum, isModulo, isNegative, isNegativeFinite, isNegativeInfinity, isPositive, isPositiveFinite, isPositiveInfinity, isReal, isUnity, isValid, isZero, signum

Methods inherited from interface net.sf.jaccumulator.scalars.CharacterProperties

isAlphabetic, isBmpCodePoint, isDigit, isHighSurrogate, isIdentifierIgnorable, isIdeographic, isISOControl, isJavaIdentifierPart, isJavaIdentifierStart, isLetter, isLetterOrDigit, isLowerCase, isLowSurrogate, isMirrored, isSupplementaryCodePoint, isSurrogate, isTitleCase, isUnicode, isUnicodeIdentifierPart, isUnicodeIdentifierStart, isUpperCase, isValidCodePoint, isWhitespace

Methods inherited from interface net.sf.jaccumulator.booleans.SealedBooleanValue

booleanValue

Methods inherited from interface net.sf.jaccumulator.bytes.SealedByteValue

byteValue

Methods inherited from interface net.sf.jaccumulator.characters.SealedCharacterValue

charValue

Methods inherited from interface net.sf.jaccumulator.doubles.SealedDoubleValue

doubleValue

Methods inherited from interface net.sf.jaccumulator.floats.SealedFloatValue

floatValue

Methods inherited from interface net.sf.jaccumulator.integers.SealedIntegerValue

intValue

Methods inherited from interface net.sf.jaccumulator.longs.SealedLongValue

longValue

Methods inherited from interface net.sf.jaccumulator.shorts.SealedShortValue

shortValue

Methods inherited from interface net.sf.jaccumulator.reals.SealedRealDomain

induceRealMaximum, induceRealMinimum

Methods inherited from interface net.sf.jaccumulator.scalars.SealedScalarDomain

getPrecision, induceScalarMaximum, induceScalarMinimum

Methods inherited from interface net.sf.jaccumulator.reals.SealedRealBag

induceRealSize

Methods inherited from interface net.sf.jaccumulator.scalars.SealedScalarBag

induceScalarSize

Methods inherited from interface net.sf.jaccumulator.reals.RealReplicator

toReal

Methods inherited from interface net.sf.jaccumulator.scalars.ScalarReplicator

toScalar

Methods inherited from interface net.sf.jaccumulator.reals.MutableReal

and, andOfReal, angleWithReal, difference, difference, differenceOfReal, gcd, gcdOfReal, hypotenuseWithReal, mod, mod, modOfReal, or, orOfReal, powerOfReal, product, product, productOfReal, quotient, quotient, quotientOfReal, setReal, sum, sum, sumOfReal, xor, xorOfReal

Methods inherited from interface net.sf.jaccumulator.scalars.MutableScalar

absoluteValue, and, and, and, and, and, and, andOfNumber, andOfScalar, angleWith, angleWithNumber, angleWithScalar, arcCosine, arcSine, arcTangent, base10Log, ceiling, cosine, cube, cubeRoot, decrement, degrees, difference, difference, difference, difference, difference, difference, difference, difference, differenceOfNumber, differenceOfScalar, down, exponential, exponentialLessOne, floor, gcd, gcd, gcd, gcd, gcd, gcdOfNumber, gcdOfScalar, halfDown, halfEven, halfUp, hyperbolicCosine, hyperbolicSine, hyperbolicTangent, hypotenuseWith, hypotenuseWithNumber, hypotenuseWithScalar, increment, invalidate, inverse, milliseconds, mod, mod, mod, mod, mod, mod, mod, mod, modOfNumber, modOfScalar, nanoseconds, naturalLog, naturalLogPlusOne, negate, not, or, or, or, or, or, or, orOfNumber, orOfScalar, power, power, powerOfNumber, powerOfScalar, product, product, product, product, product, product, product, product, productOfNumber, productOfScalar, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotient, quotientOfNumber, quotientOfScalar, radians, random, round, setE, setEnumeration, setMaximum, setMinimum, setNegativeInfinity, setNumber, setPi, setPositiveInfinity, setScalar, setUnity, setZero, shiftLeft, shiftRight, shiftRightExtendZero, sine, square, squareRoot, sum, sum, sum, sum, sum, sum, sum, sum, sumOfNumber, sumOfScalar, tangent, up, xor, xor, xor, xor, xor, xor, xorOfNumber, xorOfScalar

Methods inherited from interface net.sf.jaccumulator.booleans.MutableBooleanValue

booleanPostDecrement, booleanPostIncrement, setFalse, setScalar, setTrue

Methods inherited from interface net.sf.jaccumulator.bytes.MutableByteValue

bytePostDecrement, bytePostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.characters.MutableCharacterValue

charPostDecrement, charPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.doubles.MutableDoubleValue

doublePostDecrement, doublePostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.floats.MutableFloatValue

floatPostDecrement, floatPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.integers.MutableIntegerValue

intPostDecrement, intPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.longs.MutableLongValue

longPostDecrement, longPostIncrement, setScalar

Methods inherited from interface net.sf.jaccumulator.shorts.MutableShortValue

setScalar, shortPostDecrement, shortPostIncrement

Methods inherited from interface net.sf.jaccumulator.scalars.MutableScalarDomain

assertPrecision, promoteTo

Methods inherited from interface net.sf.jaccumulator.MutableAlgebraicStructure

assertDomain

Methods inherited from interface net.sf.jaccumulator.Mutable

isMutable

Methods inherited from interface net.sf.jaccumulator.unlimiteds.SealedUnlimitedIntegerValue

toUnlimitedInteger

Methods inherited from interface net.sf.jaccumulator.unlimiteds.MutableUnlimitedIntegerValue

setReal, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement

Methods inherited from interface net.sf.jaccumulator.unlimiteds.SealedUnlimitedDecimalValue

toUnlimitedDecimal

Methods inherited from interface net.sf.jaccumulator.unlimiteds.MutableUnlimitedDecimalValue

setReal, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement

Methods inherited from interface net.sf.jaccumulator.texts.TextInductor

induceTextSize, induceTextValue

Methods inherited from interface net.sf.jaccumulator.texts.SealedText

compareToText, isEqualToText, isGreaterOrEqualToText, isGreaterThanText, isLessOrEqualToText, isLessThanText, isNotEqualToText

Methods inherited from interface net.sf.jaccumulator.texts.SealedTextValue

codePointAt, codePointBefore, codePointCount, indexOfText, indexOfText, substring, substring

Methods inherited from interface java.lang.CharSequence

charAt, length, subSequence

Methods inherited from interface net.sf.jaccumulator.texts.TextProperties

isText

Methods inherited from interface net.sf.jaccumulator.texts.MutableTextValue

append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, clearText, delete, deleteCharAt, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, lowerCase, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, prepend, replace, replace, replaceAll, replaceCharacter, replaceFirst, reverse, setCharAt, setLength, setText, textPostDecrement, textPostIncrement, titleCase, trim, upperCase

Constructor Detail

AbstractAccumulator

public AbstractAccumulator()

AbstractAccumulator

public AbstractAccumulator(Accumulator<?> anAccumulator)

AbstractAccumulator

public AbstractAccumulator(net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>> members)

Method Detail

apply

public ControlIntention apply(Accumulator<?> aStack)

Description copied from interface: Accumulator

Apply this Accumulator's association function to the specified Accumulator, using it as a parameter and result stack

Specified by:

apply in interface Accumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aStack - a parameter and result stack

Returns:

the next suggested action to be taken by the caller

clear

public void clear()
           throws UnsupportedOperationException

Description copied from interface: MutableTextValue

Same as Collection.clear(). So as to maintain compatibility, this function will not return the customary reference back to this primitive. In text primitives, this function will clear the current text contents

Specified by:

clear in interface MutableAlgebraicStructure<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Specified by:

clear in interface MutableTextValue<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Overrides:

clear in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Throws:

UnsupportedOperationException - if this text cannot be cleared

See Also:

MutableTextValue.clearText();, Collection.clear(), MutableAlgebraicStructure.clearContents()

clearContents

public ACCUMULATOR clearContents()
                                                           throws UnsupportedOperationException

Description copied from interface: MutableAlgebraicStructure

Clear all elements of this structure and answer this object (facilitates chaining}.

For text primitives all characters will be removed in an exact analog to clear(). For bit tuples such as scalar primitives, this will reset all bits zero since those elements cannot be removed. For unlimited primitives all bytes in the representation will be removed, producing zero.

Primarily, this function is provided as an alternative to clear(), which does not return a value. This function, in answering this object, facilitates operation chaining.

Specified by:

clearContents in interface MutableAlgebraicStructure<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Overrides:

clearContents in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

See Also:

MutableAlgebraicStructure.clear(), Collection.clear(), MutableTextValue.clearText();

copy

public ACCUMULATOR copy()

Description copied from interface: Replicator

Produce a replica of this object

Specified by:

copy in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Specified by:

copy in interface Replicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

a replica of this object

copySharing

public ACCUMULATOR copySharing(Accumulator<?> anAccumulator)

Description copied from interface: AccumulatorReplicator

Using this Accumulator as a factory, and where possible, produce a new Accumulator of the same type but directly sharing the target Primitive and its relationship collection. Where direct sharing is not possible, shallow copies will be performed instead.

Specified by:

copySharing in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

anAccumulator - an Accumulator to share with

Returns:

a copy of this Accumulator that directly shares the target Primitive and and its relationship collection

copySharing

public ACCUMULATOR copySharing(net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>> members)

Description copied from interface: AccumulatorReplicator

Using this Accumulator as a factory, and where possible, produce a new Accumulator of the same type but directly share the specified relationship collection. Where direct sharing is not possible, shallow copies will be performed instead.

Specified by:

copySharing in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

members - the relationship collection to share

Returns:

a copy of this Accumulator that directly shares the specified relationship collection

copySharing

public ACCUMULATOR copySharing(Primitive<?> aTarget)

Description copied from interface: AccumulatorReplicator

Using this Accumulator as a factory, and where possible, produce a new Accumulator of the same type but directly share the specified Primitive target. Where direct sharing is not possible, shallow copies will be performed instead.

Specified by:

copySharing in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

a copy of this Accumulator that directly shares the specified Primitive target

copyUsing

public ACCUMULATOR copyUsing(BigDecimal aValue)

Description copied from interface: RealReplicator

Using this real as a factory, produce a new real of the same type but initialized with the value specified

Specified by:

copyUsing in interface RealReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this real initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(BigInteger aValue)

Description copied from interface: RealReplicator

Using this real as a factory, produce a new real of the same type but initialized with the value specified

Specified by:

copyUsing in interface RealReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this real initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(boolean aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(byte aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(char aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(double aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(float aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(int aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(long aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsing

public ACCUMULATOR copyUsing(short aValue)

Description copied from interface: ScalarReplicator

Using this object as a factory, produce a new scalar of an appropriately matching type but initialized with the value specified

Specified by:

copyUsing in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsingAccumulator

public ACCUMULATOR copyUsingAccumulator(SealedAccumulator<?> anAccumulator)

Description copied from interface: AccumulatorReplicator

Using this Accumulator as a factory, produce a new Accumulator of the same type but initialized with the target Primitive and a shallow copy of the members of the specified Accumulator

Specified by:

copyUsingAccumulator in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

anAccumulator - an Accumulator to copy from

Returns:

a copy of this Accumulator initialized using the target Primitive and a shallow copy of the members of the specified Accumulator

copyUsingPrimitive

public ACCUMULATOR copyUsingPrimitive(SealedPrimitive<?> aValue)

Description copied from interface: PrimitiveReplicator

Using this primitive as a factory, produce a new primitive of the same type but initialized with the value specified

Specified by:

copyUsingPrimitive in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Specified by:

copyUsingPrimitive in interface PrimitiveReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this primitive initialized using the specified value

copyUsingReal

public ACCUMULATOR copyUsingReal(SealedReal<?> aValue)

Description copied from interface: RealReplicator

Using this real as a factory, produce a new real of the same type but initialized with the value specified

Specified by:

copyUsingReal in interface RealReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this real initialized using the specified value

copyUsingScalar

public ACCUMULATOR copyUsingScalar(SealedScalar<?> aValue)

Description copied from interface: ScalarReplicator

Using this scalar as a factory, produce a new scalar of the same type but initialized with the value specified

Specified by:

copyUsingScalar in interface ScalarReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this scalar initialized using the specified value

copyUsingText

public ACCUMULATOR copyUsingText(CharSequence aValue)

Description copied from interface: TextReplicator

Using this text as a factory, produce new text of the same type but initialized with the value specified

Specified by:

copyUsingText in interface PrimitiveReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Specified by:

copyUsingText in interface TextReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aValue - a new value

Returns:

a copy (clone) of this text initialized using the specified value

equals

public boolean equals(Object anObject)

Specified by:

equals in interface SealedKernel

Overrides:

equals in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

first

public Accumulator<?> first()
                     throws NoSuchElementException

Description copied from interface: SealedAccumulator

A convenience function to return the first, or zeroth, relationship in this Accumulator's #members() collection

Specified by:

first in interface SealedAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the first, or zeroth, relationship in this Accumulator's #members() collection

Throws:

NoSuchElementException - this Accumulator's relationship collection was empty

getDomain

public Domain getDomain()

Specified by:

getDomain in interface SealedAlgebraicStructure

Overrides:

getDomain in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the general semantic interpretation strategy of the configuration of elements in this structure

getStructureStrategy

public StructureStrategy getStructureStrategy()

Specified by:

getStructureStrategy in interface SealedAlgebraicStructure

Overrides:

getStructureStrategy in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

a lemma defining the general implementation approach for this structure

hashCode

public int hashCode()

Specified by:

hashCode in interface SealedKernel

Overrides:

hashCode in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

isConfigurable

public boolean isConfigurable()

Description copied from interface: StructureProperties

Answer true if the implementation of this object can be changed.

A configurable object has a structure that can be expanded, or reduced, or has replaceable components. Configurable structures are necessarily mutable; in fact, "configurability" can be used as a strict definition of mutability. This predicate however overrides #isMutable in the respect that, for some types of objects such as Variants, mutability can be changed by switching from a non-mutable implementation to a mutable one (e.g., via assertPrecision).

Specified by:

isConfigurable in interface StructureProperties

Overrides:

isConfigurable in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if the implementation of this object can be changed

isCountable

public boolean isCountable()

Description copied from interface: StructureProperties

Answer true if this structure contains a countable number of elements. A countable set is a set with the same cardinality as some subset of the set of natural numbers. A set that is not countable contains an infinite number of elements.

Specified by:

isCountable in interface StructureProperties

Overrides:

isCountable in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if this structure contains a countable number of elements, otherwise false if it contains an infinite number of elements

See Also:

Countable set (Wikipedia)

isElastic

public boolean isElastic()

Description copied from interface: StructureProperties

Answer true if this structure, in principle, can be reduced via element removal or expanded via element addition. Empty collections are, in principle, reducible, but read-only collections are neither reducible or expandable.

Specified by:

isElastic in interface StructureProperties

Overrides:

isElastic in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if this structure can be either reduced or expanded

isEmpty

public boolean isEmpty()

Description copied from interface: StructureProperties

Answer true if this structure contains no elements. For strings this would indicate an empty string (no characters in an empty array). For scalars this would indicate an empty set, or a zero bit count, which would be the case of null values. Note that, although the null constant technically contains zero elements, its string value evaluates to "null", which from a String perspective is not empty.

Specified by:

isEmpty in interface StructureProperties

Specified by:

isEmpty in interface TextProperties

Overrides:

isEmpty in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if this structure contains no elements

isEqualToAccumulator

public boolean isEqualToAccumulator(SealedAccumulator<?> anAccumulator)

Description copied from interface: SealedAccumulator

Compare this Accumulator for equality against another. Two Accumulators are equal if the values of their target Primitives are equal, and the contents of their members collections are equal.

Specified by:

isEqualToAccumulator in interface SealedAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if the values of this Accumulator's target Primitive if equal to the target Primitive of the specified Accumulator, and if the content of the members collections are both equal

isExpandable

public boolean isExpandable()

Specified by:

isExpandable in interface StructureProperties

Overrides:

isExpandable in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if this structure can be expanded via element insertion

isOrdered

public boolean isOrdered()

Description copied from interface: StructureProperties

Answer true if the elements of this structure necessarily share a partial or total order between each other within the context of this structure. Ordering does not necessarily imply a simple sequencing between randomly selected elements, but rather a necessary sorting order between elements independent of the sets they are related by. A SortedSet is ordered, not merely because its elements are de facto sorted, but because the SortedSet defines a universe in which only sortable elements can exist and it defines a sorting function which places those elements in their sorted order at the time of iteration. An ordered set has elements with values that are reflexive, antisymmetric, and transitive relative to each other. Necessarily empty sets are not considered ordered.

Specified by:

isOrdered in interface StructureProperties

Overrides:

isOrdered in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if the structure has either a partial or total order over its elements

See Also:

order theory (Wikipedia)

isReducible

public boolean isReducible()

Description copied from interface: StructureProperties

Answer true if this structure, in principle, can be reduced via element removal. Empty collections are, in principle, reducible, but read-only collections are not.

Specified by:

isReducible in interface StructureProperties

Overrides:

isReducible in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if this structure, in principle, can be reduced via element removal

isUnique

public boolean isUnique()

Specified by:

isUnique in interface StructureProperties

Overrides:

isUnique in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

true if the elements in this structure are, by definition of the structure's algebra, unique (e.g., sets)

iterator

public Iterator<Accumulator<?>> iterator()

Specified by:

iterator in interface Iterable<Accumulator<?>>

last

public Accumulator<?> last()
                    throws NoSuchElementException

Description copied from interface: SealedAccumulator

A convenience function to return the last, or highest order, relationship in this Accumulator's #members() collection

Specified by:

last in interface SealedAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the last, or highest order, relationship in this Accumulator's #members() collection

Throws:

NoSuchElementException - this Accumulator's relationship collection was empty

longSize

public long longSize()

Description copied from interface: SealedAlgebraicStructure

Returns the number of elements in this algebraic structure as a long scalar. If the structure contains more than Long.MAX_VALUE elements, returns Long.MAX_VALUE.

Specified by:

longSize in interface SealedAlgebraicStructure

Overrides:

longSize in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the number of elements in this algebraic structure as a long scalar

See Also:

Collection.size(), SealedAlgebraicStructure.size()

members

public final net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>> members()

Specified by:

members in interface SealedAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the relationship collection

peek

public Accumulator<?> peek()
                    throws NoSuchElementException

Description copied from interface: SealedAccumulator

A convenience alias for SealedAccumulator.last()

Specified by:

peek in interface SealedAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the last, or highest order, relationship in this Accumulator's #members() collection

Throws:

NoSuchElementException - this Accumulator's relationship collection was empty

pop

public Accumulator<?> pop()
                   throws UnsupportedOperationException,
                          IllegalStateException,
                          NoSuchElementException

Description copied from interface: MutableAccumulator

Remove and return the last (highest order) member from this Accumulator's relationship collection

Specified by:

pop in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not changed

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

NoSuchElementException - this Accumulator's relationship collection was empty

push

public ACCUMULATOR push(Accumulator<?> aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(Accumulator<?> aKey,
               Accumulator<?> aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new keyed (named) member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aKey - a new key (name)

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(BigDecimal aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(BigInteger aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(boolean aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(byte aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(char aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(double aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(float aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(int aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(long aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(short aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

push

public ACCUMULATOR push(String aKey,
               Accumulator<?> aMember)
                                                  throws UnsupportedOperationException,
                                                         NullPointerException,
                                                         IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new keyed (named) member to the end of this Accumulator's relationship collection

Specified by:

push in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aKey - a new key (name)

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

pushPrimitive

public ACCUMULATOR pushPrimitive(Primitive<?> aMember)
                                                           throws UnsupportedOperationException,
                                                                  NullPointerException,
                                                                  IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

pushPrimitive in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

pushText

public ACCUMULATOR pushText(CharSequence aMember)
                                                      throws UnsupportedOperationException,
                                                             NullPointerException,
                                                             IllegalStateException

Description copied from interface: MutableAccumulator

A convenience function to append a new member to the end of this Accumulator's relationship collection

Specified by:

pushText in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

aMember - a new relationship

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationship collection could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationship collection could not be changed at this time

replaceRelationshipsUsing

public ACCUMULATOR replaceRelationshipsUsing(Accumulator<?> anAccumulator)
                                                                       throws UnsupportedOperationException,
                                                                              NullPointerException,
                                                                              IllegalStateException,
                                                                              IllegalArgumentException

Description copied from interface: MutableAccumulator

Attempt to change this Accumulator's relationships to the relationships of the specified Accumulator (shallow copy)

Specified by:

replaceRelationshipsUsing in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

anAccumulator - the Accumulator to query

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's relationships could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's relationships could not be changed at this time

IllegalArgumentException - an aspect of the specified relationships were incompatible with this Accumulator's specification

See Also:

SealedAccumulator.getTarget()

setAccumulator

public ACCUMULATOR setAccumulator(Accumulator<?> anAccumulator)
                                                            throws UnsupportedOperationException,
                                                                   NullPointerException,
                                                                   IllegalStateException,
                                                                   IllegalArgumentException

Description copied from interface: MutableAccumulator

Attempt to share the target of the specified Accumulator with this Accumulator, and also mirror this Accumulator's relationships to the relationship map of the specified Accumulator.

Specified by:

setAccumulator in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

anAccumulator - the Accumulator to query

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - either this Accumulator's target or relationships could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - either this Accumulator's target or relationships could not be changed at this time

IllegalArgumentException - an aspect of the specified target or relationships were incompatible with this Accumulator's specification

See Also:

MutableAccumulator.shareTarget(Primitive), MutableAccumulator.replaceRelationshipsUsing(Accumulator)

shareTargetWith

public ACCUMULATOR shareTargetWith(Accumulator<?> anAccumulator)
                                                             throws UnsupportedOperationException,
                                                                    NullPointerException,
                                                                    IllegalStateException,
                                                                    IllegalArgumentException

Description copied from interface: MutableAccumulator

Attempt to share the specified Accumulator's Primitive target with this Accumulator, or, if this Accumulator's target could not be replaced, attempt to change the current target's value

Specified by:

shareTargetWith in interface MutableAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Parameters:

anAccumulator - the Accumulator to query

Returns:

this Accumulator (facilitates operations chaining)

Throws:

UnsupportedOperationException - this Accumulator's target, or the target's value, could not be changed

NullPointerException - a null value was provided where none was expected

IllegalStateException - this Accumulator's target, or the target's value, could not be changed at this time

IllegalArgumentException - an aspect of the new target was incompatible with this Accumulator's specification, or this Accumulator's target's specification

See Also:

SealedAccumulator.getTarget()

size

public int size()

Description copied from interface: SealedAlgebraicStructure

Returns the number of elements in this algebraic structure. If the structure contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface SealedAlgebraicStructure

Overrides:

size in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the number of elements in this algebraic structure

See Also:

Collection.size()

toAccumulator

public Accumulator<?> toAccumulator()

Description copied from interface: AccumulatorReplicator

If this object is already Accumulator then simply call its AccumulatorReplicator.copy() function, otherwise convert it to a new Accumulator instance

Specified by:

toAccumulator in interface AccumulatorReplicator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

a new Accumulator

toFunctionName

public String toFunctionName()

Description copied from interface: SealedAccumulator

Answer the name of the function associated with this Accumulator type

Specified by:

toFunctionName in interface SealedAccumulator<ACCUMULATOR extends Accumulator<ACCUMULATOR>>

Returns:

the name of the function associated with this Accumulator type

toString

public String toString()

Specified by:

toString in interface CharSequence

Specified by:

toString in interface SealedKernel

Overrides:

toString in class AbstractPrimitiveWrapper<ACCUMULATOR extends Accumulator<ACCUMULATOR>>