org.apache.commons.collections.primitives.adapters
Class IteratorCharIterator

java.lang.Object
  |
  +--org.apache.commons.collections.primitives.adapters.IteratorCharIterator

All Implemented Interfaces:

CharIterator

public class IteratorCharIterator

extends Object

implements CharIterator

Adapts a Number-valued Iterator to the CharIterator interface.

This implementation delegates most methods to the provided Iterator implementation in the "obvious" way.

Since:

Commons Primitives 1.0

Version:

$Revision: 1.3 $ $Date: 2003/10/16 20:49:39 $

Constructor Summary

IteratorCharIterator(Iterator iterator)
Creates an CharIterator wrapping the specified Iterator.

Method Summary

boolean	hasNext() Returns true iff I have more elements.
char	next() Returns the next element in me.
void	remove() Removes from my underlying collection the last element returned by me (optional operation).
static org.apache.commons.collections.primitives.CharIterator	wrap(Iterator iterator) Create an CharIterator wrapping the specified Iterator.

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratorCharIterator

public IteratorCharIterator(Iterator iterator)

Creates an CharIterator wrapping the specified Iterator.

See Also:

wrap(java.util.Iterator)

Method Detail

wrap

public static org.apache.commons.collections.primitives.CharIterator wrap(Iterator iterator)

Create an CharIterator wrapping the specified Iterator. When the given iterator is null, returns null.

Parameters:

iterator - the (possibly null) Iterator to wrap

Returns:

an CharIterator wrapping the given iterator, or null when iterator is null.

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

remove

public void remove()

Description copied from interface: CharIterator

Removes from my underlying collection the last element returned by me (optional operation).

Specified by:

remove in interface CharIterator