com.algolia.search.saas.helpers

Class BrowseIterator

Object

com.algolia.search.saas.helpers.BrowseIterator

public class BrowseIterator
extends Object

Iterator to browse all index content.

This helper takes care of chaining API requests and calling back the handler block with the results, until: - the end of the index has been reached; - an error has been encountered; - or the user cancelled the iteration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BrowseIterator.BrowseIteratorHandler Listener for BrowseIterator.

Constructor Summary

Constructors

Constructor and Description
BrowseIterator(Index index, Query query, BrowseIterator.BrowseIteratorHandler handler) Construct a new browse iterator.
BrowseIterator(Index index, Query query, RequestOptions requestOptions, BrowseIterator.BrowseIteratorHandler handler) Construct a new browse iterator.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel the iteration.
boolean	hasNext() Determine if there is more content to be browsed.
void	start() Start the iteration.

Methods inherited from class Object

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

Constructor Detail

BrowseIterator

public BrowseIterator(@NonNull
                      Index index,
                      @NonNull
                      Query query,
                      @NonNull
                      BrowseIterator.BrowseIteratorHandler handler)

Construct a new browse iterator. NOTE: The iteration does not start automatically. You have to call `start()` explicitly.

Parameters:

index - The index to be browsed.

query - The query used to filter the results.

handler - Handler called for each batch of results.

BrowseIterator

public BrowseIterator(@NonNull
                      Index index,
                      @NonNull
                      Query query,
                      @Nullable
                      RequestOptions requestOptions,
                      @NonNull
                      BrowseIterator.BrowseIteratorHandler handler)

Construct a new browse iterator. NOTE: The iteration does not start automatically. You have to call `start()` explicitly.

Parameters:

index - The index to be browsed.

query - The query used to filter the results.

requestOptions - Request-specific options.

handler - Handler called for each batch of results.

Method Detail

start

public void start()

Start the iteration.

cancel

public void cancel()

Cancel the iteration. This cancels any currently ongoing request, and cancels the iteration. The listener will not be called after the iteration has been cancelled.

hasNext

public boolean hasNext()

Determine if there is more content to be browsed. WARNING: Can only be called from the handler, once the iteration has started.