org.apache.commons.collections.primitives

Interface CharListIterator

public interface CharListIterator extends CharIterator

A bi-directional iterator over char values.

Since: Commons Primitives 1.0

Version: $Revision: 1.3 $ $Date: 2003/10/16 20:49:36 $

Author: Rodney Waldhoff

See Also: CharListIteratorListIterator

Method Summary
voidadd(char element)
Inserts the specified element into my underlying collection (optional operation).
booleanhasNext()
Returns true iff I have more elements when traversed in the forward direction.
booleanhasPrevious()
Returns true iff I have more elements when traversed in the reverse direction.
charnext()
Returns the next element in me when traversed in the forward direction.
intnextIndex()
Returns the index of the element that would be returned by a subsequent call to CharListIterator, or the number of elements in my iteration if I have no next element.
charprevious()
Returns the next element in me when traversed in the reverse direction.
intpreviousIndex()
Returns the index of the element that would be returned by a subsequent call to CharListIterator, or -1 if I have no previous element.
voidremove()
Removes from my underlying collection the last element returned by CharListIterator or CharListIterator (optional operation).
voidset(char element)
Replaces in my underlying collection the last element returned by CharListIterator or CharListIterator with the specified value (optional operation).

Method Detail

add

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

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

Parameters: element the value to be inserted

Throws: UnsupportedOperationException when this operation is not supported IllegalArgumentException if some aspect of the specified element prevents it from being added

hasNext

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

Returns: true iff I have more elements when traversed in the forward direction

hasPrevious

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

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

next

public char next()
Returns the next element in me when traversed in the forward direction.

Returns: the next element in me

Throws: NoSuchElementException if there is no next element

nextIndex

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

Returns: the index of the next element in me

previous

public char previous()
Returns the next element in me when traversed in the reverse direction.

Returns: the previous element in me

Throws: NoSuchElementException if there is no previous element

previousIndex

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

Returns: the index of the previous element in me

remove

public void remove()
Removes from my underlying collection the last element returned by CharListIterator or CharListIterator (optional operation).

Throws: UnsupportedOperationException if this operation is not supported IllegalStateException if neither CharListIterator nor CharListIterator has yet been called, or CharListIterator or CharListIterator has already been called since the last call to CharListIterator or CharListIterator.

set

public void set(char element)
Replaces in my underlying collection the last element returned by CharListIterator or CharListIterator with the specified value (optional operation).

Parameters: element the value to replace the last returned element with

Throws: UnsupportedOperationException if this operation is not supported IllegalStateException if neither CharListIterator nor CharListIterator has yet been called, or CharListIterator or CharListIterator has already been called since the last call to CharListIterator or CharListIterator. IllegalArgumentException if some aspect of the specified element prevents it from being added

Copyright (c) 2002-2003 - Apache Software Foundation