craterdog.collections.abstractions

Class Collection<E>

java.lang.Object

craterdog.smart.SmartObject<Sequence<E>>

craterdog.collections.abstractions.Sequence<E>

craterdog.collections.abstractions.Collection<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:

ClosedCollection, OpenCollection

public abstract class Collection<E>
extends Sequence<E>

This abstract class defines the invariant methods that all collections must inherit.

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
Collection()

Method Summary

Modifier and Type	Method and Description
boolean	containsAll(java.lang.Iterable<? extends E> elements) This method determines whether all of the specified elements are contained in the collection.
boolean	containsAny(java.lang.Iterable<? extends E> elements) This method determines whether any of the specified elements are contained in the collection.
boolean	containsElement(E element) This method determines if an element is contained in the collection.
abstract E	getElement(int index) This method returns the element at the specified index.
abstract Collection<E>	getElements(int firstIndex, int lastIndex) This method returns a collection of the elements in the specified index range.
abstract int	getIndex(E element) This method return the index of the specified element, or zero if the element is not found.
protected int	normalizedIndex(int index) This method converts negative indexes into their corresponding positive indexes and then checks to make sure the index is in the range [1..size].
abstract void	removeAll() This method removes all elements from the collection.

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

Collection

public Collection()

Method Detail

getIndex

public abstract int getIndex(E element)

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

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.

getElement

public abstract E getElement(int index)

This method returns the element at the specified index.

Parameters:

index - The index of the element to be returned.

Returns:

The element at the specified index.

getElements

public abstract Collection<E> getElements(int firstIndex,
                                          int lastIndex)

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

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.

containsElement

public boolean containsElement(E element)

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

Parameters:

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

Returns:

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

containsAny

public boolean containsAny(java.lang.Iterable<? extends E> elements)

This method determines whether any of the specified elements are contained in the collection.

Parameters:

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

Returns:

Whether or not any of the specified elements are contained in the collection.

containsAll

public boolean containsAll(java.lang.Iterable<? extends E> elements)

This method determines whether all of the specified elements are contained in the collection.

Parameters:

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

Returns:

Whether or not all of the specified elements are contained in the collection.

removeAll

public abstract void removeAll()

This method removes all elements from the collection.

normalizedIndex

protected final int normalizedIndex(int index)

This method converts negative indexes into their corresponding positive indexes and then checks to make sure the index is in the range [1..size]. The mapping between indexes is as follows:

 Negative Indexes:   -N      -N + 1     -N + 2     -N + 3   ...   -1
 Positive Indexes:    1         2          3          4     ...    N
 

Parameters:

index - The index to be normalized.

Returns:

The normalized [1..N] index.