Package org.elasticsearch.xcontent

Interface XContent

public interface XContent

A generic abstraction on top of handling content, inspired by JSON and pull parsing.

Method Summary

Modifier and Type	Method	Description
default XContentGenerator	createGenerator(OutputStream os)	Creates a new generator using the provided output stream.
XContentGenerator	createGenerator(OutputStream os, Set<String> includes, Set<String> excludes)	Creates a new generator using the provided output stream and some inclusive and/or exclusive filters.
default XContentParser	createParser(NamedXContentRegistry registry, DeprecationHandler deprecationHandler, InputStream is)	Deprecated. Use createParser(XContentParserConfiguration, InputStream)
default XContentParser	createParser(XContentParserConfiguration config, byte[] data)	Creates a parser over the provided bytes.
XContentParser	createParser(XContentParserConfiguration config, byte[] data, int offset, int length)	Creates a parser over the provided bytes.
XContentParser	createParser(XContentParserConfiguration config, InputStream is)	Creates a parser over the provided input stream.
XContentParser	createParser(XContentParserConfiguration config, Reader reader)	Creates a parser over the provided reader.
XContentParser	createParser(XContentParserConfiguration config, String content)	Creates a parser over the provided string content.
boolean	detectContent(byte[] bytes, int offset, int length)	Deprecated.
boolean	detectContent(CharSequence chars)	Deprecated.
byte	streamSeparator()
XContentType	type()	The type this content handles and produces.

Method Details

type

XContentType type()

The type this content handles and produces.

streamSeparator

byte streamSeparator()

detectContent

@Deprecated
boolean detectContent(byte[] bytes,
 int offset,
 int length)

Deprecated.

detectContent

@Deprecated
boolean detectContent(CharSequence chars)

Deprecated.

createGenerator

default XContentGenerator createGenerator(OutputStream os)
                                   throws IOException

Creates a new generator using the provided output stream.

Throws:

IOException

createGenerator

XContentGenerator createGenerator(OutputStream os,
 Set<String> includes,
 Set<String> excludes)
                           throws IOException

Creates a new generator using the provided output stream and some inclusive and/or exclusive filters. When both exclusive and inclusive filters are provided, the underlying generator will first use exclusion filters to remove fields and then will check the remaining fields against the inclusive filters.

Parameters:

os - the output stream

includes - the inclusive filters: only fields and objects that match the inclusive filters will be written to the output.

excludes - the exclusive filters: only fields and objects that don't match the exclusive filters will be written to the output.

Throws:

IOException

createParser

XContentParser createParser(XContentParserConfiguration config,
 String content)
                     throws IOException

Creates a parser over the provided string content.

Throws:

IOException

createParser

XContentParser createParser(XContentParserConfiguration config,
 InputStream is)
                     throws IOException

Creates a parser over the provided input stream.

Throws:

IOException

createParser

@Deprecated
default XContentParser createParser(NamedXContentRegistry registry,
 DeprecationHandler deprecationHandler,
 InputStream is)
                             throws IOException

Deprecated.

Use createParser(XContentParserConfiguration, InputStream)

Creates a parser over the provided input stream.

Throws:

IOException

createParser

default XContentParser createParser(XContentParserConfiguration config,
 byte[] data)
                             throws IOException

Creates a parser over the provided bytes.

Throws:

IOException

createParser

XContentParser createParser(XContentParserConfiguration config,
 byte[] data,
 int offset,
 int length)
                     throws IOException

Creates a parser over the provided bytes.

Throws:

IOException

createParser

XContentParser createParser(XContentParserConfiguration config,
 Reader reader)
                     throws IOException

Creates a parser over the provided reader.

Throws:

IOException