craterdog.collections.interfaces

Interface Indexed<E>

Type Parameters:

E - The type of element managed by the collection.

All Known Implementing Classes:

List

public interface Indexed<E>

This interface defines the methods that must be implemented by each collection that its elements to be manipulated based on their indexes. The indexing is unit based and allows positive indexes starting at the beginning of the collection or negative indexes starting at the end of the collection as follows:

         1             2             3               N
    [element 1] . [element 2] . [element 3] ... [element N]
        -N          -(N-1)        -(N-2)            -1
 

Author:

Derk Norton

Method Summary

Modifier and Type	Method and Description
E	getElementAtIndex(int index) This method returns the element at the specified index.
Indexed<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	insertElementBeforeIndex(E element, int index) This method inserts the specified element into the collection before the element associated with the specified index.
void	insertElementsBeforeIndex(java.lang.Iterable<? extends E> elements, int index) This method inserts the specified elements into the collection before the element associated with the specified index.
E	removeElementAtIndex(int index) This method removes from the collection the element associated with the specified index.
Indexed<E>	removeElementsInRange(int firstIndex, int lastIndex) This method removes from the collection the elements associated with the specified index range.
E	replaceElementAtIndex(E element, int index) This method replaces an existing element in the collection with a new one.

Method Detail

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

Indexed<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.

insertElementBeforeIndex

void insertElementBeforeIndex(E element,
                              int index)

This method inserts the specified element into the collection before the element associated with the specified index.

Parameters:

element - The new element to be inserted into the collection.

index - The index of the element before which the new element is to be inserted.

insertElementsBeforeIndex

void insertElementsBeforeIndex(java.lang.Iterable<? extends E> elements,
                               int index)

This method inserts the specified elements into the collection before the element associated with the specified index. The new elements are inserted in the same order as they appear in the specified list.

Parameters:

elements - The new elements to be inserted into the collection.

index - The index of the element before which the new element is to be inserted.

replaceElementAtIndex

E replaceElementAtIndex(E element,
                        int index)

This method replaces an existing element in the collection with a new one. The new element replaces the existing element at the specified index.

Parameters:

element - The new element that will replace the existing one.

index - The index of the existing element.

Returns:

The element that was at the specified index.

removeElementAtIndex

E removeElementAtIndex(int index)

This method removes from the collection the element associated with the specified index.

Parameters:

index - The index of the element to be removed.

Returns:

The element at the specified index.

removeElementsInRange

Indexed<E> removeElementsInRange(int firstIndex,
                                 int lastIndex)

This method removes from the collection the elements associated with the specified index range.

Parameters:

firstIndex - The index of the first element to be removed.

lastIndex - The index of the last element to be removed.

Returns:

The list of the elements that were removed from the collection.