org.apache.jackrabbit.rmi.remote

Class BufferIterator

java.lang.Object

org.apache.jackrabbit.rmi.remote.BufferIterator

All Implemented Interfaces:

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

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

A buffered remote iterator. Used to transfer a remote iterator reference along with a buffer of the first few iterator elements in one network transmission.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BufferIterator(java.lang.Object[] buffer, long size, RemoteIterator remote) Creates a new buffered remote iterator.

Method Summary

Modifier and Type	Method and Description
long	getSize() Returns the cached size of the iterator.
java.lang.Object[]	nextObjects() Returns the currently buffered elements and fills in the buffer with next elements.
void	skip(long items) Skips the given number of elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferIterator

public BufferIterator(java.lang.Object[] buffer,
                      long size,
                      RemoteIterator remote)

Creates a new buffered remote iterator.

Parameters:

buffer - first elements in the iterator

size - total iterator size

remote - reference to the remaining iterator

Method Detail

getSize

public long getSize()

Returns the cached size of the iterator.

Specified by:

getSize in interface RemoteIterator

Returns:

iterator size, or -1 if unknown

See Also:

RemoteIterator.getSize()

skip

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

Skips the given number of elements. First discards elements from the element buffer and only then contacts the remote iterator.

Specified by:

skip in interface RemoteIterator

Parameters:

items - number of items to skip

Throws:

java.lang.IllegalArgumentException - if items is negative

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

java.rmi.RemoteException - on RMI errors

See Also:

RemoteIterator.skip(long)

nextObjects

public java.lang.Object[] nextObjects()
                               throws java.rmi.RemoteException

Returns the currently buffered elements and fills in the buffer with next elements.

Specified by:

nextObjects in interface RemoteIterator

Returns:

buffered elements, or null if the iterator has ended

Throws:

java.rmi.RemoteException - on RMI errors

See Also:

RemoteIterator.nextObjects()