Skip navigation links

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

E12907-01


oracle.irm.engine.content.source
Class SourceCollectionFactory

java.lang.Object
  extended by oracle.irm.engine.content.source.SourceCollectionFactory


public final class SourceCollectionFactory
extends Object

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

 

Method Summary
static Collection<Source> copySources(Collection<Source> collection)
          Create a shallow copy of a Source collection.
static Collection<Source> createSources(int capacity)
          Create an empty Source collection with a capacity specified.
static Collection<Source> createSources(Source... elements)
          Create a Source collection containing zero or more elements.
static Collection<Source> unmodifiableSources(Collection<Source> value)
          Create an immutable shallow copy of a Source collection.

 

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

 

Field Detail

EMPTY_SOURCES

public static final Collection<Source> EMPTY_SOURCES
An empty Source 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

createSources

public static Collection<Source> createSources(Source... elements)
Create a Source 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.

createSources

public static Collection<Source> createSources(int capacity)
Create an empty Source 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.

copySources

public static Collection<Source> copySources(Collection<Source> collection)
Create a shallow copy of a Source 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.

unmodifiableSources

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

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.