net.sf.jaccumulator

Interface MutableAlgebraicStructure<STRUCTURE>

Type Parameters:

STRUCTURE - this structure type (facilitates chaining)

All Superinterfaces:

Mutable

All Known Subinterfaces:

Accumulator<ACCUMULATOR>, AlgebraicStructure<STRUCTURE>, MutableAccumulator<ACCUMULATOR>, MutableKernel<KERNEL>, MutablePrimitive<PRIMITIVE>, MutableReal<REAL>, MutableRealDomain<DOMAIN>, MutableScalar<SCALAR>, MutableScalarDomain<DOMAIN>, Primitive<PRIMITIVE>, Real<REAL>, RealDomain<DOMAIN>, Scalar<SCALAR>, ScalarDomain<DOMAIN>

All Known Implementing Classes:

AbstractAccumulator, AbstractBooleanPrimitive, AbstractBytePrimitive, AbstractCharacterPrimitive, AbstractConstant, AbstractConstantAccumulator, AbstractDoublePrimitive, AbstractFloatPrimitive, AbstractIntegerPrimitive, AbstractLongPrimitive, AbstractModuloIntegerPrimitive, AbstractNumericPrimitive, AbstractPrimitive, AbstractPrimitiveWrapper, AbstractReal, AbstractScalar, AbstractShortPrimitive, AbstractSimpleAccumulator, AbstractStickyTarget, AbstractTextPrimitive, AbstractUnlimitedDecimalPrimitive, AbstractUnlimitedIntegerPrimitive, BooleanArrayCursor, BooleanPrimitive, ByteArrayCursor, BytePrimitive, CharacterArrayCursor, CharacterPrimitive, Constant, ConstantAccumulator, DoublePrimitive, EnumerationPrimitive, FloatPrimitive, GaussianRandomPrimitive, IntegerPrimitive, LongPrimitive, Milliseconds, ModuloIntegerPrimitive, Nanoseconds, RandomPrimitive, ShortPrimitive, SimpleAccumulator, TextPrimitive, UnlimitedDecimalPrimitive, UnlimitedIntegerPrimitive, Variant

public interface MutableAlgebraicStructure<STRUCTURE>
extends Mutable

A write-only algebraic structure

Since:

JAccumulator 4.0

Author:

Nicole Tedesco (Nicole@NicoleTedesco.com)

Method Summary

Methods

Modifier and Type	Method and Description
STRUCTURE	assertDomain(Domain aDomain) Attempt to convert the implementation domain of this structure to the closest available match for the proposed domain.
void	clear() Same as Collection.clear().
STRUCTURE	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().

Methods inherited from interface net.sf.jaccumulator.Mutable

isMutable

Method Detail

assertDomain

STRUCTURE assertDomain(Domain aDomain)

Attempt to convert the implementation domain of this structure to the closest available match for the proposed domain. Note that the domain of this implementation may not change as a result of calling this function if an available internal conversion is not available.

Parameters:

aDomain - the proposed domain

Returns:

this object (facilitates operation chaining)

See Also:

StructureProperties.isConfigurable()

clear

void clear()
           throws UnsupportedOperationException

Same as Collection.clear(). So as to maintain compatibility, this function will not return the customary reference back to this structure.

Throws:

UnsupportedOperationException - if the elements of this structure cannot be cleared

See Also:

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

clearContents

STRUCTURE clearContents()
                        throws UnsupportedOperationException

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.

Returns:

this object (facilitates operation chaining)

Throws:

UnsupportedOperationException - if this object's value cannot be changed

See Also:

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