ListIteratorBooleanListIterator (Commons Primitives 1.1-SNAPSHOT API)

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

All Implemented Interfaces:

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

Since:

Commons Primitives 1.1

Version:

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

Author:

Rodney Waldhoff

Constructor Summary

Constructors
Constructor and Description

ListIteratorBooleanListIterator(ListIterator iterator)
Creates an BooleanListIterator wrapping the specified ListIterator.

Constructors
Constructor and Description
`ListIteratorBooleanListIterator(ListIterator iterator)` Creates an `BooleanListIterator` wrapping the specified `ListIterator`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(boolean 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.
`boolean`	`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 `BooleanListIterator.next()`, or the number of elements in my iteration if I have no next element.
`boolean`	`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 `BooleanListIterator.previous()`, or `-1` if I have no previous element.
`void`	`remove()` Removes from my underlying collection the last element returned by `BooleanListIterator.next()` or `BooleanListIterator.previous()` (optional operation).
`void`	`set(boolean element)` Replaces in my underlying collection the last element returned by `BooleanListIterator.next()` or `BooleanListIterator.previous()` with the specified value (optional operation).
`static BooleanListIterator`	`wrap(ListIterator iterator)` Create an `BooleanListIterator` wrapping the specified `ListIterator`.

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

- Constructor Detail
  - ListIteratorBooleanListIterator
```
public ListIteratorBooleanListIterator(ListIterator iterator)
```
    Creates an BooleanListIterator wrapping the specified ListIterator.
    
    See Also:
    wrap(java.util.ListIterator)
- Method Detail
  - wrap
```
public static BooleanListIterator wrap(ListIterator iterator)
```
    Create an BooleanListIterator wrapping the specified ListIterator. When the given iterator is null, returns null.
    
    Parameters:
    iterator - the (possibly null) ListIterator to wrap
    
    Returns:
    an BooleanListIterator wrapping the given iterator, or null when iterator is null.
  - nextIndex
```
public int nextIndex()
```
    Description copied from interface: BooleanListIterator
    
    Returns the index of the element that would be returned by a subsequent call to BooleanListIterator.next(), or the number of elements in my iteration if I have no next element.
    
    Specified by:
    
    nextIndex in interface BooleanListIterator
    
    Returns:
    the index of the next element in me
  - previousIndex
```
public int previousIndex()
```
    Description copied from interface: BooleanListIterator
    
    Returns the index of the element that would be returned by a subsequent call to BooleanListIterator.previous(), or -1 if I have no previous element.
    
    Specified by:
    
    previousIndex in interface BooleanListIterator
    
    Returns:
    the index of the previous element in me
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: BooleanListIterator
    
    Returns true iff I have more elements when traversed in the forward direction. (In other words, returns true iff a call to BooleanListIterator.next() will return an element rather than throwing an exception.
    
    Specified by:
    
    hasNext in interface BooleanIterator
    
    Specified by:
    
    hasNext in interface BooleanListIterator
    
    Returns:
    true iff I have more elements when traversed in the forward direction
  - hasPrevious
```
public boolean hasPrevious()
```
    Description copied from interface: BooleanListIterator
    
    Returns true iff I have more elements when traversed in the reverse direction. (In other words, returns true iff a call to BooleanListIterator.previous() will return an element rather than throwing an exception.
    
    Specified by:
    
    hasPrevious in interface BooleanListIterator
    
    Returns:
    true iff I have more elements when traversed in the reverse direction
  - next
```
public boolean next()
```
    Description copied from interface: BooleanListIterator
    
    Returns the next element in me when traversed in the forward direction.
    
    Specified by:
    
    next in interface BooleanIterator
    
    Specified by:
    
    next in interface BooleanListIterator
    
    Returns:
    the next element in me
  - previous
```
public boolean previous()
```
    Description copied from interface: BooleanListIterator
    
    Returns the next element in me when traversed in the reverse direction.
    
    Specified by:
    
    previous in interface BooleanListIterator
    
    Returns:
    the previous element in me
  - add
```
public void add(boolean element)
```
    Description copied from interface: BooleanListIterator
    
    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 BooleanListIterator.next(), if any, and immediately after the next element that would have been returned by BooleanListIterator.previous(), if any.
    The new element is inserted immediately before the implied cursor. A subsequent call to BooleanListIterator.previous() will return the added element, a subsequent call to BooleanListIterator.next() will be unaffected. This call increases by one the value that would be returned by a call to BooleanListIterator.nextIndex() or BooleanListIterator.previousIndex().
    
    Specified by:
    
    add in interface BooleanListIterator
    
    Parameters:
    element - the value to be inserted
  - set
```
public void set(boolean element)
```
    Description copied from interface: BooleanListIterator
    
    Replaces in my underlying collection the last element returned by BooleanListIterator.next() or BooleanListIterator.previous() with the specified value (optional operation).
    
    Specified by:
    
    set in interface BooleanListIterator
    
    Parameters:
    element - the value to replace the last returned element with
  - remove
```
public void remove()
```
    Description copied from interface: BooleanListIterator
    
    Removes from my underlying collection the last element returned by BooleanListIterator.next() or BooleanListIterator.previous() (optional operation).
    
    Specified by:
    
    remove in interface BooleanIterator
    
    Specified by:
    
    remove in interface BooleanListIterator

Class ListIteratorBooleanListIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListIteratorBooleanListIterator

Method Detail

wrap

nextIndex

previousIndex

hasNext

hasPrevious

next

previous

add

set

remove