oracle.irm.engine.content.key
Class KeySetCollectionFactory

Key Set collection factory and utilities. This class provides methods for creating new instances of KeySet 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 Key Set 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.

EMPTY_KEY_SETS

An empty Key Set 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

createKeySets

Create a Key Set 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.

unmodifiableKeySets

Create an immutable shallow copy of a Key Set collection. Key Set objects are immutable (cannot be changed once created). An immutable collection of Key Set 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.

keySetsAsMap

Create a map keyed on Uuid from a collection of Key Set elements. This method creates a map of Key Set elements, using the Uuid 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.

getKeySetByUuid

Get an element from a Key Set collection by Uuid. This method searches the collection for the first instance of a Key Set that matches the provided Uuid (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.