org.elasticsearch.common.compress

Class CompressedXContent

java.lang.Object

org.elasticsearch.common.compress.CompressedXContent

public final class CompressedXContent
extends java.lang.Object

Similar class to the String class except that it internally stores data using a compressed representation in order to require less permanent memory. Note that the compressed string might still sometimes need to be decompressed in order to perform equality checks or to compute hash codes.

Constructor Summary

Constructors

Constructor and Description
CompressedXContent(byte[] data)
CompressedXContent(BytesReference data) Create a CompressedXContent out of a serialized ToXContent that may already be compressed.
CompressedXContent(java.lang.String str)
CompressedXContent(ToXContent xcontent, XContentType type, ToXContent.Params params) Create a CompressedXContent out of a ToXContent instance.

Method Summary

Modifier and Type	Method and Description
byte[]	compressed() Return the compressed bytes.
BytesReference	compressedReference() Return the compressed bytes as a BytesReference.
boolean	equals(java.lang.Object o)
int	hashCode()
static CompressedXContent	readCompressedString(StreamInput in)
java.lang.String	string()
java.lang.String	toString()
byte[]	uncompressed() Return the uncompressed bytes.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressedXContent

public CompressedXContent(ToXContent xcontent,
                          XContentType type,
                          ToXContent.Params params)
                   throws java.io.IOException

Create a CompressedXContent out of a ToXContent instance.

Throws:

java.io.IOException

CompressedXContent

public CompressedXContent(BytesReference data)
                   throws java.io.IOException

Create a CompressedXContent out of a serialized ToXContent that may already be compressed.

Throws:

java.io.IOException

CompressedXContent

public CompressedXContent(byte[] data)
                   throws java.io.IOException

Throws:

java.io.IOException

CompressedXContent

public CompressedXContent(java.lang.String str)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

compressed

public byte[] compressed()

Return the compressed bytes.

compressedReference

public BytesReference compressedReference()

Return the compressed bytes as a BytesReference.

uncompressed

public byte[] uncompressed()

Return the uncompressed bytes.

string

public java.lang.String string()
                        throws java.io.IOException

Throws:

java.io.IOException

readCompressedString

public static CompressedXContent readCompressedString(StreamInput in)
                                               throws java.io.IOException

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object