org.elasticsearch.common.xcontent

クラス XContentHelper

java.lang.Object

org.elasticsearch.common.xcontent.XContentHelper

public class XContentHelper
extends Object

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
XContentHelper()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static String	convertToJson(byte[] data, int offset, int length, boolean reformatJson)
static String	convertToJson(byte[] data, int offset, int length, boolean reformatJson, boolean prettyPrint)
static String	convertToJson(BytesReference bytes, boolean reformatJson)
static String	convertToJson(BytesReference bytes, boolean reformatJson, boolean prettyPrint)
static Tuple<XContentType,Map<String,Object>>	convertToMap(BytesReference bytes, boolean ordered)
static void	copyCurrentEvent(XContentGenerator generator, XContentParser parser)
static void	copyCurrentStructure(XContentGenerator generator, XContentParser parser)
static XContentParser	createParser(BytesReference bytes)
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	toString(ToXContent toXContent) Writes serialized toXContent to pretty-printed JSON string.
static String	toString(ToXContent toXContent, ToXContent.Params params) Writes serialized toXContent to pretty-printed JSON string.
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) Writes a "raw" (bytes) field, handling cases where the bytes are compressed, and tries to optimize writing using XContentBuilder.rawField(String, org.elasticsearch.common.bytes.BytesReference).

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

XContentHelper

public XContentHelper()

メソッドの詳細

createParser

public static XContentParser createParser(BytesReference bytes)
                                   throws IOException

例外:

IOException

convertToMap

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

例外:

ElasticsearchParseException

convertToJson

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

例外:

IOException

convertToJson

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

例外:

IOException

convertToJson

public static String convertToJson(byte[] data,
                                   int offset,
                                   int length,
                                   boolean reformatJson)
                            throws IOException

例外:

IOException

convertToJson

public static String convertToJson(byte[] data,
                                   int offset,
                                   int length,
                                   boolean reformatJson,
                                   boolean prettyPrint)
                            throws IOException

例外:

IOException

toString

public static String toString(ToXContent toXContent)

Writes serialized toXContent to pretty-printed JSON string.

パラメータ:

toXContent - object to be pretty printed

戻り値:

pretty-printed JSON serialization

toString

public static String toString(ToXContent toXContent,
                              ToXContent.Params params)

Writes serialized toXContent to pretty-printed JSON string.

パラメータ:

toXContent - object to be pretty printed

params - serialization parameters

戻り値:

pretty-printed JSON serialization

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 recuersively updated it.

パラメータ:

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.

戻り値:

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.

copyCurrentStructure

public static void copyCurrentStructure(XContentGenerator generator,
                                        XContentParser parser)
                                 throws IOException

例外:

IOException

copyCurrentEvent

public static void copyCurrentEvent(XContentGenerator generator,
                                    XContentParser parser)
                             throws IOException

例外:

IOException

writeRawField

public static void writeRawField(String field,
                                 BytesReference source,
                                 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, org.elasticsearch.common.bytes.BytesReference).

例外:

IOException