OCLCollections (AndroMDA OCL Validation Translation-Library 3.5-SNAPSHOT API)

java.lang.Object
- org.andromda.translation.ocl.validation.OCLCollections

```
public final class OCLCollections
extends Object
```
Used to translated OCL collection expressions to their corresponding Java collection expressions.

Constructor Summary

Constructors
Constructor and Description

OCLCollections()

Constructors
Constructor and Description
`OCLCollections()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Object`	`any(Collection collection, org.apache.commons.collections.Predicate predicate)` Returns a random element from the collection for which the argument expression evaluates true.
`static boolean`	`append(org.apache.commons.collections.Bag collection, Object item)` Appends the item to the bag.
`static boolean`	`append(List list, Object item)` Appends the item to the list.
`static org.apache.commons.collections.Bag`	`asBag(Collection collection)` Returns the argument as a bag.
`static Set`	`asOrderedSet(Collection collection)` Returns the argument as an ordered set.
`static List`	`asSequence(Collection collection)` Returns the argument as a list.
`static Set`	`asSet(Collection collection)` Returns the argument as a set.
`static Object`	`at(List list, int index)` Returns the element at the specified index in the argument list.
`static Collection`	`collect(Collection collection, org.apache.commons.collections.Transformer transformer)` Returns the collection of Objects that results from executing the transformer on each individual element in the source collection.
`static Collection`	`collectNested(Collection collection)` TODO: implement
`static int`	`count(Collection collection, Object item)` Counts the number of occurrences of the argument item in the source collection.
`static boolean`	`excludes(Collection collection, Object item)` Return true if the object is not an element of the collection, false otherwise.
`static boolean`	`excludesAll(Collection collection, Collection items)` Returns true if all elements of the parameter collection are not present in the current collection, false otherwise.
`static boolean`	`excluding(Collection collection, Object item)` Removes all occurrences of the item in the source collection.
`static boolean`	`exists(Collection collection, org.apache.commons.collections.Predicate predicate)` Returns true if a predicate is true for at least one element of a collection.
`static boolean`	`exists(Object collection, org.apache.commons.collections.Predicate predicate)` Returns true if a predicate is true for at least one element of a collection.
`static Object`	`first(Object object)` Returns the first element in the collection.
`static Collection`	`flatten(Collection collection)` Recursively flattens this collection, this method returns a Collection containing no nested Collection instances.
`static boolean`	`forAll(Collection collection, org.apache.commons.collections.Predicate predicate)` Executes every `predicate` for the given collectoin, if one evaluates to `false` this operation returns `false`, otherwise `true` is returned.
`static boolean`	`forAll(Object collection, org.apache.commons.collections.Predicate predicate)` Executes every `predicate` for the given collection, if one evaluates to `false` this operation returns `false`, otherwise `true` is returned.
`static boolean`	`includes(Collection collection, Object item)` Returns true if the object is an element of the collection, false otherwise.
`static boolean`	`includesAll(Collection collection, Collection items)` Returns true if all elements of the parameter collection are present in the current collection, false otherwise.
`static boolean`	`including(Collection collection, Object item)` Adds the item to the list
`static int`	`indexOf(List collection, Object item)` Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
`static void`	`insertAt(List collection, int index, Object item)` Insert the item at the specified index into the collection.
`static Collection`	`intersection(Collection first, Collection second)` Returns the collection of elements common in both argument collections.
`static boolean`	`isEmpty(Collection collection)` Returns true if the collection contains no elements, false otherwise.
`static boolean`	`isEmpty(Object object)` Returns true if the argument is `null`, false otherwise.
`static boolean`	`isEmpty(String string)` Returns true if the argument is either `null` or only contains whitespace characters, false otherwise.
`static boolean`	`isUnique(Collection collection, org.apache.commons.collections.Transformer transformer)` Returns `true` if the result of executing the `transformer` has a unique value for each element in the source collection.
`static boolean`	`isUnique(Object collection, org.apache.commons.collections.Transformer transformer)` Returns `true` if the result of executing the `transformer` has a unique value for each element in the source collection.
`static Collection`	`iterate(Collection collection)` TODO: implement
`static Object`	`last(Object object)` Returns the last element in the collection.
`static boolean`	`notEmpty(Collection collection)` Returns true if the collection contains one or more elements, false otherwise.
`static boolean`	`notEmpty(Object object)` Returns true if the argument is not `null`, false otherwise.
`static boolean`	`notEmpty(String string)` Returns true if the argument is neither `null` nor only contains whitespace characters, false otherwise.
`static boolean`	`one(Collection collection, org.apache.commons.collections.Predicate predicate)` Returns `true when the argument expression evaluates true for one and only one element in the collection.`
`static boolean`	`one(Object collection, org.apache.commons.collections.Predicate predicate)` Returns `true if collection is actually a Collection instance and if the predicate expression evaluates true for one and only one element in the collection.`
`static Object`	`prepend(List list, Object item)` Insert the item into the first position of the list.
`static Collection`	`reject(Collection collection, org.apache.commons.collections.Predicate predicate)` Returns a subcollection of the source collection containing all elements for which the expression evaluates `false`.
`static Collection`	`select(Collection collection, org.apache.commons.collections.Predicate predicate)` Returns a subcollection of the source collection containing all elements for which the expression evaluates `true`.
`static Collection`	`select(Object collection, org.apache.commons.collections.Predicate predicate)` Returns a subcollection of the source collection containing all elements for which the expression evaluates `true`.
`static int`	`size(Collection collection)` Returns the number of elements in the collection.
`static int`	`size(Object object)` Checks the instance of the `object` and makes sure its a Collection, if the object is a collection the size is checked and returned, if its NOT a collection, 0 is returned.
`static Collection`	`sortedBy(Collection collection)` TODO: implement
`static Set`	`subOrderedSet(Set collection)` TODO: implement
`static List`	`subSequence(List collection)` TODO: implement
`static double`	`sum(Collection collection)` Returns the sum of all the element in the collection.
`static double`	`sum(Object collection)` Returns the sum of all the elements in the collection.
`static Collection`	`symmetricDifference(Collection first, Collection second)` Returns those element that are contained in only one of both collections.
`static Collection`	`union(Collection first, Collection second)` Returns the union of both collections into a single collection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OCLCollections
```
public OCLCollections()
```
- Method Detail
  - count
