Skip navigation links

oracle.irm.engine.content.schema
Class ContentSchemaCollectionFactory

java.lang.Object
oracle.irm.engine.content.schema.ContentSchemaCollectionFactory

public final class ContentSchemaCollectionFactory

extends Object

Content Schema collection factory and utilities. This class provides methods for creating new instances of ContentSchema 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 Content 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<ContentSchema>

EMPTY_CONTENT_SCHEMAS An empty Content Schema collection.

Method Summary

static Map<SchemaVersion,ContentSchema>	contentSchemasAsMap(Collection<ContentSchema> collection) Create a map keyed on SchemaVersion from a collection of Content Schema elements.
static Set<ContentSchema>	contentSchemasAsSet(Collection<ContentSchema> collection) Create a set of Content Schema elements from a collection.
static Collection<ContentSchema>	copyContentSchemas(Collection<ContentSchema> collection) Create a shallow copy of a Content Schema collection.
static Collection<ContentSchema>	createContentSchemas(ContentSchema... elements) Create a Content Schema collection containing zero or more elements.
static Collection<ContentSchema>	createContentSchemas(int capacity) Create an empty Content Schema collection with a capacity specified.
static ContentSchema	getContentSchemaBySchemaVersion(Collection<ContentSchema> collection, SchemaVersion key) Get an element from a Content Schema collection by SchemaVersion.
static Collection<ContentSchema>	unmodifiableContentSchemas(Collection<ContentSchema> value) Create an immutable shallow copy of a Content Schema collection.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CONTENT_SCHEMAS

public static final Collection<ContentSchema> EMPTY_CONTENT_SCHEMAS

An empty Content 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

createContentSchemas

public static Collection<ContentSchema> createContentSchemas(ContentSchema... elements)

Create a Content 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.

createContentSchemas

public static Collection<ContentSchema> createContentSchemas(int capacity)

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

copyContentSchemas

public static Collection<ContentSchema> copyContentSchemas(Collection<ContentSchema> collection)

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

contentSchemasAsSet

public static Set<ContentSchema> contentSchemasAsSet(Collection<ContentSchema> collection)

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

unmodifiableContentSchemas

public static Collection<ContentSchema> unmodifiableContentSchemas(Collection<ContentSchema> value)

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

contentSchemasAsMap

public static Map<SchemaVersion,ContentSchema> contentSchemasAsMap(Collection<ContentSchema> collection)

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

getContentSchemaBySchemaVersion

public static ContentSchema getContentSchemaBySchemaVersion(Collection<ContentSchema> collection,
                                                            SchemaVersion key)

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