craterdog.collections.interfaces

Interface Accessible<E>

Type Parameters:

E - The type of element managed by the collection.

All Known Implementing Classes:

Bag, ClosedCollection, Collection, Dictionary, List, Map, OpenCollection, OrderedCollection, Queue, Set, SortableCollection, Stack

public interface Accessible<E>

This interface defines the methods that must be implemented by each collection whose elements can be iterated over.

Author:

Derk Norton

Method Summary

Modifier and Type	Method and Description
boolean	containsAllElementsIn(java.lang.Iterable<? extends E> elements) This method determines whether all of the specified elements are contained in the collection.
boolean	containsAnyElementsIn(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.
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.
Accessible<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.
void	removeAllElements() This method removes all elements from the collection.

Method Detail

createDefaultIterator

Iterator<E> createDefaultIterator()

This method creates a new default iterator for the collection.

Returns:

A new default iterator for the collection.

containsElement

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.

containsAnyElementsIn

boolean containsAnyElementsIn(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.

containsAllElementsIn

boolean containsAllElementsIn(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.

getIndexOfElement

int getIndexOfElement(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.

getElementAtIndex

E getElementAtIndex(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.

getElementsInRange

Accessible<E> getElementsInRange(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.

removeAllElements

void removeAllElements()

This method removes all elements from the collection.