com.runehive.util.ArrayIterator< E > Class Template Reference

An Iterator implementation that will iterate over the elements in an array without the overhead of the ArrayLists withdraw operation. More...

Inheritance diagram for com.runehive.util.ArrayIterator< E >:

Collaboration diagram for com.runehive.util.ArrayIterator< E >:

Public Member Functions
	ArrayIterator (E[] array)
	Creates a new ArrayIterator.
boolean	hasNext ()
E	next ()
E	peek ()
void	remove ()

Private Attributes
final E[]	array
	The array that is storing the elements.
int	index
	The current index that the iterator is iterating over.
int	lastIndex = -1
	The last index that the iterator iterated over.

Detailed Description

An Iterator implementation that will iterate over the elements in an array without the overhead of the ArrayLists withdraw operation.

Parameters

<E>	the type of array being iterated over.

Author

lare96 http://github.com/lare96

Definition at line 15 of file ArrayIterator.java.

Constructor & Destructor Documentation

ArrayIterator()

com.runehive.util.ArrayIterator< E >.ArrayIterator

(

E[]

array

)

Creates a new ArrayIterator.

Parameters

array

the array that is storing the elements.

Definition at line 36 of file ArrayIterator.java.

                                    {
        this.array = array;
    }

References array.

Member Function Documentation

hasNext()

boolean com.runehive.util.ArrayIterator< E >.hasNext

(

)

Definition at line 41 of file ArrayIterator.java.

                             {
        return !(index + 1 > array.length);
    }

References array, and index.

next()

E com.runehive.util.ArrayIterator< E >.next

(

)

Definition at line 51 of file ArrayIterator.java.

                    {
        if(index >= array.length)
            throw new ArrayIndexOutOfBoundsException("There are no elements left to iterate over!");
        lastIndex = index;
        index++;
        return array[lastIndex];
    }

References array, index, and lastIndex.

peek()

E com.runehive.util.ArrayIterator< E >.peek

(

)

Definition at line 46 of file ArrayIterator.java.

                    {
        return array[index];
    }

References array, and index.

remove()

void com.runehive.util.ArrayIterator< E >.remove

(

)

Definition at line 60 of file ArrayIterator.java.

                         {
        if(lastIndex == -1)
            throw new IllegalStateException("This method can only be called once after \"next\".");
        array[lastIndex] = null;
        lastIndex = -1;
    }

References array, and lastIndex.

Member Data Documentation

array

final E [] com.runehive.util.ArrayIterator< E >.array

private

The array that is storing the elements.

Definition at line 20 of file ArrayIterator.java.

Referenced by ArrayIterator(), hasNext(), next(), peek(), and remove().

index

int com.runehive.util.ArrayIterator< E >.index

private

The current index that the iterator is iterating over.

Definition at line 25 of file ArrayIterator.java.

Referenced by hasNext(), next(), and peek().

lastIndex

int com.runehive.util.ArrayIterator< E >.lastIndex = -1

private

The last index that the iterator iterated over.

Definition at line 30 of file ArrayIterator.java.

Referenced by next(), and remove().

---

The documentation for this class was generated from the following file:

• java/com/runehive/util/ArrayIterator.java