Package org.elasticsearch.common.xcontent

Class XContentHelper

java.lang.Object

org.elasticsearch.common.xcontent.XContentHelper

public class XContentHelper
extends Object

Constructor Summary

Constructors

Constructor	Description
XContentHelper()

Method Summary

Modifier and Type	Method	Description
static BytesReference	childBytes(XContentParser parser)	Returns the contents of an object as an unparsed BytesReference This is useful for things like mappings where we're copying bytes around but don't actually need to parse their contents, and so avoids building large maps of maps unnecessarily
static String	convertToJson(BytesReference bytes, boolean reformatJson)	Deprecated.
static String	convertToJson(BytesReference bytes, boolean reformatJson, boolean prettyPrint)	Deprecated.
static String	convertToJson(BytesReference bytes, boolean reformatJson, boolean prettyPrint, XContentType xContentType)
static String	convertToJson(BytesReference bytes, boolean reformatJson, XContentType xContentType)
static Tuple<XContentType,Map<String,Object>>	convertToMap(BytesReference bytes, boolean ordered)	Deprecated. this method relies on auto-detection of content type.
static Tuple<XContentType,Map<String,Object>>	convertToMap(BytesReference bytes, boolean ordered, XContentType xContentType)	Converts the given bytes into a map that is optionally ordered.
static Map<String,Object>	convertToMap(XContent xContent, byte[] bytes, int offset, int length, boolean ordered)	Convert a byte array in some XContent format to a Map.
static Map<String,Object>	convertToMap(XContent xContent, InputStream input, boolean ordered)	Convert a string in some XContent format to a Map.
static Map<String,Object>	convertToMap(XContent xContent, String string, boolean ordered)	Convert a string in some XContent format to a Map.
static XContentParser	createParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, BytesReference bytes)	Deprecated. use createParser(NamedXContentRegistry, DeprecationHandler, BytesReference, XContentType) to avoid content type auto-detection
static XContentParser	createParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, BytesReference bytes, XContentType xContentType)	Creates a parser for the bytes using the supplied content-type
static void	mergeDefaults(Map<String,Object> content, Map<String,Object> defaults)	Merges the defaults provided as the second parameter into the content of the first.
static String	stripWhitespace(String json)	Accepts a JSON string, parses it and prints it without pretty-printing it.
static BytesReference	toXContent(ToXContent toXContent, XContentType xContentType, boolean humanReadable)	Returns the bytes that represent the XContent output of the provided ToXContent object, using the provided XContentType.
static BytesReference	toXContent(ToXContent toXContent, XContentType xContentType, ToXContent.Params params, boolean humanReadable)	Returns the bytes that represent the XContent output of the provided ToXContent object, using the provided XContentType.
static boolean	update(Map<String,Object> source, Map<String,Object> changes, boolean checkUpdatesAreUnequal)	Updates the provided changes into the source.
static void	writeRawField(String field, BytesReference source, XContentBuilder builder, ToXContent.Params params)	Deprecated. use writeRawField(String, BytesReference, XContentType, XContentBuilder, Params) to avoid content type auto-detection
static void	writeRawField(String field, BytesReference source, XContentType xContentType, XContentBuilder builder, ToXContent.Params params)	Writes a "raw" (bytes) field, handling cases where the bytes are compressed, and tries to optimize writing using XContentBuilder.rawField(String, InputStream, XContentType).
static XContentType	xContentType(BytesReference bytes)	Deprecated. the content type should not be guessed except for few cases where we effectively don't know the content type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XContentHelper

public XContentHelper()

Method Details

createParser

@Deprecated
public static XContentParser createParser(NamedXContentRegistry xContentRegistry,
 DeprecationHandler deprecationHandler,
 BytesReference bytes)
                                   throws IOException

Deprecated.

use createParser(NamedXContentRegistry, DeprecationHandler, BytesReference, XContentType) to avoid content type auto-detection

Creates a parser based on the bytes provided

Throws:

IOException

createParser

public static XContentParser createParser(NamedXContentRegistry xContentRegistry,
 DeprecationHandler deprecationHandler,
 BytesReference bytes,
 XContentType xContentType)
                                   throws IOException

Creates a parser for the bytes using the supplied content-type

Throws:

IOException

convertToMap

@Deprecated
public static Tuple<XContentType,Map<String,Object>> convertToMap(BytesReference bytes,
 boolean ordered)
                                                           throws ElasticsearchParseException

Deprecated.

this method relies on auto-detection of content type. Use convertToMap(BytesReference, boolean, XContentType) instead with the proper XContentType

Converts the given bytes into a map that is optionally ordered.

Important: This can lose precision on numbers with a decimal point. It converts numbers like "n": 1234.567 to a double which only has 52 bits of precision in the mantissa. This will come up most frequently when folks write nanosecond precision dates as a decimal number.

Throws:

ElasticsearchParseException

convertToMap

public static Tuple<XContentType,Map<String,Object>> convertToMap(BytesReference bytes,
 boolean ordered,
 XContentType xContentType)
                                                           throws ElasticsearchParseException

Converts the given bytes into a map that is optionally ordered. The provided XContentType must be non-null.

