Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.utility.iterator

public Class ArrayIterator<E>

extends Object
implements Iterator<E>
Class Inheritance
All Implemented Interfaces
java.util.Iterator
Annotations
@SuppressWarnings:nls
Imports
java.util.Arrays, .Iterator, .NoSuchElementException

An ArrayIterator provides a Iterator for an array of objects.
Since
2.4
Version
2.5

Field Summary

Modifier and TypeField and Description
pack-priv E[]
array

The object containing the items to iterate over.

private int
maxIndex

The last index this ArrayIterator can iterate over.

pack-priv int
nextIndex

The position of the cursor.

Constructor Summary

AccessConstructor and Description
public <T extends E>
ArrayIterator(T...
The object containing the items to iterate over
array
)

Creates a new ArrayIterator for the specified array.

public <T extends E>
ArrayIterator(T[]
The object containing the items to iterate over
array
,
int
The beginning of the iteration
start
,
int
The length of the iteration
length
)

Creates a new ArrayIterator for the specified array, starting at the specified start index and continuing for the specified length.

Method Summary

Modifier and TypeMethod and Description
public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.
public E
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.
public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

arrayback to summary
pack-priv E[] array

The object containing the items to iterate over.

maxIndexback to summary
private int maxIndex

The last index this ArrayIterator can iterate over.

nextIndexback to summary
pack-priv int nextIndex

The position of the cursor.

Constructor Detail

ArrayIteratorback to summary
public <T extends E> ArrayIterator(T... array)

Creates a new ArrayIterator for the specified array.

Parameters
array:T[]

The object containing the items to iterate over

Annotations
@SafeVarargs
@SuppressWarnings:varargs
ArrayIteratorback to summary
public <T extends E> ArrayIterator(T[] array, int start, int length)

Creates a new ArrayIterator for the specified array, starting at the specified start index and continuing for the specified length.

Parameters
array:T[]

The object containing the items to iterate over

start:int

The beginning of the iteration

length:int

The length of the iteration

Exceptions
IllegalArgumentException:
The start index is either a negative value or greater than the length of the array or the length to copy goes beyond the length of the array

Method Detail

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
nextback to summary
public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

Annotations
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override