Module org.elasticsearch.xcontent

Package org.elasticsearch.xcontent

Class Text

java.lang.Object

org.elasticsearch.xcontent.Text

All Implemented Interfaces:

Comparable<Text>, ToXContent, ToXContentFragment, XContentString

public final class Text
extends Object
implements XContentString, Comparable<Text>, ToXContentFragment

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.XContentString

XContentString.UTF8Bytes

Field Summary

Fields

Modifier and Type	Field	Description
static final Text[]	EMPTY_ARRAY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Text(String string)
Text(XContentString.UTF8Bytes bytes)	Construct a Text from encoded UTF8Bytes.
Text(XContentString.UTF8Bytes bytes, int stringLength)	Construct a Text from encoded UTF8Bytes and an explicit string length.

Method Summary

Modifier and Type	Method	Description
XContentString.UTF8Bytes	bytes()	Returns an encoded XContentString.UTF8Bytes view of the data.
int	compareTo(Text text)
static Text[]	convertFromStringArray(String[] strings)
boolean	equals(Object obj)
boolean	hasBytes()	Whether an XContentString.UTF8Bytes 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.
int	stringLength()	Returns the number of characters in the represented string.
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.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

EMPTY_ARRAY

public static final Text[] EMPTY_ARRAY

Constructor Details

Text

public Text(XContentString.UTF8Bytes bytes)

Construct a Text from encoded UTF8Bytes. Since no string length is specified, stringLength() will perform a string conversion to measure the string length.

Text

public Text(XContentString.UTF8Bytes bytes,
 int stringLength)

Construct a Text from encoded UTF8Bytes and an explicit string length. Used to avoid string conversion in stringLength(). The provided stringLength should match the value that would be calculated by Text(UTF8Bytes).

Text

public Text(String string)

Method Details

convertFromStringArray

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

hasBytes

public boolean hasBytes()

Whether an XContentString.UTF8Bytes view of the data is already materialized.

bytes

public XContentString.UTF8Bytes bytes()

Description copied from interface: XContentString

Returns an encoded XContentString.UTF8Bytes view of the data.

Specified by:

bytes in interface XContentString

hasString

public boolean hasString()

Whether a String view of the data is already materialized.

string

public String string()

Description copied from interface: XContentString

Returns a String view of the data.

Specified by:

string in interface XContentString

stringLength

public int stringLength()

Description copied from interface: XContentString

Returns the number of characters in the represented string.

Specified by:

stringLength in interface XContentString

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