net.sf.jaccumulator

Interface MutableAccumulator<ACCUMULATOR extends MutableAccumulator<ACCUMULATOR>>

Type Parameters:

ACCUMULATOR - this Accumulator type

All Superinterfaces:

Appendable, Mutable, MutableAlgebraicStructure<ACCUMULATOR>, MutableBooleanValue<ACCUMULATOR>, MutableByteValue<ACCUMULATOR>, MutableCharacterValue<ACCUMULATOR>, MutableDoubleValue<ACCUMULATOR>, MutableFloatValue<ACCUMULATOR>, MutableIntegerValue<ACCUMULATOR>, MutableKernel<ACCUMULATOR>, MutableLongValue<ACCUMULATOR>, MutablePrimitive<ACCUMULATOR>, MutableReal<ACCUMULATOR>, MutableRealDomain<ACCUMULATOR>, MutableScalar<ACCUMULATOR>, MutableScalarDomain<ACCUMULATOR>, MutableShortValue<ACCUMULATOR>, MutableText<ACCUMULATOR>, MutableTextValue<ACCUMULATOR>, MutableUnlimitedDecimalValue<ACCUMULATOR>, MutableUnlimitedIntegerValue<ACCUMULATOR>

All Known Subinterfaces:

Accumulator<ACCUMULATOR>

All Known Implementing Classes:

AbstractAccumulator, AbstractConstantAccumulator, AbstractSimpleAccumulator, AbstractStickyTarget, ConstantAccumulator, SimpleAccumulator

public interface MutableAccumulator<ACCUMULATOR extends MutableAccumulator<ACCUMULATOR>>
extends MutablePrimitive<ACCUMULATOR>

A write-only Accumulator

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (nicole@tedesco.name)

Method Summary

Methods

Modifier and Type	Method and Description
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	shareTarget(Primitive<?> aTarget) Attempt to share the specified Primitive target with this Accumulator, or, if this Accumulator's target could not be replaced, attempt to change the current target's value
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

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.texts.MutableTextValue

append, append, append, append, append, append, append, append, append, append, append, append, append, append, appendCodePoint, clear, 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

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, clear, clearContents

Methods inherited from interface net.sf.jaccumulator.Mutable

isMutable

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

setReal, unlimitedIntegerPostDecrement, unlimitedIntegerPostIncrement

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

setReal, unlimitedDecimalPostDecrement, unlimitedDecimalPostIncrement

Method Detail

pop

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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:

shareTarget(Primitive), replaceRelationshipsUsing(Accumulator)

shareTarget

ACCUMULATOR shareTarget(Primitive<?> aTarget)
                                                                throws UnsupportedOperationException,
                                                                       NullPointerException,
                                                                       IllegalStateException,
                                                                       IllegalArgumentException

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

Parameters:

aTarget - a new target

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()

shareTargetWith

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

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

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()