Module org.elasticsearch.server

Package org.elasticsearch.common.compress

Class CompressedXContent

java.lang.Object

org.elasticsearch.common.compress.CompressedXContent

All Implemented Interfaces:

Writeable

public final class CompressedXContent
extends Object
implements Writeable

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
CompressedXContent(byte[] data)
CompressedXContent(String str)
CompressedXContent(Map<String,Object> map)
CompressedXContent(BytesReference data)	Create a CompressedXContent out of a serialized ToXContent that may already be compressed.
CompressedXContent(ToXContent xcontent)
CompressedXContent(ToXContent xcontent, ToXContent.Params params)	Create a CompressedXContent out of a ToXContent instance.

Method Summary

Modifier and Type	Method	Description
byte[]	compressed()	Return the compressed bytes.
BytesReference	compressedReference()	Return the compressed bytes as a BytesReference.
void	copyTo(XContentBuilder builder)	Copies the x-content in this instance to the given builder token by token.
boolean	equals(Object o)
static CompressedXContent	fromJSON(String json)	Parses the given JSON string and then serializes it back in compressed form without any whitespaces.
String	getSha256()
int	hashCode()
static CompressedXContent	readCompressedString(StreamInput in)
String	string()
String	toString()
BytesReference	uncompressed()	Return the uncompressed bytes.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Details

CompressedXContent

public CompressedXContent(Map<String,Object> map)
                   throws IOException

Throws:

IOException

CompressedXContent

public CompressedXContent(ToXContent xcontent)
                   throws IOException

Throws:

IOException

CompressedXContent

public CompressedXContent(ToXContent xcontent,
 ToXContent.Params params)
                   throws IOException

Create a CompressedXContent out of a ToXContent instance.

Throws:

IOException

CompressedXContent

public CompressedXContent(BytesReference data)
                   throws IOException

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

Throws:

IOException

CompressedXContent

public CompressedXContent(byte[] data)
                   throws IOException

Throws:

IOException

CompressedXContent

public CompressedXContent(String str)
                   throws IOException

Throws:

IOException

Method Details

fromJSON

public static CompressedXContent fromJSON(String json)
                                   throws IOException

Parses the given JSON string and then serializes it back in compressed form without any whitespaces. This is used to normalize mapping json strings for deduplication.

Parameters:

json - string containing valid JSON

Returns:

compressed x-content normalized to not contain any whitespaces

Throws:

IOException

compressed

public byte[] compressed()

Return the compressed bytes.

compressedReference

public BytesReference compressedReference()

Return the compressed bytes as a BytesReference.

uncompressed

public BytesReference uncompressed()

Return the uncompressed bytes.

string

public String string()

getSha256

public String getSha256()

readCompressedString

public static CompressedXContent readCompressedString(StreamInput in)
                                               throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

copyTo

public void copyTo(XContentBuilder builder)
            throws IOException

Copies the x-content in this instance to the given builder token by token. This operation is equivalent to parsing the contents of this instance into a map and then writing the map to the given XContentBuilder functionally but is much more efficient.

Parameters:

builder - builder to copy to

Throws:

IOException - on failure

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object