ListIteratorCharListIterator (Commons Primitives 1.1-SNAPSHOT API)

java.lang.Object
- org.apache.commons.collections.primitives.adapters.ListIteratorCharListIterator

All Implemented Interfaces:

CharIterator, CharListIterator
```
public class ListIteratorCharListIterator
extends Object
implements CharListIterator
```
Adapts a Number-valued ListIterator to the CharListIterator interface.
This implementation delegates most methods to the provided CharListIterator implementation in the "obvious" way.

Since:

Commons Primitives 1.0

Version:

$Revision: 480462 $ $Date: 2006-11-29 03:15:00 -0500 (Wed, 29 Nov 2006) $

Author:

Rodney Waldhoff

Constructor Summary

Constructors
Constructor and Description

ListIteratorCharListIterator(ListIterator iterator)
Creates an CharListIterator wrapping the specified ListIterator.

Constructors
Constructor and Description
`ListIteratorCharListIterator(ListIterator iterator)` Creates an `CharListIterator` wrapping the specified `ListIterator`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(char element)` Inserts the specified element into my underlying collection (optional operation).
`boolean`	`hasNext()` Returns `true` iff I have more elements when traversed in the forward direction.
`boolean`	`hasPrevious()` Returns `true` iff I have more elements when traversed in the reverse direction.
`char`	`next()` Returns the next element in me when traversed in the forward direction.
`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 element)` Replaces in my underlying collection the last element returned by `CharListIterator.next()` or `CharListIterator.previous()` with the specified value (optional operation).
`static CharListIterator`	`wrap(ListIterator iterator)` Create an `CharListIterator` wrapping the specified `ListIterator`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListIteratorCharListIterator
```
public ListIteratorCharListIterator(ListIterator iterator)
```
    Creates an CharListIterator wrapping the specified ListIterator.
    
    See Also:
    wrap(java.util.ListIterator)
- Method Detail
  - wrap
```
public static CharListIterator wrap(ListIterator iterator)
```
    Create an CharListIterator wrapping the specified ListIterator. When the given iterator is null, returns null.
    
    Parameters:
    iterator - the (possibly null) ListIterator to wrap
    
    Returns:
    an CharListIterator wrapping the given iterator, or null when iterator is null.
  - 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
  - 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
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: CharListIterator
    
    Returns true iff I have more elements when traversed in the forward direction. (In other words, returns true iff a call to CharListIterator.next() will return an element rather than throwing an exception.
    
    Specified by:
    
    hasNext in interface CharIterator
    
    Specified by:
    
    hasNext in interface CharListIterator
    
    Returns:
    true iff I have more elements when traversed in the forward direction
  - 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
  - next
```
public char next()
```
    Description copied from interface: CharListIterator
    
    Returns the next element in me when traversed in the forward direction.
    
    Specified by:
    
    next in interface CharIterator
    
    Specified by:
    
    next in interface CharListIterator
    
    Returns:
    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
  - add
```
public void add(char element)
```
    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().
    
    Specified by:
    
    add in interface CharListIterator
    
    Parameters:
    element - the value to be inserted
  - set
```
public void set(char element)
```
    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).
    
    Specified by:
    
    set in interface CharListIterator
    
    Parameters:
    element - the value to replace the last returned element with
  - 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).
    
    Specified by:
    
    remove in interface CharIterator
    
    Specified by:
    
    remove in interface CharListIterator

Class ListIteratorCharListIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListIteratorCharListIterator

Method Detail

wrap

nextIndex

previousIndex

hasNext

hasPrevious

next

previous

add

set

remove