craterdog.collections.abstractions

Class ClosedCollection<E>

java.lang.Object

craterdog.smart.SmartObject<Collection<E>>

craterdog.collections.abstractions.Collection<E>

craterdog.collections.abstractions.ClosedCollection<E>

Type Parameters:

E - The type of element managed by this collection.

All Implemented Interfaces:

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

Direct Known Subclasses:

Queue, Stack

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

This abstract class implements a collection that does not allow its internal structure to be directly manipulated.

Author:

Derk Norton

Field Summary

Fields

Modifier and Type	Field and Description
protected List<E>	list

Constructor Summary

Constructors

Constructor and Description
ClosedCollection()

Method Summary

Modifier and Type	Method and Description
Iterator<E>	createDefaultIterator() This method creates a new default iterator for the collection.
E	getElementAtIndex(int index) This method returns the element at the specified index.
Collection<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.

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

Field Detail

list

protected final List<E> list

Constructor Detail

ClosedCollection

public ClosedCollection()

Method Detail

createDefaultIterator

public Iterator<E> createDefaultIterator()

Description copied from interface: Accessible

This method creates a new default iterator for the collection.

Returns:

A new default iterator for the collection.

getNumberOfElements

public int getNumberOfElements()

getElementAtIndex

public E getElementAtIndex(int index)

Description copied from interface: Accessible

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.

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.

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 Collection<E> getElementsInRange(int firstIndex,
                                        int lastIndex)

Description copied from interface: Accessible

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.

removeAllElements

public void removeAllElements()

Description copied from interface: Accessible

This method removes all elements from the collection.