org.eclipse.ocl.pivot.library.iterator

Class IsUniqueIteration

java.lang.Object

org.eclipse.ocl.pivot.utilities.ValueUtil

org.eclipse.ocl.pivot.library.AbstractFeature

org.eclipse.ocl.pivot.library.AbstractIteration

org.eclipse.ocl.pivot.library.iterator.IsUniqueIteration

All Implemented Interfaces:

LibraryFeature, LibraryIteration, LibraryIteration.LibraryIterationExtension

public class IsUniqueIteration
extends AbstractIteration

IsUniqueIteration realizes the Collection::isUnique() library iteration.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.ocl.pivot.library.AbstractIteration

AbstractIteration.MutableObject

Nested classes/interfaces inherited from interface org.eclipse.ocl.pivot.library.LibraryIteration

LibraryIteration.LibraryIterationExtension

Field Summary

Fields

Modifier and Type	Field and Description
static IsUniqueIteration	INSTANCE

Fields inherited from class org.eclipse.ocl.pivot.library.AbstractIteration

CARRY_ON

Fields inherited from class org.eclipse.ocl.pivot.utilities.ValueUtil

EMPTY_BAG, EMPTY_SET, FALSE_VALUE, INTEGER_MAX_VALUE, INTEGER_MIN_VALUE, INVALID_VALUE, LONG_MAX_VALUE, LONG_MIN_VALUE, NULL_STRING, NULL_VALUE, ONE_VALUE, TRUE_VALUE, UNLIMITED_ONE_VALUE, UNLIMITED_VALUE, ZERO_VALUE

Constructor Summary

Constructors

Constructor and Description
IsUniqueIteration()

Method Summary

Modifier and Type	Method and Description
SetValueImpl.Accumulator	createAccumulatorValue(Evaluator evaluator, TypeId accumulatorTypeId, TypeId bodyTypeId) Deprecated. use Executor
SetValue.Accumulator	createAccumulatorValue(Executor executor, TypeId accumulatorTypeId, TypeId bodyTypeId) Create the value that will accumulate the iteration results.
protected java.lang.Object	resolveTerminalValue(IterationManager iterationManager) Return the final result at the end of an iteration over all the source elements.
protected java.lang.Object	updateAccumulator(IterationManager iterationManager) Update the accumulatorValue with the bodyValue resulting from the current iteration for which the iterators define the context in the environment.

Methods inherited from class org.eclipse.ocl.pivot.library.AbstractIteration

evaluateIteration

Methods inherited from class org.eclipse.ocl.pivot.utilities.ValueUtil

asBagValue, asBoolean, asClass, asCollectionType, asCollectionValue, asInteger, asIntegerValue, asMapType, asMapValue, asNavigableObject, asNavigableObject, asObject, asOrderedCollectionValue, asOrderedSetValue, asRealValue, asSequenceValue, asSetValue, asString, asTupleValue, asType, asUniqueCollectionValue, asUnlimitedNaturalValue, asValue, bigDecimalValueOf, bigIntegerValueOf, byteValueOf, characterValueOf, computeCollectionHashCode, createBagAccumulatorValue, createBagOfEach, createBagRange, createBagValue, createCollectionAccumulatorValue, createInvalidValue, createMapEntry, createMapOfEach, createMapValue, createObjectValue, createOrderedSetAccumulatorValue, createOrderedSetOfEach, createOrderedSetRange, createOrderedSetValue, createRange, createSequenceAccumulatorValue, createSequenceOfEach, createSequenceRange, createSequenceRange, createSequenceValue, createSetAccumulatorValue, createSetOfEach, createSetRange, createSetValue, createTupleOfEach, createTupleValue, doubleValueOf, floatValueOf, getElementIdName, getExecutor, getTypeName, initAllStatics, integerValueOf, integerValueOf, integerValueOf, integerValueOf, integerValueOf, intValueOf, isBoxed, isCollectionValue, isEcore, isIntegerNumber, isIntegerValue, isRealNumber, isUnboxed, isUnlimited, longValueOf, numberValueOf, oclToString, realValueOf, realValueOf, realValueOf, realValueOf, realValueOf, shortValueOf, stringValueOf, throwBooleanInvalidValueException, throwInvalidValueException, throwUnsupportedCompareTo, toString, typedIterable, unlimitedNaturalValueOf, unlimitedNaturalValueOf, unlimitedNaturalValueOf, unlimitedNaturalValueOf, unlimitedNaturalValueOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

@NonNull
public static final IsUniqueIteration INSTANCE

Constructor Detail

IsUniqueIteration

public IsUniqueIteration()

Method Detail

createAccumulatorValue

@Deprecated
public SetValueImpl.Accumulator createAccumulatorValue(@NonNull
                                                                    Evaluator evaluator,
                                                                    @NonNull
                                                                    TypeId accumulatorTypeId,
                                                                    @NonNull
                                                                    TypeId bodyTypeId)

Deprecated. use Executor

createAccumulatorValue

public SetValue.Accumulator createAccumulatorValue(@NonNull
                                                   Executor executor,
                                                   @NonNull
                                                   TypeId accumulatorTypeId,
                                                   @NonNull
                                                   TypeId bodyTypeId)

Description copied from interface: LibraryIteration.LibraryIterationExtension

Create the value that will accumulate the iteration results.

Since:

1.1

resolveTerminalValue

@NonNull
protected java.lang.Object resolveTerminalValue(@NonNull
                                                          IterationManager iterationManager)

Description copied from class: AbstractIteration

Return the final result at the end of an iteration over all the source elements. The default implementation just returns the accumulator. Derived iterations should override.
This method is bypassed if the iteration ends prematurely.

Overrides:

resolveTerminalValue in class AbstractIteration

Parameters:

iterationManager - the iteration context

Returns:

the result

updateAccumulator

@Nullable
protected java.lang.Object updateAccumulator(@NonNull
                                                        IterationManager iterationManager)

Description copied from class: AbstractIteration

Update the accumulatorValue with the bodyValue resulting from the current iteration for which the iterators define the context in the environment.

Specified by:

updateAccumulator in class AbstractIteration

Parameters:

iterationManager - the iteration context

Returns:

non-CARRY_ON premature result of iteration, or CARRY_ON if complete