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

java.lang.Object
  extended by org.apache.commons.collections.primitives.adapters.ListIteratorDoubleListIterator
All Implemented Interfaces:
DoubleIterator, DoubleListIterator

public class ListIteratorDoubleListIterator
extends java.lang.Object
implements DoubleListIterator

Adapts a Number-valued ListIterator to the DoubleListIterator interface.

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

Since:
Commons Primitives 1.0
Version:
$Revision: 1.3 $ $Date: 2003/10/16 20:49:38 $
Author:
Rodney Waldhoff

Field Summary
private  java.util.ListIterator _iterator
           
 
Constructor Summary
ListIteratorDoubleListIterator(java.util.ListIterator iterator)
          Creates an DoubleListIterator wrapping the specified ListIterator.
 
Method Summary
 void add(double 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.
 double 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 DoubleListIterator.next(), or the number of elements in my iteration if I have no next element.
 double 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 DoubleListIterator.previous(), or -1 if I have no previous element.
 void remove()
          Removes from my underlying collection the last element returned by DoubleListIterator.next() or DoubleListIterator.previous() (optional operation).
 void set(double element)
          Replaces in my underlying collection the last element returned by DoubleListIterator.next() or DoubleListIterator.previous() with the specified value (optional operation).
static DoubleListIterator wrap(java.util.ListIterator iterator)
          Create an DoubleListIterator 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

ListIteratorDoubleListIterator

public ListIteratorDoubleListIterator(java.util.ListIterator iterator)
Creates an DoubleListIterator wrapping the specified ListIterator.

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

wrap

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

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

nextIndex

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

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

previousIndex

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

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

hasNext

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

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

hasPrevious

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

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

next

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

Specified by:
next in interface DoubleIterator
Specified by:
next in interface DoubleListIterator
Returns:
the next element in me

previous

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

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

add

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

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

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

set

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

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

remove

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

Specified by:
remove in interface DoubleIterator
Specified by:
remove in interface DoubleListIterator


Copyright (c) 2002-2003 - Apache Software Foundation