Skip navigation links

oracle.irm.engine.content.key
Class KeySetCollectionFactory

java.lang.Object
oracle.irm.engine.content.key.KeySetCollectionFactory

public final class KeySetCollectionFactory

extends Object

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.

Field Summary

static Collection<KeySet>

EMPTY_KEY_SETS An empty Key Set collection.

Method Summary

static Collection<KeySet>	copyKeySets(Collection<KeySet> collection) Create a shallow copy of a Key Set collection.
static Collection<KeySet>	createKeySets(int capacity) Create an empty Key Set collection with a capacity specified.
static Collection<KeySet>	createKeySets(KeySet... elements) Create a Key Set collection containing zero or more elements.
static KeySet	getKeySetByUuid(Collection<KeySet> collection, UUID key) Get an element from a Key Set collection by Uuid.
static Map<UUID,KeySet>	keySetsAsMap(Collection<KeySet> collection) Create a map keyed on Uuid from a collection of Key Set elements.
static Set<KeySet>	keySetsAsSet(Collection<KeySet> collection) Create a set of Key Set elements from a collection.
static Collection<KeySet>	unmodifiableKeySets(Collection<KeySet> value) Create an immutable shallow copy of a Key Set collection.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_KEY_SETS

public static final Collection<KeySet> 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

public static Collection<KeySet> createKeySets(KeySet... elements)

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.

createKeySets

public static Collection<KeySet> createKeySets(int capacity)

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

copyKeySets

public static Collection<KeySet> copyKeySets(Collection<KeySet> collection)

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

keySetsAsSet

public static Set<KeySet> keySetsAsSet(Collection<KeySet> collection)

Create a set of Key Set elements from a collection. Key Set objects can be logically compared using equals. When adding Key Set 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.

unmodifiableKeySets

public static Collection<KeySet> unmodifiableKeySets(Collection<KeySet> value)

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

public static Map<UUID,KeySet> keySetsAsMap(Collection<KeySet> collection)

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

public static KeySet getKeySetByUuid(Collection<KeySet> collection,
                                     UUID key)

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.

Skip navigation links