org.apache.commons.collections.primitives.decorators

Class UnmodifiableCharListIterator

java.lang.Object

org.apache.commons.collections.primitives.decorators.UnmodifiableCharListIterator

All Implemented Interfaces:

CharIterator, CharListIterator

public final class UnmodifiableCharListIterator
extends Object

Since:

Commons Primitives 1.0

Version:

$Revision$ $Date$

Author:

Rodney Waldhoff

Method Summary

Modifier and Type	Method and Description
void	add(char value) Inserts the specified element into my underlying collection (optional operation).
protected CharIterator	getIterator()
protected CharListIterator	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.
char	next() Returns the next element in me.
int	nextIndex() Returns the index of the element that would be returned by a subsequent call to CharListIterator.next(), or the number of elements in my iteration if I have no next element.
char	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 CharListIterator.previous(), or -1 if I have no previous element.
void	remove() Removes from my underlying collection the last element returned by CharListIterator.next() or CharListIterator.previous() (optional operation).
void	set(char value) Replaces in my underlying collection the last element returned by CharListIterator.next() or CharListIterator.previous() with the specified value (optional operation).
static CharListIterator	wrap(CharListIterator 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.CharListIterator

hasNext, next

Method Detail

remove

public void remove()

Description copied from interface: CharListIterator

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

add

public void add(char value)

Description copied from interface: CharListIterator

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 CharListIterator.next(), if any, and immediately after the next element that would have been returned by CharListIterator.previous(), if any.

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

Parameters:

value - the value to be inserted

set

public void set(char value)

Description copied from interface: CharListIterator

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

Parameters:

value - the value to replace the last returned element with

getListIterator

protected CharListIterator getListIterator()

wrap

public static final CharListIterator wrap(CharListIterator iterator)

hasPrevious

public boolean hasPrevious()

Description copied from interface: CharListIterator

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

Specified by:

hasPrevious in interface CharListIterator

Returns:

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

nextIndex

public int nextIndex()

Description copied from interface: CharListIterator

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

Specified by:

nextIndex in interface CharListIterator

Returns:

the index of the next element in me

previous

public char previous()

Description copied from interface: CharListIterator

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

Specified by:

previous in interface CharListIterator

Returns:

the previous element in me

previousIndex

public int previousIndex()

Description copied from interface: CharListIterator

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

Specified by:

previousIndex in interface CharListIterator

Returns:

the index of the previous element in me

getIterator

protected final CharIterator getIterator()

hasNext

public boolean hasNext()

Description copied from interface: CharIterator

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 CharIterator

Returns:

true iff I have more elements

next

public char next()

Description copied from interface: CharIterator

Returns the next element in me.

Specified by:

next in interface CharIterator

Returns:

the next element in me