craterdog.collections.abstractions

Class SortableCollection<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.SortableCollection<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:

List, Map

public abstract class SortableCollection<E>
extends OpenCollection<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.
abstract craterdog.core.Manipulator<E>	createManipulator() This method creates a new default manipulator for the collection.
void	shuffleElements() This method shuffles the elements in the collection using a randomizing algorithm.
void	sortElements() This method sorts the elements in the collection using the default (merge) sorting algorithm and the elements' compareTo method.
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.

Methods inherited from class craterdog.collections.abstractions.OpenCollection

addElement, addElements, addElements, removeElement, removeElements, removeElements

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

SortableCollection

public SortableCollection()

Method Detail

shuffleElements

public void shuffleElements()

This method shuffles the elements in the collection using a randomizing algorithm.

sortElements

public void sortElements()

This method sorts the elements in the collection using the default (merge) sorting algorithm and the elements' compareTo method. It provides an easy way to sort a collection using its natural ordering.

sortElements

public 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.

Parameters:

comparator - The desired comparison function.

sortElements

public 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.

Parameters:

sorter - The desired sorting algorithm.

comparator - The desired comparison function.

createManipulator

public abstract craterdog.core.Manipulator<E> createManipulator()

This method creates a new default manipulator for the collection.

Returns:

The new manipulator.

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.