Skip navigation links

oracle.irm.engine.classifications.item
Class ItemCodeCollectionFactory

java.lang.Object
oracle.irm.engine.classifications.item.ItemCodeCollectionFactory

public final class ItemCodeCollectionFactory

extends Object

Item Code collection factory and utilities. This class provides methods for creating new instances of ItemCode 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 Item Code 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<ItemCode>

EMPTY_ITEM_CODES An empty Item Code collection.

Method Summary

static Collection<ItemCode>	copyItemCodes(Collection<ItemCode> collection) Create a shallow copy of a Item Code collection.
static Collection<ItemCode>	createItemCodes(int capacity) Create an empty Item Code collection with a capacity specified.
static Collection<ItemCode>	createItemCodes(ItemCode... elements) Create a Item Code collection containing zero or more elements.
static Set<ItemCode>	itemCodesAsSet(Collection<ItemCode> collection) Create a set of Item Code elements from a collection.
static Collection<ItemCode>	unmodifiableItemCodes(Collection<ItemCode> value) Create an immutable shallow copy of a Item Code collection.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ITEM_CODES

public static final Collection<ItemCode> EMPTY_ITEM_CODES

An empty Item Code 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

createItemCodes

public static Collection<ItemCode> createItemCodes(ItemCode... elements)

Create a Item Code 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.

createItemCodes

public static Collection<ItemCode> createItemCodes(int capacity)

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

copyItemCodes

public static Collection<ItemCode> copyItemCodes(Collection<ItemCode> collection)

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

itemCodesAsSet

public static Set<ItemCode> itemCodesAsSet(Collection<ItemCode> collection)

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

unmodifiableItemCodes

public static Collection<ItemCode> unmodifiableItemCodes(Collection<ItemCode> value)

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