OrderedCollection (Crater Dog Java Collection Framework 3.7 API)

java.lang.Object
- craterdog.smart.SmartObject<Collection<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:

Accessible<E>, Dynamic<E>, Ordered<E>, Composite, Sequential<E>, java.lang.Comparable<Collection<E>>, java.lang.Iterable<E>

Direct Known Subclasses:

Bag, Set
```
public abstract class OrderedCollection<E>
extends OpenCollection<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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addElement(E element)` This method adds a new element to the collection.
`Iterator<E>`	`createDefaultIterator()` This method creates a new default iterator for the collection.
`java.util.Comparator<? super E>`	`getComparator()` This method returns the comparator that is used to order the elements in this collection.
`E`	`getElementAtIndex(int index)` This method returns the element at the specified index.
`OrderedCollection<E>`	`getElementsInRange(int firstIndex, int lastIndex)` This method returns a collection of the elements in the specified index range.
`int`	`getIndexOfElement(E element)` This method return the index of the specified element, or zero if the element is not found.
`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.OpenCollection
addElements, addElements, removeElements, removeElements

Methods inherited from class craterdog.collections.abstractions.Collection
compareTo, containsAllElementsIn, containsAnyElementsIn, containsElement, equals, hashCode, isEmpty, iterator, normalizedIndex, toArray

Methods inherited from class craterdog.smart.SmartObject
addSerializableClass, addSerializableClass, copy, toExposedString, toString, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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
  - createDefaultIterator
```
public Iterator<E> createDefaultIterator()
```
    Description copied from interface: Accessible
    
    This method creates a new default iterator for the collection.
    
    Specified by:
    
    createDefaultIterator in interface Accessible<E>
    
    Returns:
    
    A new default iterator for the collection.
  - getNumberOfElements
```
public int getNumberOfElements()
```
    Specified by:
    
    getNumberOfElements in interface Sequential<E>
  - getElementAtIndex
```
public E getElementAtIndex(int index)
```
    Description copied from interface: Accessible
    
    This method returns the element at the specified index.
    
    Specified by:
    
    getElementAtIndex in interface Accessible<E>
    
    Parameters:
    
    index - The index of the element to be returned.
    
    Returns:
    
    The element at the specified index.
  - getIndexOfElement
```
public int getIndexOfElement(E element)
```
    Description copied from interface: Accessible
    
    This method return the index of the specified element, or zero if the element is not found.
    
    Specified by:
    
    getIndexOfElement in interface Accessible<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.
  - getElementsInRange
```
public OrderedCollection<E> getElementsInRange(int firstIndex,
                                               int lastIndex)
```
    Description copied from interface: Accessible
    
    This method returns a collection of the elements in the specified index range.
    
    Specified by:
    
    getElementsInRange in interface Accessible<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 interface: Dynamic
    
    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 Dynamic<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 interface: Dynamic
    
    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 Dynamic<E>
    
    Parameters:
    
    element - The element to be removed.
    
    Returns:
    
    Whether or not the element was found.
  - removeAllElements
```
public void removeAllElements()
```
    Description copied from interface: Accessible
    
    This method removes all elements from the collection.
    
    Specified by:
    
    removeAllElements in interface Accessible<E>
  - getComparator
```
public java.util.Comparator<? super E> getComparator()
```
    Description copied from interface: Ordered
    
    This method returns the comparator that is used to order the elements in this collection.
    
    Specified by:
    
    getComparator in interface Ordered<E>
    
    Returns:
    
    The comparator that is used to order the elements in this collection.

Class OrderedCollection<E>

Constructor Summary

Method Summary

Methods inherited from class craterdog.collections.abstractions.OpenCollection

Methods inherited from class craterdog.collections.abstractions.Collection

Methods inherited from class craterdog.smart.SmartObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

OrderedCollection

OrderedCollection

OrderedCollection

OrderedCollection

OrderedCollection

OrderedCollection

Method Detail

createDefaultIterator

getNumberOfElements

getElementAtIndex

getIndexOfElement

getElementsInRange

addElement

removeElement

removeAllElements

getComparator