Package com.algolia.search.iterators

Class SynonymsIterable

java.lang.Object

com.algolia.search.iterators.SynonymsIterable

All Implemented Interfaces:

Iterable<Synonym>

public class SynonymsIterable
extends Object
implements Iterable<Synonym>

Constructor Summary

Constructors

Constructor	Description
SynonymsIterable(SearchIndex<?> index)
SynonymsIterable(SearchIndex<?> index, Integer hitsPerPage)
SynonymsIterable(SearchIndex<?> index, Integer hitsPerPage, RequestOptions requestOptions)

Method Summary

Modifier and Type	Method	Description
Iterator<Synonym>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SynonymsIterable

public SynonymsIterable(@Nonnull
                        SearchIndex<?> index)

SynonymsIterable

public SynonymsIterable(@Nonnull
                        SearchIndex<?> index,
                        @Nonnull
                        Integer hitsPerPage)

SynonymsIterable

public SynonymsIterable(@Nonnull
                        SearchIndex<?> index,
                        @Nonnull
                        Integer hitsPerPage,
                        RequestOptions requestOptions)

Method Detail

iterator

@Nonnull
public Iterator<Synonym> iterator()

Specified by:

iterator in interface Iterable<Synonym>