com.algolia.search.saas

Class Query.IgnorePlurals

Object

com.algolia.search.saas.Query.IgnorePlurals

Enclosing class:

Query

public static final class Query.IgnorePlurals
extends Object

A value of the ignorePlurals setting. Can represent either a boolean or a list of language codes, see https://www.algolia.com/doc/faq/searching/how-does-ignoreplurals-work.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled Whether plurals are ignored.
List<String>	languageCodes A list containing every active language's code.

Constructor Summary

Constructors

Constructor and Description
IgnorePlurals(boolean b) Construct an IgnorePlurals object for a boolean value.
IgnorePlurals(Collection<String> codes) Construct an IgnorePlurals object for a Collection of language codes.
IgnorePlurals(String... codes) Construct an IgnorePlurals object for some language codes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

enabled

public final boolean enabled

Whether plurals are ignored.

languageCodes

@Nullable
public final List<String> languageCodes

A list containing every active language's code. When null, all supported languages are be used.

Constructor Detail

IgnorePlurals

public IgnorePlurals(boolean b)

Construct an IgnorePlurals object for a boolean value.

Parameters:

b - if true, the engine will ignore plurals in all supported languages.

IgnorePlurals

public IgnorePlurals(@Nullable
                     Collection<String> codes)

Construct an IgnorePlurals object for a Collection of language codes.

Parameters:

codes - a list of language codes to ignore plurals from. if null, the engine will ignore plurals in all supported languages.

IgnorePlurals

public IgnorePlurals(@Nullable
                     String... codes)

Construct an IgnorePlurals object for some language codes.

Parameters:

codes - one or several language codes to ignore plurals from. if null, the engine will ignore plurals in all supported languages.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object