azure-docs-sdk-java/docs-ref-autogen/com.azure.core.serializer.j...

164 строки
15 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider"
name: "JacksonJsonProvider"
nameWithType: "JacksonJsonProvider"
summary: "Jackson-based implementation of <xref uid=\"com.azure.json.JsonProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonProvider\"></xref>."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **JacksonJsonProvider**</br> implements <xref href=\"com.azure.json.JsonProvider?alt=com.azure.json.JsonProvider&text=JsonProvider\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.JacksonJsonProvider()"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.JacksonJsonProvider()"
name: "JacksonJsonProvider()"
nameWithType: "JacksonJsonProvider.JacksonJsonProvider()"
summary: "Creates an instance of <xref uid=\"com.azure.core.serializer.json.jackson.JacksonJsonProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JacksonJsonProvider\"></xref>."
syntax: "public JacksonJsonProvider()"
desc: "Creates an instance of <xref uid=\"com.azure.core.serializer.json.jackson.JacksonJsonProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JacksonJsonProvider\"></xref>."
methods:
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(byte[],com.azure.json.JsonOptions)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(byte[] json, JsonOptions options)"
name: "createReader(byte[] json, JsonOptions options)"
nameWithType: "JacksonJsonProvider.createReader(byte[] json, JsonOptions options)"
parameters:
- name: "json"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonReader createReader(byte[] json, JsonOptions options)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(com.fasterxml.jackson.core.JsonParser)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(JsonParser parser)"
name: "createReader(JsonParser parser)"
nameWithType: "JacksonJsonProvider.createReader(JsonParser parser)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> wrapping a Jackson <xref uid=\"com.fasterxml.jackson.core.JsonParser\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonParser\"></xref>."
parameters:
- description: "The <xref uid=\"com.fasterxml.jackson.core.JsonParser\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonParser\"></xref> parsing JSON."
name: "parser"
type: "<xref href=\"com.fasterxml.jackson.core.JsonParser?alt=com.fasterxml.jackson.core.JsonParser&text=JsonParser\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonReader createReader(JsonParser parser)"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> wrapping a Jackson <xref uid=\"com.fasterxml.jackson.core.JsonParser\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonParser\"></xref>."
returns:
description: "A <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> wrapping the <xref uid=\"com.fasterxml.jackson.core.JsonParser\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonParser\"></xref>."
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(java.io.InputStream,com.azure.json.JsonOptions)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(InputStream json, JsonOptions options)"
name: "createReader(InputStream json, JsonOptions options)"
nameWithType: "JacksonJsonProvider.createReader(InputStream json, JsonOptions options)"
parameters:
- name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
- name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonReader createReader(InputStream json, JsonOptions options)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(java.io.Reader,com.azure.json.JsonOptions)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(Reader json, JsonOptions options)"
name: "createReader(Reader json, JsonOptions options)"
nameWithType: "JacksonJsonProvider.createReader(Reader json, JsonOptions options)"
parameters:
- name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html\">Reader</a>"
- name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonReader createReader(Reader json, JsonOptions options)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(java.lang.String,com.azure.json.JsonOptions)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createReader(String json, JsonOptions options)"
name: "createReader(String json, JsonOptions options)"
nameWithType: "JacksonJsonProvider.createReader(String json, JsonOptions options)"
parameters:
- name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonReader createReader(String json, JsonOptions options)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createWriter(com.fasterxml.jackson.core.JsonGenerator)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createWriter(JsonGenerator generator)"
name: "createWriter(JsonGenerator generator)"
nameWithType: "JacksonJsonProvider.createWriter(JsonGenerator generator)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> wrapping a Jackson <xref uid=\"com.fasterxml.jackson.core.JsonGenerator\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonGenerator\"></xref>."
parameters:
- description: "The <xref uid=\"com.fasterxml.jackson.core.JsonGenerator\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonGenerator\"></xref> writing JSON."
name: "generator"
type: "<xref href=\"com.fasterxml.jackson.core.JsonGenerator?alt=com.fasterxml.jackson.core.JsonGenerator&text=JsonGenerator\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter createWriter(JsonGenerator generator)"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> wrapping a Jackson <xref uid=\"com.fasterxml.jackson.core.JsonGenerator\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonGenerator\"></xref>."
returns:
description: "A <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> wrapping the <xref uid=\"com.fasterxml.jackson.core.JsonGenerator\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonGenerator\"></xref>."
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createWriter(java.io.OutputStream,com.azure.json.JsonOptions)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createWriter(OutputStream json, JsonOptions options)"
name: "createWriter(OutputStream json, JsonOptions options)"
nameWithType: "JacksonJsonProvider.createWriter(OutputStream json, JsonOptions options)"
parameters:
- name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
- name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter createWriter(OutputStream json, JsonOptions options)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createWriter(java.io.Writer,com.azure.json.JsonOptions)"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.createWriter(Writer json, JsonOptions options)"
name: "createWriter(Writer json, JsonOptions options)"
nameWithType: "JacksonJsonProvider.createWriter(Writer json, JsonOptions options)"
parameters:
- name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html\">Writer</a>"
- name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter createWriter(Writer json, JsonOptions options)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.getJsonSerializableDatabindModule()"
fullName: "com.azure.core.serializer.json.jackson.JacksonJsonProvider.getJsonSerializableDatabindModule()"
name: "getJsonSerializableDatabindModule()"
nameWithType: "JacksonJsonProvider.getJsonSerializableDatabindModule()"
summary: "Returns a Jackson Databind <xref uid=\"com.fasterxml.jackson.databind.Module\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Module\"></xref> that allows for `com.azure.json` implementations to handle deserialization and serialization of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonSerializable\"></xref> types within a Jackson Databind context."
modifiers:
- "static"
syntax: "public static Module getJsonSerializableDatabindModule()"
desc: "Returns a Jackson Databind <xref uid=\"com.fasterxml.jackson.databind.Module\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Module\"></xref> that allows for `com.azure.json` implementations to handle deserialization and serialization of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonSerializable\"></xref> types within a Jackson Databind context.\n\nUse the <xref uid=\"com.fasterxml.jackson.databind.Module\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Module\"></xref> returned by this method with your instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ObjectMapper\"></xref> to have Jackson Databind support <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonSerializable\"></xref> types."
returns:
description: "A Jackson Databind <xref uid=\"com.fasterxml.jackson.databind.Module\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Module\"></xref> that handles deserialization and serialization of\n <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonSerializable\"></xref> types."
type: "<xref href=\"com.fasterxml.jackson.databind.Module?alt=com.fasterxml.jackson.databind.Module&text=Module\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Jackson-based implementation of <xref uid=\"com.azure.json.JsonProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonProvider\"></xref>."
implements:
- "<xref href=\"com.azure.json.JsonProvider?alt=com.azure.json.JsonProvider&text=JsonProvider\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.azure.core.serializer.json.jackson"
artifact: com.azure:azure-core-serializer-json-jackson:1.5.3