org.apache.jackrabbit.rmi.remote

Class ArrayIterator

java.lang.Object

org.apache.jackrabbit.rmi.remote.ArrayIterator

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, RemoteIterator

public class ArrayIterator
extends java.lang.Object
implements RemoteIterator, java.io.Serializable

A simple array-based remote iterator. Used when the iteration is short enough for all the elements to be sent over the network in one go.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArrayIterator(java.lang.Object[] elements) Creates an array-based remote iterator from the given array of remote references or serializable objects.

Method Summary

Modifier and Type	Method and Description
long	getSize() Returns the size of the iterator.
java.lang.Object[]	nextObjects() Returns the underlying array.
void	skip(long items) Skips the first items elements in the array.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArrayIterator

public ArrayIterator(java.lang.Object[] elements)

Creates an array-based remote iterator from the given array of remote references or serializable objects.

Parameters:

elements - elements of the iteration

Method Detail

getSize

public long getSize()

Returns the size of the iterator.

Specified by:

getSize in interface RemoteIterator

Returns:

length of the iterator

See Also:

RemoteIterator.getSize()

skip

public void skip(long items)
          throws java.lang.IllegalArgumentException,
                 java.util.NoSuchElementException

Skips the first items elements in the array. Skips the given number of elements in this iteration.

Specified by:

skip in interface RemoteIterator

Parameters:

items - number of elements to skip

Throws:

java.util.NoSuchElementException - if skipped past the last element

java.lang.IllegalArgumentException

See Also:

javax.jcr.RangeIterator#skip(long)

nextObjects

public java.lang.Object[] nextObjects()
                               throws java.lang.IllegalArgumentException

Returns the underlying array. Returns an array of remote references to the next elements in this iterator. Returns null if the end of this iteration has been reached.

To reduce the amount of remote method calls, this method returns an array of one or more elements in this iteration.

Specified by:

nextObjects in interface RemoteIterator

Returns:

array of remote references, or null

Throws:

java.lang.IllegalArgumentException - if maxItems is not positive

See Also:

Iterator.next()