org.joda.primitives.iterator.impl
Class ArrayDoubleIterator

java.lang.Object
  extended by org.joda.primitives.iterator.impl.ArrayDoubleIterator
All Implemented Interfaces:
Iterator<Double>, DoubleIterator, PrimitiveIterator<Double>

public class ArrayDoubleIterator
extends Object
implements DoubleIterator

An iterator over an array of double values.

This class implements Iterator allowing seamless integration with other APIs.

The iterator can be reset to the start if required. It is unmodifiable and remove() is unsupported.

Since:
1.0
Version:
CODE GENERATED
Author:
Stephen Colebourne, Jason Tiscione

Field Summary
protected  double[] array
          The array to iterate over
protected  int cursor
          Cursor position
 
Constructor Summary
ArrayDoubleIterator(double[] array)
          Constructs an iterator over an array of double values.
 
Method Summary
static ArrayDoubleIterator copyOf(double[] array)
          Creates an iterator over a copy of an array of double values.
 boolean hasNext()
           
 boolean isModifiable()
          Checks whether the iterator can currently be modified.
 boolean isResettable()
          Checks whether the iterator can be reset.
 Double next()
           
 double nextDouble()
          Gets the next value from the iterator
 void remove()
           
 void reset()
          Resets the iterator back to its initial state (optional operation).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

array

protected final double[] array
The array to iterate over


cursor

protected int cursor
Cursor position

Constructor Detail

ArrayDoubleIterator

public ArrayDoubleIterator(double[] array)
Constructs an iterator over an array of double values.

The array is assigned internally, thus the caller holds a reference to the internal state of the returned iterator. It is not recommended to modify the state of the array after construction.

Parameters:
array - the array to iterate over, must not be null
Throws:
IllegalArgumentException - if the array is null
Method Detail

copyOf

public static ArrayDoubleIterator copyOf(double[] array)
Creates an iterator over a copy of an array of double values.

The specified array is copied, making this class effectively immutable. Note that the class is not final thus it is not truly immutable.

Parameters:
array - the array to iterate over, must not be null
Throws:
IllegalArgumentException - if the array is null

isModifiable

public boolean isModifiable()
Description copied from interface: PrimitiveIterator
Checks whether the iterator can currently be modified.

Specified by:
isModifiable in interface PrimitiveIterator<Double>
Returns:
true if the modification methods of the iterator can be used

isResettable

public boolean isResettable()
Description copied from interface: PrimitiveIterator
Checks whether the iterator can be reset.

Specified by:
isResettable in interface PrimitiveIterator<Double>
Returns:
true if the object can be reset

hasNext

public boolean hasNext()
Specified by:
hasNext in interface Iterator<Double>

nextDouble

public double nextDouble()
Description copied from interface: DoubleIterator
Gets the next value from the iterator

Specified by:
nextDouble in interface DoubleIterator
Returns:
the next available value

next

public Double next()
Specified by:
next in interface Iterator<Double>

remove

public void remove()
Specified by:
remove in interface Iterator<Double>

reset

public void reset()
Description copied from interface: PrimitiveIterator
Resets the iterator back to its initial state (optional operation).

Specified by:
reset in interface PrimitiveIterator<Double>


Copyright © 2005-2010 Joda.org. All Rights Reserved.