craterdog.collections.abstractions

Class OrderedCollection<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.OrderedCollection<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

Accessible<E>, Iteratable<E>, Ordered<E>, Composite, Sequential<E>, java.lang.Iterable<E>

Direct Known Subclasses:

Bag, Set

public abstract class OrderedCollection<E>
extends Collection<E>
implements Ordered<E>

This abstract class defines the invariant methods that all ordered collections must inherit. An ordered collection automatically orders its elements based on the comparison function implemented by a specified Comparator. If no comparator is specified, the elements extend the Comparable interface.

Author:

Derk Norton

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrderedCollection(boolean duplicatesAllowed) This constructor creates a new empty collection with no comparator function.
protected	OrderedCollection(boolean duplicatesAllowed, java.util.Comparator<? super E> comparator) This constructor creates a new collection with the specified comparator function.
protected	OrderedCollection(E[] elements, boolean duplicatesAllowed) This constructor creates a new collection with no comparator function and seeds it with the elements from the specified array.
protected	OrderedCollection(E[] elements, boolean duplicatesAllowed, java.util.Comparator<? super E> comparator) This constructor creates a new collection with the specified comparator function and seeds it with the elements from the specified array.
protected	OrderedCollection(java.lang.Iterable<? extends E> elements, boolean duplicatesAllowed) This constructor creates a new collection with no comparator function and seeds it with the elements from the specified collection.
protected	OrderedCollection(java.lang.Iterable<? extends E> elements, boolean duplicatesAllowed, java.util.Comparator<? super E> comparator) This constructor creates a new collection with the specified comparator function and seeds it with the elements from the specified collection.

Method Summary

Modifier and Type	Method and Description
boolean	addElement(E element) This method adds a new element to the collection.
boolean	containsElement(E element) This method determines if an element is contained in the collection.
Iterator<E>	createDefaultIterator() This method creates a new default iterator for the collection.
int	getNumberOfElements()
void	removeAllElements() This method removes all elements from the collection.
boolean	removeElement(E element) This method removes the specified element from the collection.

Methods inherited from class craterdog.collections.abstractions.Collection

addElements, addElements, containsAllElementsIn, containsAnyElementsIn, equals, hashCode, isEmpty, iterator, normalizedIndex, removeElements, removeElements, toArray, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface craterdog.core.Sequential

isEmpty, iterator, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface craterdog.core.Composite

toString

Constructor Detail

OrderedCollection

protected OrderedCollection(boolean duplicatesAllowed)

This constructor creates a new empty collection with no comparator function.

Parameters:

duplicatesAllowed - Whether or not duplicate elements are allowed.

OrderedCollection

protected OrderedCollection(E[] elements,
                            boolean duplicatesAllowed)

This constructor creates a new collection with no comparator function and seeds it with the elements from the specified array.

Parameters:

elements - The elements to be used to seed the new collection.

duplicatesAllowed - Whether or not duplicate elements are allowed.

OrderedCollection

protected OrderedCollection(java.lang.Iterable<? extends E> elements,
                            boolean duplicatesAllowed)

This constructor creates a new collection with no comparator function and seeds it with the elements from the specified collection.

Parameters:

elements - The elements to be used to seed the new collection.

duplicatesAllowed - Whether or not duplicate elements are allowed.

OrderedCollection

protected OrderedCollection(boolean duplicatesAllowed,
                            java.util.Comparator<? super E> comparator)

This constructor creates a new collection with the specified comparator function.

Parameters:

duplicatesAllowed - Whether or not duplicate elements are allowed.

comparator - The comparator to be used to compare two elements during ordering.

OrderedCollection

protected OrderedCollection(E[] elements,
                            boolean duplicatesAllowed,
                            java.util.Comparator<? super E> comparator)

This constructor creates a new collection with the specified comparator function and seeds it with the elements from the specified array.

Parameters:

elements - The elements to be used to seed the new collection.

duplicatesAllowed - Whether or not duplicate elements are allowed.

comparator - The comparator to be used to compare two elements during ordering.

OrderedCollection

protected OrderedCollection(java.lang.Iterable<? extends E> elements,
                            boolean duplicatesAllowed,
                            java.util.Comparator<? super E> comparator)

This constructor creates a new collection with the specified comparator function and seeds it with the elements from the specified collection.

Parameters:

elements - The elements to be used to seed the new collection.

duplicatesAllowed - Whether or not duplicate elements are allowed.

comparator - The comparator to be used to compare two elements during ordering.

Method Detail

getNumberOfElements

public final int getNumberOfElements()

Specified by:

getNumberOfElements in interface Sequential<E>

containsElement

public final boolean containsElement(E element)

Description copied from interface: Accessible

This method determines if an element is contained in the collection.

Specified by:

containsElement in interface Accessible<E>

Parameters:

element - The element to be checked for in the collection.

Returns:

Whether or not the specified element is contained in the collection.

createDefaultIterator

public final Iterator<E> createDefaultIterator()

Description copied from interface: Iteratable

This method creates a new default iterator for the collection.

Specified by:

createDefaultIterator in interface Iteratable<E>

Returns:

A new default iterator for the collection.

addElement

public final boolean addElement(E element)

Description copied from interface: Accessible

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.

Specified by:

addElement in interface Accessible<E>

Parameters:

element - The new element to be added.

Returns:

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

removeElement

public final boolean removeElement(E element)

Description copied from interface: Accessible

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

Specified by:

removeElement in interface Accessible<E>

Parameters:

element - The element to be removed.

Returns:

Whether or not the element was found.

removeAllElements

public final void removeAllElements()

Description copied from interface: Iteratable

This method removes all elements from the collection.

Specified by:

removeAllElements in interface Iteratable<E>