org.elasticsearch.common.xcontent

Interface XContent

All Known Implementing Classes:

CborXContent, JsonXContent, SmileXContent, YamlXContent

public interface XContent

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

Method Summary

Modifier and Type	Method and Description
default XContentGenerator	createGenerator(java.io.OutputStream os) Creates a new generator using the provided output stream.
XContentGenerator	createGenerator(java.io.OutputStream os, java.util.Set<java.lang.String> includes, java.util.Set<java.lang.String> excludes) Creates a new generator using the provided output stream and some inclusive and/or exclusive filters.
XContentParser	createParser(byte[] data) Creates a parser over the provided bytes.
XContentParser	createParser(byte[] data, int offset, int length) Creates a parser over the provided bytes.
XContentParser	createParser(BytesReference bytes) Creates a parser over the provided bytes.
XContentParser	createParser(java.io.InputStream is) Creates a parser over the provided input stream.
XContentParser	createParser(java.io.Reader reader) Creates a parser over the provided reader.
XContentParser	createParser(java.lang.String content) Creates a parser over the provided string content.
byte	streamSeparator()
XContentType	type() The type this content handles and produces.

Method Detail

type

XContentType type()

The type this content handles and produces.

streamSeparator

byte streamSeparator()

createGenerator

default XContentGenerator createGenerator(java.io.OutputStream os)
                                   throws java.io.IOException

Creates a new generator using the provided output stream.

Throws:

java.io.IOException

createGenerator

XContentGenerator createGenerator(java.io.OutputStream os,
                                  java.util.Set<java.lang.String> includes,
                                  java.util.Set<java.lang.String> excludes)
                           throws java.io.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:

java.io.IOException

createParser

XContentParser createParser(java.lang.String content)
                     throws java.io.IOException

Creates a parser over the provided string content.

Throws:

java.io.IOException

createParser

XContentParser createParser(java.io.InputStream is)
                     throws java.io.IOException

Creates a parser over the provided input stream.

Throws:

java.io.IOException

createParser

XContentParser createParser(byte[] data)
                     throws java.io.IOException

Creates a parser over the provided bytes.

Throws:

java.io.IOException

createParser

XContentParser createParser(byte[] data,
                            int offset,
                            int length)
                     throws java.io.IOException

Creates a parser over the provided bytes.

Throws:

java.io.IOException

createParser

XContentParser createParser(BytesReference bytes)
                     throws java.io.IOException

Creates a parser over the provided bytes.

Throws:

java.io.IOException

createParser

XContentParser createParser(java.io.Reader reader)
                     throws java.io.IOException

Creates a parser over the provided reader.

Throws:

java.io.IOException