net.pwall.util

Class ImmutableListIterator<T>

java.lang.Object

net.pwall.util.ImmutableIteratorBase<T>

net.pwall.util.ImmutableIterator<T>

net.pwall.util.ImmutableListIterator<T>

Type Parameters:

T - the collection element type

All Implemented Interfaces:

Iterator<T>, ListIterator<T>

public class ImmutableListIterator<T>
extends ImmutableIterator<T>
implements ListIterator<T>

Implementation of ListIterator to provide functionality for the immutable classes.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
ImmutableListIterator(T[] array, int length, int index) Construct an ImmutableListIterator with the given array and length, and with the given starting index.

Method Summary

Modifier and Type	Method and Description
void	add(T t) Modifying operation - not allowed.
boolean	hasPrevious() Test whether the iterator has any preceding elements.
int	nextIndex() Get the index of the "next" element.
T	previous() Get the preceding element referenced by this ImmutableIterator.
int	previousIndex() Get the index of the previous element.
void	remove() Modifying operation - not allowed.
void	set(T t) Modifying operation - not allowed.

Methods inherited from class net.pwall.util.ImmutableIterator

next

Methods inherited from class net.pwall.util.ImmutableIteratorBase

checkNext, hasNext

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.ListIterator

hasNext, next

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ImmutableListIterator

public ImmutableListIterator(T[] array,
                             int length,
                             int index)

Construct an ImmutableListIterator with the given array and length, and with the given starting index.

Parameters:

array - the array

length - the length (the number of array items to be considered part of the collection)

index - the starting index

Method Detail

hasPrevious

public boolean hasPrevious()

Test whether the iterator has any preceding elements.

Specified by:

hasPrevious in interface ListIterator<T>

Returns:

true if there is at least one preceding element available

previous

public T previous()

Get the preceding element referenced by this ImmutableIterator.

Specified by:

previous in interface ListIterator<T>

Returns:

the preceding element

Throws:

NoSuchElementException - if there is no preceding element

nextIndex

public int nextIndex()

Get the index of the "next" element.

Specified by:

nextIndex in interface ListIterator<T>

Returns:

the "next" index

previousIndex

public int previousIndex()

Get the index of the previous element.

Specified by:

previousIndex in interface ListIterator<T>

Returns:

the "previous" index

remove

public void remove()

Modifying operation - not allowed.

Specified by:

remove in interface Iterator<T>

Specified by:

remove in interface ListIterator<T>

Throws:

UnsupportedOperationException - (in all cases)

set

public void set(T t)

Modifying operation - not allowed.

Specified by:

set in interface ListIterator<T>

Throws:

UnsupportedOperationException - (in all cases)

add

public void add(T t)

Modifying operation - not allowed.

Specified by:

add in interface ListIterator<T>

Throws:

UnsupportedOperationException - (in all cases)