```
public static int count(Collection collection,
        Object item)
```
    Counts the number of occurrences of the argument item in the source collection.
    
    Parameters:
    collection -
    item -
    
    Returns:
    CollectionUtils.cardinality(item, collection)
  - excludes
```
public static boolean excludes(Collection collection,
               Object item)
```
    Return true if the object is not an element of the collection, false otherwise.
    
    Parameters:
    collection -
    item -
    
    Returns:
    !collection.contains(item
  - excludesAll
```
public static boolean excludesAll(Collection collection,
                  Collection items)
```
    Returns true if all elements of the parameter collection are not present in the current collection, false otherwise.
    
    Parameters:
    collection -
    items -
    
    Returns:
    excludesAll
  - includes
```
public static boolean includes(Collection collection,
               Object item)
```
    Returns true if the object is an element of the collection, false otherwise.
    
    Parameters:
    collection -
    item -
    
    Returns:
    collection.contains(item)
  - includesAll
```
public static boolean includesAll(Collection collection,
                  Collection items)
```
    Returns true if all elements of the parameter collection are present in the current collection, false otherwise.
    
    Parameters:
    collection -
    items -
    
    Returns:
    collection.containsAll(items)
  - isEmpty
```
public static boolean isEmpty(Collection collection)
```
    Returns true if the collection contains no elements, false otherwise.
    
    Parameters:
    collection -
    
    Returns:
    collection.isEmpty()
  - isEmpty
```
public static boolean isEmpty(Object object)
```
    Returns true if the argument is null, false otherwise.
    
    Parameters:
    object -
    
    Returns:
    isEmpty
  - isEmpty
```
public static boolean isEmpty(String string)
```
    Returns true if the argument is either null or only contains whitespace characters, false otherwise.
    
    Parameters:
    string -
    
    Returns:
    isBlank(string)
  - notEmpty
```
public static boolean notEmpty(Collection collection)
```
    Returns true if the collection contains one or more elements, false otherwise.
    
    Parameters:
    collection -
    
    Returns:
    isEmpty(collection)
  - notEmpty
```
public static boolean notEmpty(Object object)
```
    Returns true if the argument is not null, false otherwise.
    
    Parameters:
    object -
    
    Returns:
    notEmpty
  - notEmpty
```
public static boolean notEmpty(String string)
```
    Returns true if the argument is neither null nor only contains whitespace characters, false otherwise.
    
    Parameters:
    string -
    
    Returns:
    isNotBlank(string)
  - size
```
public static int size(Object object)
```
    Checks the instance of the object and makes sure its a Collection, if the object is a collection the size is checked and returned, if its NOT a collection, 0 is returned.
    
    Parameters:
    object - the object to check.
    
    Returns:
    the size of the collection
  - size
```
public static int size(Collection collection)
```
    Returns the number of elements in the collection.
    
    Parameters:
    collection -
    
    Returns:
    collection.size()
  - sum
```
public static double sum(Object collection)
```
    Returns the sum of all the elements in the collection. Every element must extend Number or this method will throw an exception.
    
    Parameters:
    collection - a collection containing only classes extending Number
    
    Returns:
    the sum of all the elements in the collection
  - sum
```
public static double sum(Collection collection)
```
    Returns the sum of all the element in the collection. Every element must extend Number or this method will throw an exception.
    
    Parameters:
    collection - a collection containing only classes extending Number
    
    Returns:
    the sum of all the elements in the collection
  - append
```
public static boolean append(List list,
             Object item)
```
    Appends the item to the list.
    
    Parameters:
    list -
    item -
    
    Returns:
    true if the operation was a success
  - prepend
```
public static Object prepend(List list,
             Object item)
```
    Insert the item into the first position of the list.
    
    Parameters:
    list -
    item -
    
    Returns:
    the element previously at the first position
  - append
```
public static boolean append(org.apache.commons.collections.Bag collection,
             Object item)
```
    Appends the item to the bag.
    
    Parameters:
    collection -
    item -
    
    Returns:
    true if the operation was a success
  - asBag
```
public static org.apache.commons.collections.Bag asBag(Collection collection)
```
    Returns the argument as a bag.
    
    Parameters:
    collection -
    
    Returns:
    new HashBag(collection)
  - asOrderedSet
```
public static Set asOrderedSet(Collection collection)
```
    Returns the argument as an ordered set.
    
    Parameters:
    collection -
    
    Returns:
    SetUtils.orderedSet(new TreeSet(collection))
  - asSequence
```
public static List asSequence(Collection collection)
```
    Returns the argument as a list.
    
    Parameters:
    collection -
    
    Returns:
    new ArrayList(collection)
  - asSet
```
public static Set asSet(Collection collection)
```
    Returns the argument as a set.
    
    Parameters:
    collection -
    
    Returns:
    new HashSet(collection)
  - at
```
public static Object at(List list,
        int index)
```
    Returns the element at the specified index in the argument list.
    
    Parameters:
    list -
    index -
    
    Returns:
    list.get(index)
  - excluding
```
public static boolean excluding(Collection collection,
                Object item)
```
    Removes all occurrences of the item in the source collection.
    
    Parameters:
    collection -
    item -
    
    Returns:
    true if one or more elements were removed
  - including
```
public static boolean including(Collection collection,
                Object item)
```
    Adds the item to the list
    
    Parameters:
    collection -
    item -
    
    Returns:
    true if the element was added
  - flatten
```
public static Collection flatten(Collection collection)
```
    Recursively flattens this collection, this method returns a Collection containing no nested Collection instances.
    
    Parameters:
    collection -
    
    Returns:
    flattenedCollection.addAll(flatten((Collection) object))
  - indexOf
```
public static int indexOf(List collection,
          Object item)
```
    Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o == null ? get(i) = =null : o.equals(get(i))), or -1 if there is no such index.
    
    Parameters:
    collection -
    item -
    
    Returns:
    collection.indexOf(item)
  - insertAt
