craterdog.collections.abstractions

Class Collection<E>

java.lang.Object

craterdog.collections.abstractions.Collection<E>

Type Parameters:

E - The type of element managed by the collection.

All Implemented Interfaces:

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

Direct Known Subclasses:

ClosedCollection, OpenCollection

public abstract class Collection<E>
extends java.lang.Object
implements java.lang.Comparable<Collection<E>>, Accessible<E>, Sequential<E>, Composite

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
int	compareTo(Collection<E> that)
boolean	containsAllElementsIn(java.lang.Iterable<? extends E> collection) This method determines whether all of the specified elements are contained in the collection.
boolean	containsAnyElementsIn(java.lang.Iterable<? extends E> collection) 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.
boolean	equals(java.lang.Object object)
int	hashCode()
boolean	isEmpty()
Iterator<E>	iterator()
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].
E[]	toArray()
void	toArray(E[] array) Deprecated.
java.lang.String	toString()
java.lang.String	toString(java.lang.String indentation)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface craterdog.collections.interfaces.Accessible

createDefaultIterator, getElementAtIndex, getElementsInRange, getIndexOfElement, removeAllElements

Methods inherited from interface craterdog.core.Sequential

getNumberOfElements

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Collection

public Collection()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String indentation)

Specified by:

toString in interface Composite

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Collection<E> that)

Specified by:

compareTo in interface java.lang.Comparable<Collection<E>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Sequential<E>

containsElement

public boolean containsElement(E element)

Description copied from interface: Accessible

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

Specified by:

containsElement in interface Accessible<E>

Parameters:

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

Returns:

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

containsAnyElementsIn

public boolean containsAnyElementsIn(java.lang.Iterable<? extends E> collection)

Description copied from interface: Accessible

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

Specified by:

containsAnyElementsIn in interface Accessible<E>

Parameters:

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

Returns:

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

containsAllElementsIn

public boolean containsAllElementsIn(java.lang.Iterable<? extends E> collection)

Description copied from interface: Accessible

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

Specified by:

containsAllElementsIn in interface Accessible<E>

Parameters:

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

Returns:

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

toArray

@Deprecated
public void toArray(E[] array)

Deprecated.

Specified by:

toArray in interface Sequential<E>

toArray

public E[] toArray()

Specified by:

toArray in interface Sequential<E>

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Sequential<E>

Specified by:

iterator in interface java.lang.Iterable<E>

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.