Skip navigation links

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-01


oracle.irm.engine.content.crypto
Class CryptoSchemaCollectionFactory

java.lang.Object
  extended by oracle.irm.engine.content.crypto.CryptoSchemaCollectionFactory


public final class CryptoSchemaCollectionFactory
extends Object

Crypto Schema collection factory and utilities. This class provides methods for creating new instances of CryptoSchema 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 Crypto Schema 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<CryptoSchema> EMPTY_CRYPTO_SCHEMAS
          An empty Crypto Schema collection.

 

Method Summary
static Collection<CryptoSchema> copyCryptoSchemas(Collection<CryptoSchema> collection)
          Create a shallow copy of a Crypto Schema collection.
static Collection<CryptoSchema> createCryptoSchemas(CryptoSchema... elements)
          Create a Crypto Schema collection containing zero or more elements.
static Collection<CryptoSchema> createCryptoSchemas(int capacity)
          Create an empty Crypto Schema collection with a capacity specified.
static Map<String,CryptoSchema> cryptoSchemasAsMap(Collection<CryptoSchema> collection)
          Create a map keyed on Id from a collection of Crypto Schema elements.
static Set<CryptoSchema> cryptoSchemasAsSet(Collection<CryptoSchema> collection)
          Create a set of Crypto Schema elements from a collection.
static CryptoSchema getCryptoSchemaById(Collection<CryptoSchema> collection, String key)
          Get an element from a Crypto Schema collection by Id.
static Collection<CryptoSchema> unmodifiableCryptoSchemas(Collection<CryptoSchema> value)
          Create an immutable shallow copy of a Crypto Schema collection.

 

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

 

Field Detail

EMPTY_CRYPTO_SCHEMAS

public static final Collection<CryptoSchema> EMPTY_CRYPTO_SCHEMAS
An empty Crypto Schema 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

createCryptoSchemas

public static Collection<CryptoSchema> createCryptoSchemas(CryptoSchema... elements)
Create a Crypto Schema 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.

createCryptoSchemas

public static Collection<CryptoSchema> createCryptoSchemas(int capacity)
Create an empty Crypto Schema 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.

copyCryptoSchemas

public static Collection<CryptoSchema> copyCryptoSchemas(Collection<CryptoSchema> collection)
Create a shallow copy of a Crypto Schema 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.

cryptoSchemasAsSet

public static Set<CryptoSchema> cryptoSchemasAsSet(Collection<CryptoSchema> collection)
Create a set of Crypto Schema elements from a collection. Crypto Schema objects can be logically compared using equals. When adding Crypto Schema 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.

unmodifiableCryptoSchemas

public static Collection<CryptoSchema> unmodifiableCryptoSchemas(Collection<CryptoSchema> value)
Create an immutable shallow copy of a Crypto Schema collection. Crypto Schema objects are immutable (cannot be changed once created). An immutable collection of Crypto Schema 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.

cryptoSchemasAsMap

public static Map<String,CryptoSchema> cryptoSchemasAsMap(Collection<CryptoSchema> collection)
Create a map keyed on Id from a collection of Crypto Schema elements. This method creates a map of Crypto Schema 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.

getCryptoSchemaById

public static CryptoSchema getCryptoSchemaById(Collection<CryptoSchema> collection,
                                               String key)
Get an element from a Crypto Schema collection by Id. This method searches the collection for the first instance of a Crypto Schema 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

Oracle® Information Rights Management Server Java API Reference
11g Release 1 (11.1.1)

E12907-01


Copyright © 2010, Oracle. All rights reserved.