Skip navigation links

oracle.irm.engine.rights.context
Class DocumentRightCollectionFactory

java.lang.Object
oracle.irm.engine.rights.context.DocumentRightCollectionFactory

public final class DocumentRightCollectionFactory

extends Object

Document Right collection factory and utilities. This class provides methods for creating new instances of DocumentRight 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 Document Right 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<DocumentRight>

EMPTY_DOCUMENT_RIGHTS An empty Document Right collection.

Method Summary

static Collection<DocumentRight>	copyDocumentRights(Collection<DocumentRight> collection) Create a shallow copy of a Document Right collection.
static Collection<DocumentRight>	createDocumentRights(DocumentRight... elements) Create a Document Right collection containing zero or more elements.
static Collection<DocumentRight>	createDocumentRights(int capacity) Create an empty Document Right collection with a capacity specified.
static Map<UUID,DocumentRight>	documentRightsAsMap(Collection<DocumentRight> collection) Create a map keyed on Uuid from a collection of Document Right elements.
static Set<DocumentRight>	documentRightsAsSet(Collection<DocumentRight> collection) Create a set of Document Right elements from a collection.
static DocumentRight	getDocumentRightByUuid(Collection<DocumentRight> collection, UUID key) Get an element from a Document Right collection by Uuid.
static Collection<DocumentRight>	unmodifiableDocumentRights(Collection<DocumentRight> value) Create an immutable shallow copy of a Document Right collection.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_DOCUMENT_RIGHTS

public static final Collection<DocumentRight> EMPTY_DOCUMENT_RIGHTS

An empty Document Right 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

createDocumentRights

public static Collection<DocumentRight> createDocumentRights(DocumentRight... elements)

Create a Document Right 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.

createDocumentRights

public static Collection<DocumentRight> createDocumentRights(int capacity)

Create an empty Document Right 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.

copyDocumentRights

public static Collection<DocumentRight> copyDocumentRights(Collection<DocumentRight> collection)

Create a shallow copy of a Document Right 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.

documentRightsAsSet

public static Set<DocumentRight> documentRightsAsSet(Collection<DocumentRight> collection)

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

unmodifiableDocumentRights

public static Collection<DocumentRight> unmodifiableDocumentRights(Collection<DocumentRight> value)

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

documentRightsAsMap

public static Map<UUID,DocumentRight> documentRightsAsMap(Collection<DocumentRight> collection)

Create a map keyed on Uuid from a collection of Document Right elements. This method creates a map of Document Right 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.

getDocumentRightByUuid

public static DocumentRight getDocumentRightByUuid(Collection<DocumentRight> collection,
                                                   UUID key)

Get an element from a Document Right collection by Uuid. This method searches the collection for the first instance of a Document Right 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