Package com.mongodb.client.model

Class TextSearchOptions

java.lang.Object

com.mongodb.client.model.TextSearchOptions

public final class TextSearchOptions
extends Object

Text search options for the Filters.text(String, TextSearchOptions) helper

Since:

3.2

MongoDB documentation

$text

Constructor Summary

Constructors

Constructor	Description
TextSearchOptions()

Method Summary

Modifier and Type	Method	Description
TextSearchOptions	caseSensitive(Boolean caseSensitive)	Set the case-sensitive flag for the text search
TextSearchOptions	diacriticSensitive(Boolean diacriticSensitive)	Set the diacritic-sensitive flag for the text search
boolean	equals(Object o)
Boolean	getCaseSensitive()	Returns the case-sensitive flag to use with the text search
Boolean	getDiacriticSensitive()	Returns the diacritic-sensitive flag to use with the text search
String	getLanguage()	Returns the language to be used with the text search
int	hashCode()
TextSearchOptions	language(String language)	Set the language for the text search
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextSearchOptions

public TextSearchOptions()

Method Detail

getLanguage

@Nullable
public String getLanguage()

Returns the language to be used with the text search

Returns:

the language to use for the text search if set or null

language

public TextSearchOptions language(@Nullable
                                  String language)

Set the language for the text search

Parameters:

language - the language to use for the text search

Returns:

this

getCaseSensitive

@Nullable
public Boolean getCaseSensitive()

Returns the case-sensitive flag to use with the text search

Returns:

the case-sensitive flag if set or null

Since server release

3.2

caseSensitive

public TextSearchOptions caseSensitive(@Nullable
                                       Boolean caseSensitive)

Set the case-sensitive flag for the text search

Parameters:

caseSensitive - the case-sensitive flag for the text search

Returns:

this

Since server release

3.2

getDiacriticSensitive

@Nullable
public Boolean getDiacriticSensitive()

Returns the diacritic-sensitive flag to use with the text search

Returns:

the diacritic-sensitive flag if set or null

Since server release

3.2

diacriticSensitive

public TextSearchOptions diacriticSensitive(@Nullable
                                            Boolean diacriticSensitive)

Set the diacritic-sensitive flag for the text search

Parameters:

diacriticSensitive - the diacritic-sensitive flag for the text search

Returns:

this

Since server release

3.2

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object