net.sf.jaccumulator

Interface SealedAccumulator<ACCUMULATOR extends SealedAccumulator<ACCUMULATOR>>

Type Parameters:

ACCUMULATOR - this Accumulator type

All Superinterfaces:

AccumulatorReplicator<ACCUMULATOR>, CharacterProperties, CharSequence, Comparable<SealedPrimitive<?>>, NumericProperties, PrimitiveReplicator<ACCUMULATOR>, RealReplicator<ACCUMULATOR>, Replicator<ACCUMULATOR>, ScalarReplicator<ACCUMULATOR>, SealedAlgebraicStructure, SealedBooleanValue, SealedByteValue, SealedCharacterValue, SealedDoubleValue, SealedFloatValue, SealedIntegerValue, SealedKernel, SealedLongValue, SealedPrimitive<ACCUMULATOR>, SealedReal<ACCUMULATOR>, SealedRealBag, SealedRealDomain, SealedScalar<ACCUMULATOR>, SealedScalarBag, SealedScalarDomain, SealedShortValue, SealedText<ACCUMULATOR>, SealedTextValue, SealedUnlimitedDecimalValue, SealedUnlimitedIntegerValue, StructureProperties, TextProperties, TextReplicator<ACCUMULATOR>

All Known Subinterfaces:

Accumulator<ACCUMULATOR>

All Known Implementing Classes:

AbstractAccumulator, AbstractConstantAccumulator, AbstractSimpleAccumulator, AbstractStickyTarget, ConstantAccumulator, SimpleAccumulator

public interface SealedAccumulator<ACCUMULATOR extends SealedAccumulator<ACCUMULATOR>>
extends SealedPrimitive<ACCUMULATOR>, AccumulatorReplicator<ACCUMULATOR>

A read-only Accumulator

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (nicole@tedesco.name)

Method Summary

Methods

Modifier and Type	Method and Description
Accumulator<?>	first() A convenience function to return the first, or zeroth, relationship in this Accumulator's #members() collection
Primitive<?>	getTarget()
boolean	isEqualToAccumulator(SealedAccumulator<?> anAccumulator) Compare this Accumulator for equality against another.
boolean	isTargetReplaceable()
Accumulator<?>	last() A convenience function to return the last, or highest order, relationship in this Accumulator's #members() collection
net.sf.jupperware.association.AssociativeList<Accumulator<?>,Accumulator<?>>	members()
Accumulator<?>	peek() A convenience alias for last()
String	toFunctionName() Answer the name of the function associated with this Accumulator type

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

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

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

equals, getConcurrency, hashCode, toString

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.SealedAlgebraicStructure

getDomain, getStructureStrategy, longSize, size

Methods inherited from interface net.sf.jaccumulator.StructureProperties

isConfigurable, isCountable, isElastic, isEmpty, isExpandable, isOrdered, isReducible, isUnique

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

toUnlimitedInteger

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

toUnlimitedDecimal

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

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

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

copyUsingText

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, toString

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

isEmpty, isText

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.sf.jaccumulator.AccumulatorReplicator

copy, copySharing, copySharing, copySharing, copySharing, copyUsingAccumulator, copyUsingPrimitive, toAccumulator

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

copyUsingText, toPrimitive

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

copyUsing, copyUsing, copyUsingReal, toReal

Method Detail

first

Accumulator<?> first()
                     throws NoSuchElementException

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

Returns:

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

Throws:

NoSuchElementException - this Accumulator's relationship collection was empty

getTarget

Primitive<?> getTarget()

Returns:

this Accumulator's target Primitive

isEqualToAccumulator

boolean isEqualToAccumulator(SealedAccumulator<?> anAccumulator)

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.

Parameters:

anAccumulator -

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

isTargetReplaceable

boolean isTargetReplaceable()

Returns:

true if the target Primitive can be replaced

last

Accumulator<?> last()
                    throws NoSuchElementException

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

Returns:

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

Throws:

NoSuchElementException - this Accumulator's relationship collection was empty

members

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

Returns:

the relationship collection

peek

Accumulator<?> peek()
                    throws NoSuchElementException

A convenience alias for last()

Returns:

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

Throws:

NoSuchElementException - this Accumulator's relationship collection was empty

toFunctionName

String toFunctionName()

Answer the name of the function associated with this Accumulator type

Returns:

the name of the function associated with this Accumulator type