craterdog.collections.abstractions

Class SortableCollection<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.SortableCollection<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

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

Direct Known Subclasses:

List, Map

public abstract class SortableCollection<E>
extends Collection<E>
implements Sortable<E>

This abstract class defines the invariant methods that all sortable collections must inherit. A sortable collection allows the order of its elements to be determined externally. By default, the elements will be placed in the order in which they were added to the collection. Additionally, the elements can be sorted in various ways depending on a specified sorting algorithm and comparison function.

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
SortableCollection()

Method Summary

Modifier and Type	Method and Description
static <E> SortableCollection<E>	concatenate(SortableCollection<E> collection1, SortableCollection<E> collection2) This method returns a new collection that is the concatenation of this collection with the specified collection.
void	sortElements(java.util.Comparator<? super E> comparator) This method sorts the elements in the collection using the default (merge) sorting algorithm and the specified comparison function.
void	sortElements(Sorter<E> sorter, java.util.Comparator<? super E> comparator) This method sorts the elements in the collection using the specified sorting algorithm and the specified comparison function.
protected Sorter<E>	sorter() This method returns a sorter that can be used by any subclass to sort its elements.

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.collections.interfaces.Sortable

createDefaultManipulator

Methods inherited from interface craterdog.collections.interfaces.Iteratable

createDefaultIterator, removeAllElements

Methods inherited from interface craterdog.core.Sequential

getNumberOfElements, isEmpty, iterator, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface craterdog.core.Composite

toString

Methods inherited from interface craterdog.collections.interfaces.Accessible

addElement, containsElement, removeElement

Constructor Detail

SortableCollection

public SortableCollection()

Method Detail

sortElements

public final void sortElements(java.util.Comparator<? super E> comparator)

Description copied from interface: Sortable

This method sorts the elements in the collection using the default (merge) sorting algorithm and the specified comparison function.

Specified by:

sortElements in interface Sortable<E>

Parameters:

comparator - The desired comparison function.

sortElements

public final void sortElements(Sorter<E> sorter,
                               java.util.Comparator<? super E> comparator)

Description copied from interface: Sortable

This method sorts the elements in the collection using the specified sorting algorithm and the specified comparison function.

Specified by:

sortElements in interface Sortable<E>

Parameters:

sorter - The desired sorting algorithm.

comparator - The desired comparison function.

concatenate

public static <E> SortableCollection<E> concatenate(SortableCollection<E> collection1,
                                                    SortableCollection<E> collection2)

This method returns a new collection that is the concatenation of this collection with the specified collection.

Type Parameters:

E - The type of element contained in the collections.

Parameters:

collection1 - The first collection to be concatenated.

collection2 - The second collection to be concatenated.

Returns:

The resulting collection.

sorter

protected Sorter<E> sorter()

This method returns a sorter that can be used by any subclass to sort its elements.

Returns:

The default sorter algorithm.