azure-docs-sdk-java/docs-ref-autogen/com.azure.json.JsonProvider...

146 строки
14 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.json.JsonProvider"
fullName: "com.azure.json.JsonProvider"
name: "JsonProvider"
nameWithType: "JsonProvider"
summary: "An interface to be implemented by any azure-json plugin that wishes to provide an alternate <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> or <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> implementation."
syntax: "public interface **JsonProvider**"
methods:
- uid: "com.azure.json.JsonProvider.createReader(byte[],com.azure.json.JsonOptions)"
fullName: "com.azure.json.JsonProvider.createReader(byte[] json, JsonOptions options)"
name: "createReader(byte[] json, JsonOptions options)"
nameWithType: "JsonProvider.createReader(byte[] json, JsonOptions options)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a `byte[]`."
modifiers:
- "abstract"
parameters:
- description: "The JSON represented as a <code>byte[]</code>."
name: "json"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- description: "<xref uid=\"com.azure.json.JsonOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonOptions\"></xref> to configure the creation of the <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref>."
name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract JsonReader createReader(byte[] json, JsonOptions options)"
exceptions:
- description: "If <code>json</code> or <code>options</code> is null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a `byte[]`."
returns:
description: "A new instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"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.json.JsonProvider.createReader(java.io.InputStream,com.azure.json.JsonOptions)"
fullName: "com.azure.json.JsonProvider.createReader(InputStream json, JsonOptions options)"
name: "createReader(InputStream json, JsonOptions options)"
nameWithType: "JsonProvider.createReader(InputStream json, JsonOptions options)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
modifiers:
- "abstract"
parameters:
- description: "The JSON represented as a <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
- description: "<xref uid=\"com.azure.json.JsonOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonOptions\"></xref> to configure the creation of the <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref>."
name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract JsonReader createReader(InputStream json, JsonOptions options)"
exceptions:
- description: "If <code>json</code> or <code>options</code> is null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
returns:
description: "A new instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"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.json.JsonProvider.createReader(java.io.Reader,com.azure.json.JsonOptions)"
fullName: "com.azure.json.JsonProvider.createReader(Reader json, JsonOptions options)"
name: "createReader(Reader json, JsonOptions options)"
nameWithType: "JsonProvider.createReader(Reader json, JsonOptions options)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a <xref uid=\"java.io.Reader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Reader\"></xref>."
modifiers:
- "abstract"
parameters:
- description: "The JSON represented as a <xref uid=\"java.io.Reader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Reader\"></xref>."
name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Reader.html\">Reader</a>"
- description: "<xref uid=\"com.azure.json.JsonOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonOptions\"></xref> to configure the creation of the <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref>."
name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract JsonReader createReader(Reader json, JsonOptions options)"
exceptions:
- description: "If <code>json</code> or <code>options</code> is null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a <xref uid=\"java.io.Reader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Reader\"></xref>."
returns:
description: "A new instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"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.json.JsonProvider.createReader(java.lang.String,com.azure.json.JsonOptions)"
fullName: "com.azure.json.JsonProvider.createReader(String json, JsonOptions options)"
name: "createReader(String json, JsonOptions options)"
nameWithType: "JsonProvider.createReader(String json, JsonOptions options)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a <xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref>."
modifiers:
- "abstract"
parameters:
- description: "The JSON represented as a <xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref>."
name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.azure.json.JsonOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonOptions\"></xref> to configure the creation of the <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref>."
name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract JsonReader createReader(String json, JsonOptions options)"
exceptions:
- description: "If <code>json</code> or <code>options</code> is null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> that reads a <xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref>."
returns:
description: "A new instance of <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"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.json.JsonProvider.createWriter(java.io.OutputStream,com.azure.json.JsonOptions)"
fullName: "com.azure.json.JsonProvider.createWriter(OutputStream json, JsonOptions options)"
name: "createWriter(OutputStream json, JsonOptions options)"
nameWithType: "JsonProvider.createWriter(OutputStream json, JsonOptions options)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> that writes to an <xref uid=\"java.io.OutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OutputStream\"></xref>."
modifiers:
- "abstract"
parameters:
- description: "The JSON represented as an <xref uid=\"java.io.OutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OutputStream\"></xref>."
name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
- description: "<xref uid=\"com.azure.json.JsonOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonOptions\"></xref> to configure the creation of the <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref>."
name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract JsonWriter createWriter(OutputStream json, JsonOptions options)"
exceptions:
- description: "If <code>json</code> or <code>options</code> is null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> that writes to an <xref uid=\"java.io.OutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"OutputStream\"></xref>."
returns:
description: "A new instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"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.json.JsonProvider.createWriter(java.io.Writer,com.azure.json.JsonOptions)"
fullName: "com.azure.json.JsonProvider.createWriter(Writer json, JsonOptions options)"
name: "createWriter(Writer json, JsonOptions options)"
nameWithType: "JsonProvider.createWriter(Writer json, JsonOptions options)"
summary: "Creates an instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> that writes to an <xref uid=\"java.io.Writer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Writer\"></xref>."
modifiers:
- "abstract"
parameters:
- description: "The JSON represented as an <xref uid=\"java.io.Writer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Writer\"></xref>."
name: "json"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html\">Writer</a>"
- description: "<xref uid=\"com.azure.json.JsonOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonOptions\"></xref> to configure the creation of the <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref>."
name: "options"
type: "<xref href=\"com.azure.json.JsonOptions?alt=com.azure.json.JsonOptions&text=JsonOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract JsonWriter createWriter(Writer json, JsonOptions options)"
exceptions:
- description: "If <code>json</code> or <code>options</code> is null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Creates an instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> that writes to an <xref uid=\"java.io.Writer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Writer\"></xref>."
returns:
description: "A new instance of <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref>."
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "interface"
desc: "An interface to be implemented by any azure-json plugin that wishes to provide an alternate <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> or <xref uid=\"com.azure.json.JsonWriter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonWriter\"></xref> implementation."
metadata: {}
package: "com.azure.json"
artifact: com.azure:azure-json:1.3.0