167 строки
15 KiB
YAML
167 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.serializer.json.gson.GsonJsonProvider"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider"
|
|
name: "GsonJsonProvider"
|
|
nameWithType: "GsonJsonProvider"
|
|
summary: "GSON-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 final class **GsonJsonProvider**</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.gson.GsonJsonProvider.GsonJsonProvider()"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.GsonJsonProvider()"
|
|
name: "GsonJsonProvider()"
|
|
nameWithType: "GsonJsonProvider.GsonJsonProvider()"
|
|
summary: "Creates an instance of <xref uid=\"com.azure.core.serializer.json.gson.GsonJsonProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GsonJsonProvider\"></xref>."
|
|
syntax: "public GsonJsonProvider()"
|
|
desc: "Creates an instance of <xref uid=\"com.azure.core.serializer.json.gson.GsonJsonProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GsonJsonProvider\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.core.serializer.json.gson.GsonJsonProvider.createReader(byte[],com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createReader(byte[] json, JsonOptions options)"
|
|
name: "createReader(byte[] json, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.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.gson.GsonJsonProvider.createReader(com.google.gson.stream.JsonReader,com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createReader(JsonReader reader, JsonOptions options)"
|
|
name: "createReader(JsonReader reader, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.createReader(JsonReader reader, JsonOptions options)"
|
|
summary: "Creates an instance of <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> wrapping a GSON <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonReader\"></xref>."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonReader\"></xref> parsing JSON."
|
|
name: "reader"
|
|
type: "<xref href=\"com.google.gson.stream.JsonReader?alt=com.google.gson.stream.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options used to create the reader."
|
|
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(JsonReader reader, JsonOptions options)"
|
|
desc: "Creates an instance of <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> wrapping a GSON <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonReader\"></xref>."
|
|
returns:
|
|
description: "A <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> wrapping the <xref uid=\"com.google.gson.stream.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonReader\"></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.gson.GsonJsonProvider.createReader(java.io.InputStream,com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createReader(InputStream json, JsonOptions options)"
|
|
name: "createReader(InputStream json, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.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.gson.GsonJsonProvider.createReader(java.io.Reader,com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createReader(Reader json, JsonOptions options)"
|
|
name: "createReader(Reader json, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.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.gson.GsonJsonProvider.createReader(java.lang.String,com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createReader(String json, JsonOptions options)"
|
|
name: "createReader(String json, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.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.gson.GsonJsonProvider.createWriter(com.google.gson.stream.JsonWriter)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createWriter(JsonWriter writer)"
|
|
name: "createWriter(JsonWriter writer)"
|
|
nameWithType: "GsonJsonProvider.createWriter(JsonWriter writer)"
|
|
summary: "Creates an instance of <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> wrapping a GSON <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonWriter\"></xref>."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonWriter\"></xref> writing JSON."
|
|
name: "writer"
|
|
type: "<xref href=\"com.google.gson.stream.JsonWriter?alt=com.google.gson.stream.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter createWriter(JsonWriter writer)"
|
|
desc: "Creates an instance of <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> wrapping a GSON <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonWriter\"></xref>."
|
|
returns:
|
|
description: "A <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> wrapping the <xref uid=\"com.google.gson.stream.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.google.gson.stream.JsonWriter\"></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.gson.GsonJsonProvider.createWriter(java.io.OutputStream,com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createWriter(OutputStream json, JsonOptions options)"
|
|
name: "createWriter(OutputStream json, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.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.gson.GsonJsonProvider.createWriter(java.io.Writer,com.azure.json.JsonOptions)"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.createWriter(Writer json, JsonOptions options)"
|
|
name: "createWriter(Writer json, JsonOptions options)"
|
|
nameWithType: "GsonJsonProvider.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.gson.GsonJsonProvider.getJsonSerializableTypeAdapterFactory()"
|
|
fullName: "com.azure.core.serializer.json.gson.GsonJsonProvider.getJsonSerializableTypeAdapterFactory()"
|
|
name: "getJsonSerializableTypeAdapterFactory()"
|
|
nameWithType: "GsonJsonProvider.getJsonSerializableTypeAdapterFactory()"
|
|
summary: "Returns a GSON <xref uid=\"com.google.gson.TypeAdapterFactory\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TypeAdapterFactory\"></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 GSON context."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static TypeAdapterFactory getJsonSerializableTypeAdapterFactory()"
|
|
desc: "Returns a GSON <xref uid=\"com.google.gson.TypeAdapterFactory\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TypeAdapterFactory\"></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 GSON context.\n\nUse the <xref uid=\"com.google.gson.TypeAdapterFactory\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TypeAdapterFactory\"></xref> returned by this method when creating your <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Gson\"></xref> with <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GsonBuilder\"></xref> to have GSON support <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonSerializable\"></xref> types."
|
|
returns:
|
|
description: "A GSON <xref uid=\"com.google.gson.TypeAdapterFactory\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TypeAdapterFactory\"></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.google.gson.TypeAdapterFactory?alt=com.google.gson.TypeAdapterFactory&text=TypeAdapterFactory\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "GSON-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.gson"
|
|
artifact: com.azure:azure-core-serializer-json-gson:1.3.1
|