craterdog.collections.abstractions

Class OrderedCollection<E>

java.lang.Object

craterdog.smart.SmartObject<Sequence<E>>

craterdog.collections.abstractions.Sequence<E>

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.OpenCollection<E>

craterdog.collections.abstractions.OrderedCollection<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

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

Direct Known Subclasses:

Bag, Set

public abstract class OrderedCollection<E>
extends OpenCollection<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.
craterdog.core.Iterator<E>	createIterator()
java.util.Comparator<? super E>	getComparator() This method returns the comparator that is used to order the elements in this collection.
E	getElement(int index) This method returns the element at the specified index.
OrderedCollection<E>	getElements(int firstIndex, int lastIndex) This method returns a collection of the elements in the specified index range.
int	getIndex(E element) This method return the index of the specified element, or zero if the element is not found.
int	getSize()
void	removeAll() 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.OpenCollection

addElements, addElements, removeElements, removeElements

Methods inherited from class craterdog.collections.abstractions.Collection

containsAll, containsAny, containsElement, normalizedIndex

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

isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

createIterator

public craterdog.core.Iterator<E> createIterator()

getSize

public int getSize()

getElement

public E getElement(int index)

Description copied from class: Collection

This method returns the element at the specified index.

Specified by:

getElement in class Collection<E>

Parameters:

index - The index of the element to be returned.

Returns:

The element at the specified index.

getIndex

public int getIndex(E element)

Description copied from class: Collection

This method return the index of the specified element, or zero if the element is not found.

Specified by:

getIndex in class Collection<E>

Parameters:

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

Returns:

The index of the element of zero if the element was not found.

getElements

public OrderedCollection<E> getElements(int firstIndex,
                                        int lastIndex)

Description copied from class: Collection

This method returns a collection of the elements in the specified index range.

Specified by:

getElements in class Collection<E>

Parameters:

firstIndex - The index of the first element to be returned.

lastIndex - the index of the last element to be returned.

Returns:

A collection of elements in the specified range.

addElement

public boolean addElement(E element)

Description copied from class: OpenCollection

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 class OpenCollection<E>

Parameters:

element - The new element to be added.

Returns:

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

removeElement

public boolean removeElement(E element)

Description copied from class: OpenCollection

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 class OpenCollection<E>

Parameters:

element - The element to be removed.

Returns:

Whether or not the element was found.

removeAll

public void removeAll()

Description copied from class: Collection

This method removes all elements from the collection.

Specified by:

removeAll in class Collection<E>

getComparator

public java.util.Comparator<? super E> getComparator()

This method returns the comparator that is used to order the elements in this collection.

Returns:

The comparator that is used to order the elements in this collection.