```
public static void insertAt(List collection,
            int index,
            Object item)
```
    Insert the item at the specified index into the collection.
    
    Parameters:
    collection -
    index -
    item -
  - intersection
```
public static Collection intersection(Collection first,
                      Collection second)
```
    Returns the collection of elements common in both argument collections.
    
    Parameters:
    first -
    second -
    
    Returns:
    CollectionUtils.intersection(first, second)
  - union
```
public static Collection union(Collection first,
               Collection second)
```
    Returns the union of both collections into a single collection.
    
    Parameters:
    first -
    second -
    
    Returns:
    CollectionUtils.union(first, second)
  - last
```
public static Object last(Object object)
```
    Returns the last element in the collection.
    
    Parameters:
    object - the collection or single instance which will be converted to a collection.
    
    Returns:
    the last object of the collection or the object itself if the object is not a collection instance (or null if the object is null or an empty collection).
  - first
```
public static Object first(Object object)
```
    Returns the first element in the collection.
    
    Parameters:
    object - the collection or single instance which will be converted to a collection.
    
    Returns:
    the first object of the collection or the object itself if the object is not a collection instance (or null if the object is null or an empty collection).
  - symmetricDifference
```
public static Collection symmetricDifference(Collection first,
                             Collection second)
```
    Returns those element that are contained in only one of both collections.
    
    Parameters:
    first -
    second -
    
    Returns:
    CollectionUtils.disjunction(first, second)
  - subOrderedSet
```
public static Set subOrderedSet(Set collection)
```
    TODO: implement
    
    Parameters:
    collection -
    
    Returns:
    UnsupportedOperationException
  - subSequence
```
public static List subSequence(List collection)
```
    TODO: implement
    
    Parameters:
    collection -
    
    Returns:
    UnsupportedOperationException
  - any
