Package com.algolia.search.iterators

Class IndexIterable<T>

java.lang.Object

com.algolia.search.iterators.IndexIterable<T>

All Implemented Interfaces:

Iterable<T>

public class IndexIterable<T>
extends Object
implements Iterable<T>

Constructor Summary

Constructors

Constructor	Description
IndexIterable(APIClient apiClient, String indexName, Query query, RequestOptions requestOptions, Class<T> klass)
IndexIterable(APIClient apiClient, String indexName, Query query, RequestOptions requestOptions, String cursor, Class<T> klass)

Method Summary

Modifier and Type	Method	Description
String	getCursor()	Get the cursor
Iterator<T>	iterator()
Stream<T>	stream()	Get a stream from this iterable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexIterable

public IndexIterable(@Nonnull
                     APIClient apiClient,
                     @Nonnull
                     String indexName,
                     @Nonnull
                     Query query,
                     @Nonnull
                     RequestOptions requestOptions,
                     @Nonnull
                     Class<T> klass)

IndexIterable

public IndexIterable(@Nonnull
                     APIClient apiClient,
                     @Nonnull
                     String indexName,
                     @Nonnull
                     Query query,
                     @Nonnull
                     RequestOptions requestOptions,
                     String cursor,
                     @Nonnull
                     Class<T> klass)

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

getCursor

public String getCursor()

Get the cursor

Returns:

the cursor (can be null)

stream

public Stream<T> stream()

Get a stream from this iterable

Returns:

a Stream