Class XContentFactory
- java.lang.Object
-
- org.elasticsearch.common.xcontent.XContentFactory
-
public class XContentFactory extends java.lang.Object
A one stop to useXContent
andXContentBuilder
.
-
-
Constructor Summary
Constructors Constructor Description XContentFactory()
-
Method Summary
Modifier and Type Method Description static XContentBuilder
cborBuilder()
Returns a content builder using CBOR format (XContentType.CBOR
.static XContentBuilder
cborBuilder(java.io.OutputStream os)
Constructs a new cbor builder that will output the result into the provided output stream.static XContentBuilder
contentBuilder(XContentType type)
Returns a binary content builder for the provided content type.static XContentBuilder
contentBuilder(XContentType type, java.io.OutputStream outputStream)
Constructs a xcontent builder that will output the result into the provided output stream.static XContentBuilder
jsonBuilder()
Returns a content builder using JSON format (XContentType.JSON
.static XContentBuilder
jsonBuilder(java.io.OutputStream os)
Constructs a new json builder that will output the result into the provided output stream.static XContentBuilder
smileBuilder()
Returns a content builder using SMILE format (XContentType.SMILE
.static XContentBuilder
smileBuilder(java.io.OutputStream os)
Constructs a new json builder that will output the result into the provided output stream.static XContent
xContent(byte[] data)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type.static XContent
xContent(byte[] data, int offset, int length)
Deprecated.guessing the content type should not be needed ideally.static XContent
xContent(java.lang.CharSequence content)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type.static XContent
xContent(XContentType type)
Returns theXContent
for the provided content type.static XContentType
xContentType(byte[] bytes)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type.static XContentType
xContentType(byte[] bytes, int offset, int length)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type.static XContentType
xContentType(java.io.InputStream si)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type.static XContentType
xContentType(java.lang.CharSequence content)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type.static XContentBuilder
yamlBuilder()
Returns a content builder using YAML format (XContentType.YAML
.static XContentBuilder
yamlBuilder(java.io.OutputStream os)
Constructs a new yaml builder that will output the result into the provided output stream.
-
-
-
Method Detail
-
jsonBuilder
public static XContentBuilder jsonBuilder() throws java.io.IOException
Returns a content builder using JSON format (XContentType.JSON
.- Throws:
java.io.IOException
-
jsonBuilder
public static XContentBuilder jsonBuilder(java.io.OutputStream os) throws java.io.IOException
Constructs a new json builder that will output the result into the provided output stream.- Throws:
java.io.IOException
-
smileBuilder
public static XContentBuilder smileBuilder() throws java.io.IOException
Returns a content builder using SMILE format (XContentType.SMILE
.- Throws:
java.io.IOException
-
smileBuilder
public static XContentBuilder smileBuilder(java.io.OutputStream os) throws java.io.IOException
Constructs a new json builder that will output the result into the provided output stream.- Throws:
java.io.IOException
-
yamlBuilder
public static XContentBuilder yamlBuilder() throws java.io.IOException
Returns a content builder using YAML format (XContentType.YAML
.- Throws:
java.io.IOException
-
yamlBuilder
public static XContentBuilder yamlBuilder(java.io.OutputStream os) throws java.io.IOException
Constructs a new yaml builder that will output the result into the provided output stream.- Throws:
java.io.IOException
-
cborBuilder
public static XContentBuilder cborBuilder() throws java.io.IOException
Returns a content builder using CBOR format (XContentType.CBOR
.- Throws:
java.io.IOException
-
cborBuilder
public static XContentBuilder cborBuilder(java.io.OutputStream os) throws java.io.IOException
Constructs a new cbor builder that will output the result into the provided output stream.- Throws:
java.io.IOException
-
contentBuilder
public static XContentBuilder contentBuilder(XContentType type, java.io.OutputStream outputStream) throws java.io.IOException
Constructs a xcontent builder that will output the result into the provided output stream.- Throws:
java.io.IOException
-
contentBuilder
public static XContentBuilder contentBuilder(XContentType type) throws java.io.IOException
Returns a binary content builder for the provided content type.- Throws:
java.io.IOException
-
xContent
public static XContent xContent(XContentType type)
Returns theXContent
for the provided content type.
-
xContentType
@Deprecated public static XContentType xContentType(java.lang.CharSequence content)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.Guesses the content type based on the provided char sequence.
-
xContent
@Deprecated public static XContent xContent(java.lang.CharSequence content)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.Guesses the content (type) based on the provided char sequence and returns the correspondingXContent
-
xContent
@Deprecated public static XContent xContent(byte[] data)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.Guesses the content type based on the provided bytes and returns the correspondingXContent
-
xContent
@Deprecated public static XContent xContent(byte[] data, int offset, int length)
Deprecated.guessing the content type should not be needed ideally. We should rather know the content type upfront or read it from headers. Till we fixed the REST layer to read the Content-Type header, that should be the only place where guessing is needed.Guesses the content type based on the provided bytes and returns the correspondingXContent
-
xContentType
@Deprecated public static XContentType xContentType(java.io.InputStream si) throws java.io.IOException
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.Guesses the content type based on the provided input stream without consuming it.- Throws:
java.io.IOException
-
xContentType
@Deprecated public static XContentType xContentType(byte[] bytes)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.Guesses the content type based on the provided bytes.
-
xContentType
@Deprecated public static XContentType xContentType(byte[] bytes, int offset, int length)
Deprecated.the content type should not be guessed except for few cases where we effectively don't know the content type. The REST layer should move to reading the Content-Type header instead. There are other places where auto-detection may be needed. This method is deprecated to prevent usages of it from spreading further without specific reasons.Guesses the content type based on the provided bytes.
-
-