org.eclipse.ocl.examples.domain.values
Interface CollectionValue

All Superinterfaces:
java.lang.Iterable<java.lang.Object>, Value
All Known Subinterfaces:
BagValue, BagValue.Accumulator, CollectionValue.Accumulator, InvalidValue, NullValue, OrderedCollectionValue, OrderedSetValue, OrderedSetValue.Accumulator, SequenceValue, SequenceValue.Accumulator, SetValue, SetValue.Accumulator, UniqueCollectionValue
All Known Implementing Classes:
BagValueImpl, BagValueImpl.Accumulator, CollectionValueImpl, EvaluationHaltedException, InvalidValueException, NullValueImpl, OrderedSetValueImpl, RangeOrderedSetValueImpl, RangeSequenceValueImpl, SequenceValueImpl, SetValueImpl, SetValueImpl.Accumulator, SparseOrderedSetValueImpl, SparseOrderedSetValueImpl.Accumulator, SparseSequenceValueImpl, SparseSequenceValueImpl.Accumulator, UndefinedValueImpl, VMException, VMInterruptedExecutionException, VMRuntimeException, VMStackOverFlowError

public interface CollectionValue
extends Value, java.lang.Iterable<java.lang.Object>


Nested Class Summary
static interface CollectionValue.Accumulator
           
 
Field Summary
 
Fields inherited from interface org.eclipse.ocl.examples.domain.values.Value
INVALID_NAME
 
Method Summary
 java.util.Collection<? extends java.lang.Object> asCollection()
           
 java.util.List<java.lang.Object> asEcoreObject()
          Deprecated. 
 java.util.List<?> asEcoreObject(IdResolver idResolver)
           
<T> java.util.List<T>
asEcoreObjects(IdResolver idResolver, java.lang.Class<T> elementClass)
           
 IntegerValue count(java.lang.Object value)
           
 java.lang.Boolean excludes(java.lang.Object value)
           
 java.lang.Boolean excludesAll(CollectionValue c)
           
 CollectionValue excluding(java.lang.Object value)
           
 CollectionValue excludingAll(CollectionValue c)
           
 CollectionValue flatten()
           
 boolean flatten(java.util.Collection<java.lang.Object> flattenedElements)
           
 java.util.Collection<? extends java.lang.Object> getElements()
           
 java.lang.String getKind()
           
 CollectionTypeId getTypeId()
          Return the type of this value determined from its construction context.
 java.lang.Boolean includes(java.lang.Object value)
           
 java.lang.Boolean includesAll(CollectionValue c)
           
 CollectionValue including(java.lang.Object value)
           
 CollectionValue includingAll(CollectionValue c)
           
 CollectionValue intersection(CollectionValue c)
           
 int intSize()
           
 java.lang.Boolean isEmpty()
           
 boolean isOrdered()
           
 boolean isUnique()
           
 java.lang.Iterable<? extends java.lang.Object> iterable()
           
 java.util.Iterator<java.lang.Object> iterator()
           
 java.lang.Boolean notEmpty()
           
 java.util.Set<TupleValue> product(CollectionValue c, TupleTypeId tupleTypeId)
           
 IntegerValue size()
           
 OrderedCollectionValue sort(java.util.Comparator<java.lang.Object> comparator)
           
 SequenceValue toSequenceValue()
           
 CollectionValue union(CollectionValue c)
           
 
Methods inherited from interface org.eclipse.ocl.examples.domain.values.Value
asBagValue, asCollectionValue, asDouble, asElement, asInteger, asIntegerValue, asNavigableObject, asObject, asObjectValue, asOrderedCollectionValue, asOrderedSetValue, asRealValue, asSequenceValue, asSetValue, asTupleValue, asUniqueCollectionValue, asUnlimitedNaturalValue, isInvalid, isUndefined, toString
 

Method Detail

asCollection

@NonNull
java.util.Collection<? extends java.lang.Object> asCollection()
Generated
NOT

asEcoreObject

@Deprecated
java.util.List<java.lang.Object> asEcoreObject()
Deprecated. 

Description copied from interface: Value
Return the Ecore representation of this value.

An thrown exception for an invalid OCL value.

Java-null for a null OCL value

Objects for other things

Specified by:
asEcoreObject in interface Value
Generated
NOT

asEcoreObject

@Nullable
java.util.List<?> asEcoreObject(@NonNull
                                         IdResolver idResolver)
Specified by:
asEcoreObject in interface Value

asEcoreObjects

@Nullable
<T> java.util.List<T> asEcoreObjects(@NonNull
                                              IdResolver idResolver,
                                              @NonNull
                                              java.lang.Class<T> elementClass)
Generated
NOT

count

@NonNull
IntegerValue count(@Nullable
                           java.lang.Object value)
Generated
NOT

excludes

@NonNull
java.lang.Boolean excludes(@Nullable
                                   java.lang.Object value)
Generated
NOT

excludesAll

@NonNull
java.lang.Boolean excludesAll(@NonNull
                                      CollectionValue c)
Generated
NOT

excluding

@NonNull
CollectionValue excluding(@Nullable
                                  java.lang.Object value)
Generated
NOT

excludingAll

@NonNull
CollectionValue excludingAll(@NonNull
                                     CollectionValue c)
Generated
NOT

flatten

@NonNull
CollectionValue flatten()
Generated
NOT

flatten

boolean flatten(@NonNull
                java.util.Collection<java.lang.Object> flattenedElements)
Generated
NOT

getElements

@NonNull
java.util.Collection<? extends java.lang.Object> getElements()
Generated
NOT

getKind

java.lang.String getKind()
Generated
NOT

getTypeId

@NonNull
CollectionTypeId getTypeId()
Description copied from interface: Value
Return the type of this value determined from its construction context. In the case of collections this may differ from the actual type.

Specified by:
getTypeId in interface Value
Generated
NOT

includes

@NonNull
java.lang.Boolean includes(@Nullable
                                   java.lang.Object value)
Generated
NOT

includesAll

@NonNull
java.lang.Boolean includesAll(@NonNull
                                      CollectionValue c)
Generated
NOT

including

@NonNull
CollectionValue including(@Nullable
                                  java.lang.Object value)
Generated
NOT

includingAll

@NonNull
CollectionValue includingAll(@NonNull
                                     CollectionValue c)
Generated
NOT

intSize

int intSize()
Generated
NOT

intersection

@NonNull
CollectionValue intersection(@NonNull
                                     CollectionValue c)
Generated
NOT

isEmpty

@NonNull
java.lang.Boolean isEmpty()
Generated
NOT

isOrdered

boolean isOrdered()

isUnique

boolean isUnique()

iterable

@NonNull
java.lang.Iterable<? extends java.lang.Object> iterable()
Generated
NOT

iterator

@NonNull
java.util.Iterator<java.lang.Object> iterator()
Specified by:
iterator in interface java.lang.Iterable<java.lang.Object>
Generated
NOT

notEmpty

@NonNull
java.lang.Boolean notEmpty()
Generated
NOT

product

@Nullable
java.util.Set<TupleValue> product(@NonNull
                                           CollectionValue c,
                                           @NonNull
                                           TupleTypeId tupleTypeId)
Generated
NOT

size

@NonNull
IntegerValue size()
Generated
NOT

sort

@NonNull
OrderedCollectionValue sort(@NonNull
                                    java.util.Comparator<java.lang.Object> comparator)
Generated
NOT

toSequenceValue

@Nullable
SequenceValue toSequenceValue()
Generated
NOT

union

@NonNull
CollectionValue union(@NonNull
                              CollectionValue c)
Generated
NOT