com.exalead.papi.helper

Interface SyncedEntriesIterator

All Superinterfaces:

java.util.Iterator<SyncedEntry>

All Known Implementing Classes:

HttpSyncedEntriesIterator, HttpSyncedEntriesIterator

public interface SyncedEntriesIterator
extends java.util.Iterator<SyncedEntry>

Base class representing an iterator on synchronized entries. This class extends the type Iterator and exposes two additional methods:

• nextBatch: to enumerate synchronized entries in batch mode. Can be used to optimize bandwidth.
• close: to close the iterator which will most probably make extensive use of network resources and which needs to be closed as soon as the enumeration is finished.

See Also:

SyncedEntry

Method Summary

Modifier and Type	Method and Description
void	close() Closes the iterator.
SyncedEntry[]	nextBatch(int count) Gets next set of SyncedEntry.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

nextBatch

SyncedEntry[] nextBatch(int count)
                 throws UnknownErrorException

Gets next set of SyncedEntry.

Parameters:

count - Number of SyncedEntry to retrieve.

Returns:

an array of synchronized entries.

Throws:

UnknownErrorException - upon error

close

void close()
    throws UnknownErrorException

Closes the iterator. The iterator shouldn't be reused after a call to this method.

Throws:

UnknownErrorException - upon error