org.apache.commons.collections.primitives.decorators

Class UnmodifiableIntListIterator

java.lang.Object

org.apache.commons.collections.primitives.decorators.UnmodifiableIntListIterator

All Implemented Interfaces:

IntIterator, IntListIterator

public final class UnmodifiableIntListIterator
extends Object

Since:

Commons Primitives 1.0

Version:

$Revision$ $Date$

Author:

Rodney Waldhoff

Method Summary

Modifier and Type	Method and Description
void	add(int value) Inserts the specified element into my underlying collection (optional operation).
protected IntIterator	getIterator()
protected IntListIterator	getListIterator()
boolean	hasNext() Returns true iff I have more elements.
boolean	hasPrevious() Returns true iff I have more elements when traversed in the reverse direction.
int	next() Returns the next element in me.
int	nextIndex() Returns the index of the element that would be returned by a subsequent call to IntListIterator.next(), or the number of elements in my iteration if I have no next element.
int	previous() Returns the next element in me when traversed in the reverse direction.
int	previousIndex() Returns the index of the element that would be returned by a subsequent call to IntListIterator.previous(), or -1 if I have no previous element.
void	remove() Removes from my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() (optional operation).
void	set(int value) Replaces in my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() with the specified value (optional operation).
static IntListIterator	wrap(IntListIterator iterator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.collections.primitives.IntListIterator

hasNext, next

Method Detail

remove

public void remove()

Description copied from interface: IntListIterator

Removes from my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() (optional operation).

add

public void add(int value)

Description copied from interface: IntListIterator

Inserts the specified element into my underlying collection (optional operation). The element is inserted immediately before the next element that would have been returned by IntListIterator.next(), if any, and immediately after the next element that would have been returned by IntListIterator.previous(), if any.

The new element is inserted immediately before the implied cursor. A subsequent call to IntListIterator.previous() will return the added element, a subsequent call to IntListIterator.next() will be unaffected. This call increases by one the value that would be returned by a call to IntListIterator.nextIndex() or IntListIterator.previousIndex().

Parameters:

value - the value to be inserted

set

public void set(int value)

Description copied from interface: IntListIterator

Replaces in my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() with the specified value (optional operation).

Parameters:

value - the value to replace the last returned element with

getListIterator

protected IntListIterator getListIterator()

wrap

public static final IntListIterator wrap(IntListIterator iterator)

hasPrevious

public boolean hasPrevious()

Description copied from interface: IntListIterator

Returns true iff I have more elements when traversed in the reverse direction. (In other words, returns true iff a call to IntListIterator.previous() will return an element rather than throwing an exception.

Specified by:

hasPrevious in interface IntListIterator

Returns:

true iff I have more elements when traversed in the reverse direction

nextIndex

public int nextIndex()

Description copied from interface: IntListIterator

Returns the index of the element that would be returned by a subsequent call to IntListIterator.next(), or the number of elements in my iteration if I have no next element.

Specified by:

nextIndex in interface IntListIterator

Returns:

the index of the next element in me

previous

public int previous()

Description copied from interface: IntListIterator

Returns the next element in me when traversed in the reverse direction.

Specified by:

previous in interface IntListIterator

Returns:

the previous element in me

previousIndex

public int previousIndex()

Description copied from interface: IntListIterator

Returns the index of the element that would be returned by a subsequent call to IntListIterator.previous(), or -1 if I have no previous element.

Specified by:

previousIndex in interface IntListIterator

Returns:

the index of the previous element in me

getIterator

protected final IntIterator getIterator()

hasNext

public boolean hasNext()

Description copied from interface: IntIterator

Returns true iff I have more elements. (In other words, returns true iff a subsequent call to next will return an element rather than throwing an exception.)

Specified by:

hasNext in interface IntIterator

Returns:

true iff I have more elements

next

public int next()

Description copied from interface: IntIterator

Returns the next element in me.

Specified by:

next in interface IntIterator

Returns:

the next element in me