craterdog.collections.abstractions

Class ClosedCollection<E>

java.lang.Object

craterdog.smart.SmartObject<Sequence<E>>

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

craterdog.core.Composite, craterdog.core.Sequential<E>, java.lang.Comparable<Sequence<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
craterdog.core.Iterator<E>	createIterator()
E	getElement(int index) This method returns the element at the specified index.
Collection<E>	getElements(int firstIndex, int lastIndex) This method returns a collection of the elements in the specified index range.
int	getIndex(E element) This method return the index of the specified element, or zero if the element is not found.
int	getSize()
void	removeAll() This method removes all elements from the collection.

Methods inherited from class craterdog.collections.abstractions.Collection

containsAll, containsAny, containsElement, normalizedIndex

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

isEmpty, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

list

protected final List<E> list

Constructor Detail

ClosedCollection

public ClosedCollection()

Method Detail

createIterator

public craterdog.core.Iterator<E> createIterator()

getSize

public int getSize()

getElement

public E getElement(int index)

Description copied from class: Collection

This method returns the element at the specified index.

Specified by:

getElement in class Collection<E>

Parameters:

index - The index of the element to be returned.

Returns:

The element at the specified index.

getIndex

public int getIndex(E element)

Description copied from class: Collection

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

Specified by:

getIndex in class Collection<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.

getElements

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

Description copied from class: Collection

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

Specified by:

getElements in class Collection<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.

removeAll

public void removeAll()

Description copied from class: Collection

This method removes all elements from the collection.

Specified by:

removeAll in class Collection<E>