craterdog.collections.abstractions

Class OpenCollection<E>

java.lang.Object

craterdog.smart.SmartObject<Collection<E>>

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.OpenCollection<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

Accessible<E>, Dynamic<E>, Composite, Sequential<E>, java.lang.Comparable<Collection<E>>, java.lang.Iterable<E>

Direct Known Subclasses:

OrderedCollection, SortableCollection

public abstract class OpenCollection<E>
extends Collection<E>
implements Dynamic<E>

This abstract class implements a collection that allows its internal structure to be directly manipulated.

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
OpenCollection()

Method Summary

Modifier and Type	Method and Description
int	addElements(E[] elements) This method adds an array of new elements to the collection.
int	addElements(java.lang.Iterable<? extends E> elements) This method adds a list of new elements to the collection.
int	removeElements(E[] elements) This method removes the elements in the specified array from the collection.
int	removeElements(java.lang.Iterable<? extends E> elements) This method removes the specified elements from the collection.

Methods inherited from class craterdog.collections.abstractions.Collection

compareTo, containsAllElementsIn, containsAnyElementsIn, containsElement, equals, hashCode, isEmpty, iterator, normalizedIndex, toArray

Methods inherited from class craterdog.smart.SmartObject

addSerializableClass, addSerializableClass, copy, toExposedString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface craterdog.collections.interfaces.Dynamic

addElement, removeElement

Methods inherited from interface craterdog.collections.interfaces.Accessible

createDefaultIterator, getElementAtIndex, getElementsInRange, getIndexOfElement, removeAllElements

Methods inherited from interface craterdog.core.Sequential

getNumberOfElements

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OpenCollection

public OpenCollection()

Method Detail

addElements

public int addElements(E[] elements)

Description copied from interface: Dynamic

This method adds an array of new elements to the collection. The new elements will be added in the order they appear in the specified array.

Specified by:

addElements in interface Dynamic<E>

Parameters:

elements - The array of new elements to be added.

Returns:

The number of elements that were actually added to the collection.

addElements

public int addElements(java.lang.Iterable<? extends E> elements)

Description copied from interface: Dynamic

This method adds a list of new elements to the collection. The new elements will be added in the order they appear in the specified collection.

Specified by:

addElements in interface Dynamic<E>

Parameters:

elements - The list of new elements to be added.

Returns:

The number of elements that were actually added to the collection.

removeElements

public int removeElements(E[] elements)

Description copied from interface: Dynamic

This method removes the elements in the specified array from the collection. The number of matching elements is returned.

Specified by:

removeElements in interface Dynamic<E>

Parameters:

elements - The array of elements to be removed from the collection.

Returns:

The number of elements that were actually removed.

removeElements

public int removeElements(java.lang.Iterable<? extends E> elements)

Description copied from interface: Dynamic

This method removes the specified elements from the collection. The number of matching elements is returned.

Specified by:

removeElements in interface Dynamic<E>

Parameters:

elements - The list of elements to be removed from the collection.

Returns:

The number of elements that were actually removed.