Package org.elasticsearch.common.xcontent.yaml

Class YamlXContent

java.lang.Object

org.elasticsearch.common.xcontent.yaml.YamlXContent

All Implemented Interfaces:

XContent

public class YamlXContent
extends java.lang.Object
implements XContent

A YAML based content implementation using Jackson.

Field Summary

Fields

Modifier and Type	Field	Description
static YamlXContent	yamlXContent

Method Summary

Modifier and Type	Method	Description
static XContentBuilder	contentBuilder()
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(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, byte[] data)	Creates a parser over the provided bytes.
XContentParser	createParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, byte[] data, int offset, int length)	Creates a parser over the provided bytes.
XContentParser	createParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, java.io.InputStream is)	Creates a parser over the provided input stream.
XContentParser	createParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, java.io.Reader reader)	Creates a parser over the provided reader.
XContentParser	createParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, java.lang.String content)	Creates a parser over the provided string content.
byte	streamSeparator()
XContentType	type()	The type this content handles and produces.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.XContent

createGenerator

Field Details

yamlXContent

public static final YamlXContent yamlXContent

Method Details

contentBuilder

public static XContentBuilder contentBuilder()
                                      throws java.io.IOException

Throws:

java.io.IOException

type

public XContentType type()

Description copied from interface: XContent

The type this content handles and produces.

Specified by:

type in interface XContent

streamSeparator

public byte streamSeparator()

Specified by:

streamSeparator in interface XContent

createGenerator

public XContentGenerator createGenerator(java.io.OutputStream os,
java.util.Set<java.lang.String> includes,
java.util.Set<java.lang.String> excludes)
                                  throws java.io.IOException

Description copied from interface: XContent

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.

Specified by:

createGenerator in interface XContent

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

public XContentParser createParser(NamedXContentRegistry xContentRegistry,
DeprecationHandler deprecationHandler,
java.lang.String content)
                            throws java.io.IOException

Description copied from interface: XContent

Creates a parser over the provided string content.

Specified by:

createParser in interface XContent

Throws:

java.io.IOException

createParser

public XContentParser createParser(NamedXContentRegistry xContentRegistry,
DeprecationHandler deprecationHandler,
java.io.InputStream is)
                            throws java.io.IOException

Description copied from interface: XContent

Creates a parser over the provided input stream.

Specified by:

createParser in interface XContent

Throws:

java.io.IOException

createParser

public XContentParser createParser(NamedXContentRegistry xContentRegistry,
DeprecationHandler deprecationHandler,
byte[] data)
                            throws java.io.IOException

Description copied from interface: XContent

Creates a parser over the provided bytes.

Specified by:

createParser in interface XContent

Throws:

java.io.IOException

createParser

public XContentParser createParser(NamedXContentRegistry xContentRegistry,
DeprecationHandler deprecationHandler,
byte[] data,
int offset,
int length)
                            throws java.io.IOException

Description copied from interface: XContent

Creates a parser over the provided bytes.

Specified by:

createParser in interface XContent

Throws:

java.io.IOException

createParser

public XContentParser createParser(NamedXContentRegistry xContentRegistry,
DeprecationHandler deprecationHandler,
java.io.Reader reader)
                            throws java.io.IOException

Description copied from interface: XContent

Creates a parser over the provided reader.

Specified by:

createParser in interface XContent

Throws:

java.io.IOException