craterdog.collections.abstractions

Class Manipulator<E>

java.lang.Object

craterdog.collections.abstractions.Iterator<E>

craterdog.collections.abstractions.Manipulator<E>

Type Parameters:

E - The type of the element being manipulated.

All Implemented Interfaces:

java.util.Iterator<E>

public abstract class Manipulator<E>
extends Iterator<E>

This abstract class extends the Iterator class by allowing the manipulation of the collection's elements. Just like an iterator, a manipulator points at the slots on either side of the elements in a collection.

            [element 1]   [element 2]   [element 3]  ...  [element N]
          ^             ^             ^             ^   ^             ^
       at start                                                    at end
 

Author:

Derk Norton

Constructor Summary

Constructors

Constructor and Description
Manipulator()

Method Summary

Modifier and Type	Method and Description
abstract void	insertElement(E element) This method inserts a new element in the slot currently pointed at by the manipulator.
abstract E	removeNextElement() This method removes the element after the slot where the manipulator is currently pointing.
abstract E	removePreviousElement() This method removes the element before the slot where the manipulator is currently pointing.

Methods inherited from class craterdog.collections.abstractions.Iterator

getNextElement, getPreviousElement, goToEnd, goToIndex, goToStart, hasNext, hasNextElement, hasPreviousElement, next, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

Manipulator

public Manipulator()

Method Detail

insertElement

public abstract void insertElement(E element)

This method inserts a new element in the slot currently pointed at by the manipulator. If this collection is empty then the new element becomes the first element in the collection.

Parameters:

element - The new element to be inserted.

removeNextElement

public abstract E removeNextElement()

This method removes the element after the slot where the manipulator is currently pointing. If the manipulator is at the end of this collection an exception is thrown.

Returns:

The removed next element.

removePreviousElement

public abstract E removePreviousElement()

This method removes the element before the slot where the manipulator is currently pointing. If the manipulator is at the start of this collection an exception is thrown.

Returns:

The removed previous element.