Package org.elasticsearch.common.xcontent

Class XContentElasticsearchExtension

java.lang.Object

org.elasticsearch.common.xcontent.XContentElasticsearchExtension

All Implemented Interfaces:

XContentBuilderExtension

public class XContentElasticsearchExtension
extends Object
implements XContentBuilderExtension

SPI extensions for Elasticsearch-specific classes (like the Lucene or Joda dependency classes) that need to be encoded by XContentBuilder in a specific way.

Field Summary

Fields

Modifier and Type	Field	Description
static org.joda.time.format.DateTimeFormatter	DEFAULT_DATE_PRINTER
static DateFormatter	DEFAULT_FORMATTER
static DateFormatter	LOCAL_TIME_FORMATTER
static DateFormatter	OFFSET_TIME_FORMATTER

Constructor Summary

Constructors

Constructor	Description
XContentElasticsearchExtension()

Method Summary

Modifier and Type	Method	Description
Map<Class<?>,Function<Object,Object>>	getDateTransformers()	Used for plugging a transformer for a date or time type object into a String (or other encodable object).
Map<Class<?>,XContentBuilder.HumanReadableTransformer>	getXContentHumanReadableTransformers()	Used for plugging in a human readable version of a class's encoding.
Map<Class<?>,XContentBuilder.Writer>	getXContentWriters()	Used for plugging in a generic writer for a class, for example, an example implementation:

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATE_PRINTER

public static final org.joda.time.format.DateTimeFormatter DEFAULT_DATE_PRINTER

DEFAULT_FORMATTER

public static final DateFormatter DEFAULT_FORMATTER

LOCAL_TIME_FORMATTER

public static final DateFormatter LOCAL_TIME_FORMATTER

OFFSET_TIME_FORMATTER

public static final DateFormatter OFFSET_TIME_FORMATTER

Constructor Detail

XContentElasticsearchExtension

public XContentElasticsearchExtension()

Method Detail

getXContentWriters

public Map<Class<?>,XContentBuilder.Writer> getXContentWriters()

Description copied from interface: XContentBuilderExtension

Used for plugging in a generic writer for a class, for example, an example implementation:

 
     Map<Class<?>, XContentBuilder.Writer> addlWriters = new HashMap<>();
     addlWriters.put(BytesRef.class, (builder, value) -> b.value(((BytesRef) value).utf8String()));
     return addlWriters;
 
 

Specified by:

getXContentWriters in interface XContentBuilderExtension

Returns:

a map of class name to writer

getXContentHumanReadableTransformers

public Map<Class<?>,XContentBuilder.HumanReadableTransformer> getXContentHumanReadableTransformers()

Description copied from interface: XContentBuilderExtension

Used for plugging in a human readable version of a class's encoding. It is assumed that the human readable equivalent is always behind the toString() method, so this transformer returns the raw value to be used. An example implementation:

 
     Map<Class<?>, XContentBuilder.HumanReadableTransformer> transformers = new HashMap<>();
     transformers.put(ByteSizeValue.class, (value) -> ((ByteSizeValue) value).bytes());
 
 

Specified by:

getXContentHumanReadableTransformers in interface XContentBuilderExtension

Returns:

a map of class name to transformer used to retrieve raw value

getDateTransformers

public Map<Class<?>,Function<Object,Object>> getDateTransformers()

Description copied from interface: XContentBuilderExtension

Used for plugging a transformer for a date or time type object into a String (or other encodable object). For example:

 
     final DateTimeFormatter datePrinter = ISODateTimeFormat.dateTime().withZone(DateTimeZone.UTC);
     Map<Class<?>, Function<Object, Object>> transformers = new HashMap<>();
     transformers.put(Date.class, d -> datePrinter.print(((Date) d).getTime()));
 
 

Specified by:

getDateTransformers in interface XContentBuilderExtension