Package org.opensearch.core.common.text

Class Text

java.lang.Object

org.opensearch.core.common.text.Text

All Implemented Interfaces:

Comparable<Text>, ToXContent, ToXContentFragment

@PublicApi(since="1.0.0")
public final class Text
extends Object
implements Comparable<Text>, ToXContentFragment

Both String and BytesReference representation of the text. Starts with one of those, and if the other is requests, caches the other one in a local reference so no additional conversion will be needed.

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final Text[]	EMPTY_ARRAY

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Text(String text)
Text(BytesReference bytes)

Method Summary

Modifier and Type	Method	Description
BytesReference	bytes()	Returns a BytesReference view of the data.
int	compareTo(Text text)
static Text[]	convertFromStringArray(String[] strings)
boolean	equals(Object obj)
boolean	hasBytes()	Whether a BytesReference view of the data is already materialized.
int	hashCode()
boolean	hasString()	Whether a String view of the data is already materialized.
String	string()	Returns a String view of the data.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

EMPTY_ARRAY

public static final Text[] EMPTY_ARRAY

Constructor Details

Text

public Text(BytesReference bytes)

Text

public Text(String text)

Method Details

convertFromStringArray

public static Text[] convertFromStringArray(String[] strings)

hasBytes

public boolean hasBytes()

Whether a BytesReference view of the data is already materialized.

bytes

public BytesReference bytes()

Returns a BytesReference view of the data.

hasString

public boolean hasString()

Whether a String view of the data is already materialized.

string

public String string()

Returns a String view of the data.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Text text)

Specified by:

compareTo in interface Comparable<Text>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException