-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.json.JsonProvider.yml
145 lines (145 loc) · 13.7 KB
/
com.azure.json.JsonProvider.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
### 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.1.0