org.elasticsearch.common.text

Interface Text

All Superinterfaces:

Comparable<Text>, Serializable

All Known Implementing Classes:

BytesText, StringAndBytesText, StringText

public interface Text
extends Comparable<Text>, Serializable

Text represents a (usually) long text data. We use this abstraction instead of String so we can represent it in a more optimized manner in memory as well as serializing it over the network as well as converting it to json format.

Method Summary

Modifier and Type	Method and Description
BytesReference	bytes() The UTF8 bytes representing the the text, might be converted on the fly, see hasBytes()
boolean	hasBytes() Are bytes available without the need to be converted into bytes when calling bytes().
boolean	hasString() Is there a String representation of the text.
String	string() Returns the string representation of the text, might be converted to a string on the fly.
String	toString() Returns the string representation of the text, might be converted to a string on the fly.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

hasBytes

boolean hasBytes()

Are bytes available without the need to be converted into bytes when calling bytes().

bytes

BytesReference bytes()

The UTF8 bytes representing the the text, might be converted on the fly, see hasBytes()

hasString

boolean hasString()

Is there a String representation of the text. If not, then it hasBytes().

string

String string()

Returns the string representation of the text, might be converted to a string on the fly.

toString

String toString()

Returns the string representation of the text, might be converted to a string on the fly.

Overrides:

toString in class Object