Important: This can lose precision on numbers with a decimal point. It converts numbers like "n": 1234.567 to a double which only has 52 bits of precision in the mantissa. This will come up most frequently when folks write nanosecond precision dates as a decimal number.

Throws:

ElasticsearchParseException

convertToMap

public static Map<String,Object> convertToMap(XContent xContent,
 String string,
 boolean ordered)
                                       throws ElasticsearchParseException

Convert a string in some XContent format to a Map. Throws an ElasticsearchParseException if there is any error.

Throws:

ElasticsearchParseException

convertToMap

public static Map<String,Object> convertToMap(XContent xContent,
 InputStream input,
 boolean ordered)
                                       throws ElasticsearchParseException

Convert a string in some XContent format to a Map. Throws an ElasticsearchParseException if there is any error. Note that unlike convertToMap(BytesReference, boolean), this doesn't automatically uncompress the input.

Throws:

ElasticsearchParseException

convertToMap

public static Map<String,Object> convertToMap(XContent xContent,
 byte[] bytes,
 int offset,
 int length,
 boolean ordered)
                                       throws ElasticsearchParseException

Convert a byte array in some XContent format to a Map. Throws an ElasticsearchParseException if there is any error. Note that unlike convertToMap(BytesReference, boolean), this doesn't automatically uncompress the input.

Throws:

ElasticsearchParseException

convertToJson

@Deprecated
public static String convertToJson(BytesReference bytes,
 boolean reformatJson)
                            throws IOException

Deprecated.

Throws:

IOException

convertToJson

@Deprecated
public static String convertToJson(BytesReference bytes,
 boolean reformatJson,
 boolean prettyPrint)
                            throws IOException

Deprecated.

Throws:

IOException

convertToJson

public static String convertToJson(BytesReference bytes,
 boolean reformatJson,
 XContentType xContentType)
                            throws IOException

Throws:

IOException

stripWhitespace

public static String stripWhitespace(String json)
                              throws IOException

Accepts a JSON string, parses it and prints it without pretty-printing it. This is useful where a piece of JSON is formatted for legibility, but needs to be stripped of unnecessary whitespace e.g. for comparison in a test.

Parameters:

json - the JSON to format

Returns:

reformatted JSON

Throws:

IOException - if the reformatting fails, e.g. because the JSON is not well-formed

convertToJson

public static String convertToJson(BytesReference bytes,
 boolean reformatJson,
 boolean prettyPrint,
 XContentType xContentType)
                            throws IOException

Throws:

IOException

update

public static boolean update(Map<String,Object> source,
 Map<String,Object> changes,
 boolean checkUpdatesAreUnequal)

Updates the provided changes into the source. If the key exists in the changes, it overrides the one in source unless both are Maps, in which case it recursively updated it.

Parameters:

source - the original map to be updated

changes - the changes to update into updated

checkUpdatesAreUnequal - should this method check if updates to the same key (that are not both maps) are unequal? This is just a .equals check on the objects, but that can take some time on long strings.

Returns:

true if the source map was modified

mergeDefaults

public static void mergeDefaults(Map<String,Object> content,
 Map<String,Object> defaults)

Merges the defaults provided as the second parameter into the content of the first. Only does recursive merge for inner maps.

writeRawField

@Deprecated
public static void writeRawField(String field,
 BytesReference source,
 XContentBuilder builder,
 ToXContent.Params params)
                          throws IOException

Deprecated.

use writeRawField(String, BytesReference, XContentType, XContentBuilder, Params) to avoid content type auto-detection

Writes a "raw" (bytes) field, handling cases where the bytes are compressed, and tries to optimize writing using XContentBuilder.rawField(String, InputStream).

Throws:

IOException

writeRawField

public static void writeRawField(String field,
 BytesReference source,
 XContentType xContentType,
 XContentBuilder builder,
 ToXContent.Params params)
                          throws IOException

Writes a "raw" (bytes) field, handling cases where the bytes are compressed, and tries to optimize writing using XContentBuilder.rawField(String, InputStream, XContentType).

Throws:

IOException

toXContent

public static BytesReference toXContent(ToXContent toXContent,
 XContentType xContentType,
 boolean humanReadable)
                                 throws IOException

Returns the bytes that represent the XContent output of the provided ToXContent object, using the provided XContentType. Wraps the output into a new anonymous object according to the value returned by the ToXContent.isFragment() method returns.

Throws:

IOException

toXContent

public static BytesReference toXContent(ToXContent toXContent,
 XContentType xContentType,
 ToXContent.Params params,
 boolean humanReadable)
                                 throws IOException

Returns the bytes that represent the XContent output of the provided ToXContent object, using the provided XContentType. Wraps the output into a new anonymous object according to the value returned by the ToXContent.isFragment() method returns.

Throws:

IOException

xContentType

@Deprecated
public static XContentType xContentType(BytesReference bytes)

Deprecated.

the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.

Guesses the content type based on the provided bytes.

childBytes

public static BytesReference childBytes(XContentParser parser)
                                 throws IOException

Returns the contents of an object as an unparsed BytesReference This is useful for things like mappings where we're copying bytes around but don't actually need to parse their contents, and so avoids building large maps of maps unnecessarily

Throws:

IOException