Package com.algolia.model.search

Enum Class Anchoring

java.lang.Object

java.lang.Enum<Anchoring>

com.algolia.model.search.Anchoring

All Implemented Interfaces:

Serializable, Comparable<Anchoring>, Constable

public enum Anchoring
extends Enum<Anchoring>

Which part of the search query the pattern should match: - `startsWith`. The pattern must match the begginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as pattern with `anchoring: is`.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTAINS
ENDS_WITH
IS
STARTS_WITH

Method Summary

Modifier and Type	Method	Description
static Anchoring	fromValue(String value)
String	getValue()
String	toString()
static Anchoring	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Anchoring[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IS

public static final Anchoring IS

STARTS_WITH

public static final Anchoring STARTS_WITH

ENDS_WITH

public static final Anchoring ENDS_WITH

CONTAINS

public static final Anchoring CONTAINS

Method Details

values

public static Anchoring[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Anchoring valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<Anchoring>

fromValue

public static Anchoring fromValue(String value)