Skip navigation links

oracle.irm.engine.core.classification
Class ClassificationCollectionFactory

java.lang.Object
oracle.irm.engine.core.classification.ClassificationCollectionFactory

public final class ClassificationCollectionFactory

extends Object

Classification collection factory and utilities. This class provides methods for creating new instances of Classification collections as well as providing a number of collection based utility methods and fields. These methods are provided mainly for convenience and to provide a consistent way to create Classification collections. Methods that take collection parameters make no assumptions about what collection implementation is used, so the use of these factory style methods is at the developers discretion.

Field Summary

static Collection<Classification>

EMPTY_CLASSIFICATIONS An empty Classification collection.

Method Summary

static Map<String,Classification>	classificationsAsMap(Collection<Classification> collection) Create a map keyed on Id from a collection of Classification elements.
static Set<Classification>	classificationsAsSet(Collection<Classification> collection) Create a set of Classification elements from a collection.
static Collection<Classification>	copyClassifications(Collection<Classification> collection) Create a shallow copy of a Classification collection.
static Collection<Classification>	createClassifications(Classification... elements) Create a Classification collection containing zero or more elements.
static Collection<Classification>	createClassifications(int capacity) Create an empty Classification collection with a capacity specified.
static Classification	getClassificationById(Collection<Classification> collection, String key) Get an element from a Classification collection by Id.
static Collection<Classification>	unmodifiableClassifications(Collection<Classification> value) Create an immutable shallow copy of a Classification collection.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CLASSIFICATIONS

public static final Collection<Classification> EMPTY_CLASSIFICATIONS

An empty Classification collection. This empty collection is immutable. This field is useful if a method requires a collection argument but the caller wants to supply an empty collection. Using this field value rather than passing null can aid code clarity.

Method Detail

createClassifications

public static Collection<Classification> createClassifications(Classification... elements)

Create a Classification collection containing zero or more elements. Creates a collection and adds all of the provided elements into the specified collection. This method is provided as a convenience method as it allows creation of an empty collection, a collection with one element or a collection with many elements (all in one line of code).

Parameters:

elements - The elements to add into the collection.

Returns:

The collection containing the specified elements. If no elements are provided an empty collection is returned.

createClassifications

public static Collection<Classification> createClassifications(int capacity)

Create an empty Classification collection with a capacity specified. Creates an empty collection with an initial capacity for n elements.

Parameters:

capacity - The initial collection capacity.

Returns:

The empty collection with the specified capacity.

copyClassifications

public static Collection<Classification> copyClassifications(Collection<Classification> collection)

Create a shallow copy of a Classification collection. A shallow copy creates a new collection which contains the elements of the provided collection.

Parameters:

collection - The collection to copy.

Returns:

The copy of the collection. If the provided collection is null, an empty collection is returned.

classificationsAsSet

public static Set<Classification> classificationsAsSet(Collection<Classification> collection)

Create a set of Classification elements from a collection. Classification objects can be logically compared using equals. When adding Classification objects into a set duplicates will be removed.

Parameters:

collection - The collection to copy.

Returns:

The set. If the provided collection is null, an empty set is returned.

unmodifiableClassifications

public static Collection<Classification> unmodifiableClassifications(Collection<Classification> value)

Create an immutable shallow copy of a Classification collection. Classification objects are immutable (cannot be changed once created). An immutable collection of Classification elements can therefore be treated as immutable (neither the collection or elements can be changed once created).

Parameters:

value - The collection to copy.

Returns:

The immutable collection. If the provided collection is null, an empty collection is returned.

classificationsAsMap

public static Map<String,Classification> classificationsAsMap(Collection<Classification> collection)

Create a map keyed on Id from a collection of Classification elements. This method creates a map of Classification elements, using the Id property as the map key. The map will contain a snap shot of the elements from the provided collection. Any changes to the collection after calling this method are not reflected in the map. If the collection contains duplicate elements the map will contain the element that is returned last from the collection's iterator.

Parameters:

collection - The collection to convert to a map.

Returns:

A map. If the provided collection is null, an empty map is returned.

getClassificationById

public static Classification getClassificationById(Collection<Classification> collection,
                                                   String key)

Get an element from a Classification collection by Id. This method searches the collection for the first instance of a Classification that matches the provided Id (first in terms of the order of elements returned by the collection iterator).

Parameters:

collection - The collection.

key - The key.

Returns:

The element, or null if the element with that key value does not exist.

Skip navigation links