```
public static Object any(Collection collection,
         org.apache.commons.collections.Predicate predicate)
```
    Returns a random element from the collection for which the argument expression evaluates true.
    
    Parameters:
    collection -
    predicate -
    
    Returns:
    selectedElements.get(random.nextInt(selectedElements.size())
  - collect
```
public static Collection collect(Collection collection,
                 org.apache.commons.collections.Transformer transformer)
```
    Returns the collection of Objects that results from executing the transformer on each individual element in the source collection.
    
    Parameters:
    collection -
    transformer -
    
    Returns:
    CollectionUtils.collect(collection, transformer)
  - collectNested
```
public static Collection collectNested(Collection collection)
```
    TODO: implement
    
    Parameters:
    collection -
    
    Returns:
    UnsupportedOperationException
  - exists
```
public static boolean exists(Collection collection,
             org.apache.commons.collections.Predicate predicate)
```
    Returns true if a predicate is true for at least one element of a collection.
    A null collection or predicate returns false.
    
    Parameters:
    collection -
    predicate -
    
    Returns:
    CollectionUtils.exists(collection, predicate)
  - exists
```
public static boolean exists(Object collection,
             org.apache.commons.collections.Predicate predicate)
```
    Returns true if a predicate is true for at least one element of a collection.
    A null collection or predicate returns false.
    
    Parameters:
    collection -
    predicate -
    
    Returns:
    exists((Collection) collection, predicate)
  - forAll
```
public static boolean forAll(Collection collection,
             org.apache.commons.collections.Predicate predicate)
```
    Executes every predicate for the given collectoin, if one evaluates to false this operation returns false, otherwise true is returned.
    If the input collection or closure is null false is returned.
    
    Parameters:
    collection -
    predicate -
    
    Returns:
    true if every evaluated predicate returns true, false otherwise.
  - forAll
```
public static boolean forAll(Object collection,
             org.apache.commons.collections.Predicate predicate)
```
    Executes every predicate for the given collection, if one evaluates to false this operation returns false, otherwise true is returned.
    If the input collection or closure is null false is returned.
    
    Parameters:
    collection -
    predicate -
    
    Returns:
    true if every evaluated predicate returns true, false otherwise.
  - isUnique
```
public static boolean isUnique(Collection collection,
               org.apache.commons.collections.Transformer transformer)
```
    Returns true if the result of executing the transformer has a unique value for each element in the source collection.
    
    Parameters:
    collection -
    transformer -
    
    Returns:
    unique
  - isUnique
```
public static boolean isUnique(Object collection,
               org.apache.commons.collections.Transformer transformer)
```
    Returns true if the result of executing the transformer has a unique value for each element in the source collection.
    
    Parameters:
    collection -
    transformer -
    
    Returns:
    isUnique
  - iterate
```
public static Collection iterate(Collection collection)
```
    TODO: implement
    
    Parameters:
    collection -
    
    Returns:
    UnsupportedOperationException
  - one
```
public static boolean one(Collection collection,
          org.apache.commons.collections.Predicate predicate)
```
    Returns true when the argument expression evaluates true for one and only one element in the collection. Returns false otherwise.
    Parameters: collection - predicate - Returns: found
  one public static boolean one(Object collection, org.apache.commons.collections.Predicate predicate) Returns true if collection is actually a Collection instance and if the predicate expression evaluates true for one and only one element in the collection. Returns false otherwise. Parameters: collection - predicate - Returns: one((Collection) collection, predicate) reject public static Collection reject(Collection collection, org.apache.commons.collections.Predicate predicate) Returns a subcollection of the source collection containing all elements for which the expression evaluates false. Parameters: collection - predicate - Returns: CollectionUtils.selectRejected(collection, predicate) select public static Collection select(Collection collection, org.apache.commons.collections.Predicate predicate) Returns a subcollection of the source collection containing all elements for which the expression evaluates true. Parameters: collection - predicate - Returns: CollectionUtils.select(collection, predicate) select public static Collection select(Object collection, org.apache.commons.collections.Predicate predicate) Returns a subcollection of the source collection containing all elements for which the expression evaluates true. Parameters: collection - predicate - Returns: CollectionUtils.select((Collection) collection, predicate) sortedBy public static Collection sortedBy(Collection collection) TODO: implement Parameters: collection - Returns: UnsupportedOperationException

Class OCLCollections

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OCLCollections

Method Detail

count

excludes

excludesAll

includes

includesAll

isEmpty

isEmpty

isEmpty

notEmpty

notEmpty

notEmpty

size

size

sum

sum

append

prepend

append

asBag

asOrderedSet

asSequence

asSet

at

excluding

including

flatten

indexOf

insertAt

intersection

union

last

first

symmetricDifference

subOrderedSet

subSequence

any

collect

collectNested

exists

exists

forAll

forAll

isUnique

isUnique

iterate

one

one

reject

select

select

sortedBy