craterdog.collections.abstractions

Class OpenCollection<E>

java.lang.Object

craterdog.smart.SmartObject<Sequence<E>>

craterdog.collections.abstractions.Sequence<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:

craterdog.core.Composite, craterdog.core.Sequential<E>, java.lang.Comparable<Sequence<E>>, java.lang.Iterable<E>

Direct Known Subclasses:

OrderedCollection, SortableCollection

public abstract class OpenCollection<E>
extends Collection<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
abstract boolean	addElement(E element) This method adds a new element to the collection.
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.
abstract boolean	removeElement(E element) This method removes the specified element from 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

containsAll, containsAny, containsElement, getElement, getElements, getIndex, normalizedIndex, removeAll

Methods inherited from class craterdog.collections.abstractions.Sequence

compareTo, equals, hashCode, toArray

Methods inherited from class craterdog.smart.SmartObject

addSerializableClass, addSerializableClass, addSerializableClass, copy, createMapper, fromString, fromString, toExposedString, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface craterdog.core.Sequential

createIterator, getSize, isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OpenCollection

public OpenCollection()

Method Detail

addElement

public abstract boolean addElement(E element)

This method adds a new element to the collection. If the collection is empty then the new element will be the first element in the collection.

Parameters:

element - The new element to be added.

Returns:

Whether or not the element was actually added to the collection.

addElements

public int addElements(E[] elements)

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.

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)

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.

Parameters:

elements - The list of new elements to be added.

Returns:

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

removeElement

public abstract boolean removeElement(E element)

This method removes the specified element from the collection. If the element is not found in the collection, no changes are made.

Parameters:

element - The element to be removed.

Returns:

Whether or not the element was found.

removeElements

public int removeElements(E[] elements)

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

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)

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

Parameters:

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

Returns:

The number of elements that were actually removed.