craterdog.collections.interfaces

Interface Accessible<E>

Type Parameters:

E - The type of element managed by the collection.

All Superinterfaces:

Composite, java.lang.Iterable<E>, Iteratable<E>, Sequential<E>

All Known Implementing Classes:

Bag, Collection, Dictionary, List, Map, OrderedCollection, Set, SortableCollection

public interface Accessible<E>
extends Iteratable<E>

This interface defines the methods that must be implemented by each collection that allows direct access to its elements.

Author:

Derk Norton

Method Summary

Modifier and Type	Method and Description
boolean	addElement(E element) This method adds a new element to the collection.
int	addElements(E[] elements) This method adds an array of new elements to the collection.
int	addElements(java.lang.Iterable<? extends E> elements) This method adds a list of new elements to the collection.
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.
boolean	removeElement(E element) This method removes the specified element from the collection.
int	removeElements(E[] elements) This method removes the elements in the specified array from the collection.
int	removeElements(java.lang.Iterable<? extends E> elements) This method removes the specified elements from the collection.

Methods inherited from interface craterdog.collections.interfaces.Iteratable

createDefaultIterator, removeAllElements

Methods inherited from interface craterdog.core.Sequential

getNumberOfElements, isEmpty, iterator, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface craterdog.core.Composite

toString

Method Detail

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.

addElement

boolean addElement(E element)

This method adds a new element to the collection. If the collection is empty then the new element will be the first element in the collection.

Parameters:

element - The new element to be added.

Returns:

Whether or not the element was actually added to the collection.

addElements

int addElements(E[] elements)

This method adds an array of new elements to the collection. The new elements will be added in the order they appear in the specified array.

Parameters:

elements - The array of new elements to be added.

Returns:

The number of elements that were actually added to the collection.

addElements

int addElements(java.lang.Iterable<? extends E> elements)

This method adds a list of new elements to the collection. The new elements will be added in the order they appear in the specified collection.

Parameters:

elements - The list of new elements to be added.

Returns:

The number of elements that were actually added to the collection.

removeElement

boolean removeElement(E element)

This method removes the specified element from the collection. If the element is not found in the collection, no changes are made.

Parameters:

element - The element to be removed.

Returns:

Whether or not the element was found.

removeElements

int removeElements(E[] elements)

This method removes the elements in the specified array from the collection. The number of matching elements is returned.

Parameters:

elements - The array of elements to be removed from the collection.

Returns:

The number of elements that were actually removed.

removeElements

int removeElements(java.lang.Iterable<? extends E> elements)

This method removes the specified elements from the collection. The number of matching elements is returned.

Parameters:

elements - The list of elements to be removed from the collection.

Returns:

The number of elements that were actually removed.