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

java.lang.Object
  extended by org.apache.commons.collections.primitives.adapters.ListIteratorIntListIterator
All Implemented Interfaces:
IntIterator, IntListIterator

public class ListIteratorIntListIterator
extends java.lang.Object
implements IntListIterator

Adapts a Number-valued ListIterator to the IntListIterator interface.

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

Since:
Commons Primitives 0.1
Version:
$Revision: 1.2 $ $Date: 2003/10/14 20:04:18 $
Author:
Rodney Waldhoff

Field Summary
private  java.util.ListIterator _iterator
           
 
Constructor Summary
ListIteratorIntListIterator(java.util.ListIterator iterator)
          Creates an IntListIterator wrapping the specified ListIterator.
 
Method Summary
 void add(int 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.
 int 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 IntListIterator.next(), or the number of elements in my iteration if I have no next element.
 int 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 IntListIterator.previous(), or -1 if I have no previous element.
 void remove()
          Removes from my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() (optional operation).
 void set(int element)
          Replaces in my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() with the specified value (optional operation).
static IntListIterator wrap(java.util.ListIterator iterator)
          Create an IntListIterator wrapping the specified ListIterator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_iterator

private java.util.ListIterator _iterator
Constructor Detail

ListIteratorIntListIterator

public ListIteratorIntListIterator(java.util.ListIterator iterator)
Creates an IntListIterator wrapping the specified ListIterator.

See Also:
wrap(java.util.ListIterator)
Method Detail

wrap

public static IntListIterator wrap(java.util.ListIterator iterator)
Create an IntListIterator wrapping the specified ListIterator. When the given iterator is null, returns null.

Parameters:
iterator - the (possibly null) ListIterator to wrap
Returns:
an IntListIterator wrapping the given iterator, or null when iterator is null.

nextIndex

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

Specified by:
nextIndex in interface IntListIterator
Returns:
the index of the next element in me

previousIndex

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

Specified by:
previousIndex in interface IntListIterator
Returns:
the index of the previous element in me

hasNext

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

Specified by:
hasNext in interface IntIterator
Specified by:
hasNext in interface IntListIterator
Returns:
true iff I have more elements when traversed in the forward direction

hasPrevious

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

Specified by:
hasPrevious in interface IntListIterator
Returns:
true iff I have more elements when traversed in the reverse direction

next

public int next()
Description copied from interface: IntListIterator
Returns the next element in me when traversed in the forward direction.

Specified by:
next in interface IntIterator
Specified by:
next in interface IntListIterator
Returns:
the next element in me

previous

public int previous()
Description copied from interface: IntListIterator
Returns the next element in me when traversed in the reverse direction.

Specified by:
previous in interface IntListIterator
Returns:
the previous element in me

add

public void add(int element)
Description copied from interface: IntListIterator
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 IntListIterator.next(), if any, and immediately after the next element that would have been returned by IntListIterator.previous(), if any.

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

Specified by:
add in interface IntListIterator
Parameters:
element - the value to be inserted

set

public void set(int element)
Description copied from interface: IntListIterator
Replaces in my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() with the specified value (optional operation).

Specified by:
set in interface IntListIterator
Parameters:
element - the value to replace the last returned element with

remove

public void remove()
Description copied from interface: IntListIterator
Removes from my underlying collection the last element returned by IntListIterator.next() or IntListIterator.previous() (optional operation).

Specified by:
remove in interface IntIterator
Specified by:
remove in interface IntListIterator


Copyright (c) 2002-2003 - Apache Software Foundation