Package org.opensearch.common.xcontent

Class XContentFactory

java.lang.Object

org.opensearch.common.xcontent.XContentFactory

public class XContentFactory
extends Object

A one stop to use XContent and XContentBuilder.

Constructor Summary

Constructors

Constructor	Description
XContentFactory()

Method Summary

Modifier and Type	Method	Description
static org.opensearch.core.xcontent.XContentBuilder	cborBuilder()	Returns a content builder using CBOR format (XContentType.CBOR.
static org.opensearch.core.xcontent.XContentBuilder	jsonBuilder()	Returns a content builder using JSON format (XContentType.JSON.
static org.opensearch.core.xcontent.XContentBuilder	jsonBuilder(OutputStream os)	Constructs a new json builder that will output the result into the provided output stream.
static org.opensearch.core.xcontent.XContentBuilder	smileBuilder()	Returns a content builder using SMILE format (XContentType.SMILE.
static org.opensearch.core.xcontent.XContentBuilder	smileBuilder(OutputStream os)	Constructs a new json builder that will output the result into the provided output stream.
static org.opensearch.core.xcontent.XContentBuilder	yamlBuilder()	Returns a content builder using YAML format (XContentType.YAML.
static org.opensearch.core.xcontent.XContentBuilder	yamlBuilder(OutputStream os)	Constructs a new yaml builder that will output the result into the provided output stream.

Methods inherited from class java.lang.Object

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

Constructor Details

XContentFactory

public XContentFactory()

Method Details

jsonBuilder

public static org.opensearch.core.xcontent.XContentBuilder jsonBuilder()
                                                                throws IOException

Returns a content builder using JSON format (XContentType.JSON.

Throws:

IOException

jsonBuilder

public static org.opensearch.core.xcontent.XContentBuilder jsonBuilder(OutputStream os)
                                                                throws IOException

Constructs a new json builder that will output the result into the provided output stream.

Throws:

IOException

smileBuilder

public static org.opensearch.core.xcontent.XContentBuilder smileBuilder()
                                                                 throws IOException

Returns a content builder using SMILE format (XContentType.SMILE.

Throws:

IOException

smileBuilder

public static org.opensearch.core.xcontent.XContentBuilder smileBuilder(OutputStream os)
                                                                 throws IOException

Constructs a new json builder that will output the result into the provided output stream.

Throws:

IOException

yamlBuilder

public static org.opensearch.core.xcontent.XContentBuilder yamlBuilder()
                                                                throws IOException

Returns a content builder using YAML format (XContentType.YAML.

Throws:

IOException

yamlBuilder

public static org.opensearch.core.xcontent.XContentBuilder yamlBuilder(OutputStream os)
                                                                throws IOException

Constructs a new yaml builder that will output the result into the provided output stream.

Throws:

IOException

cborBuilder

public static org.opensearch.core.xcontent.XContentBuilder cborBuilder()
                                                                throws IOException

Returns a content builder using CBOR format (XContentType.CBOR.

Throws:

IOException