This repository was archived by the owner on Nov 7, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 70
Expand file tree
/
Copy pathJsonReader.java
More file actions
157 lines (148 loc) · 5.92 KB
/
JsonReader.java
File metadata and controls
157 lines (148 loc) · 5.92 KB
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
146
147
148
149
150
151
152
153
154
155
156
157
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.json;
import java.io.Closeable;
/**
* Reads a JSON {@link JsonObject object} or an {@link JsonArray array}
* structure from an input source.
*
* <p>The class {@link javax.json.Json} contains methods to create readers from
* input sources ({@link java.io.InputStream} and {@link java.io.Reader}).
*
* <p>
* The following example demonstrates how to read an empty JSON array from
* a string:
* <pre>
* <code>
* JsonReader jsonReader = Json.createReader(new StringReader("[]"));
* JsonArray array = jsonReader.readArray();
* jsonReader.close();
* </code>
* </pre>
*
* <p>
* The class {@link JsonReaderFactory} also contains methods to create
* {@code JsonReader} instances. A factory instance can be used to create
* multiple reader instances with the same configuration. This the preferred
* way to create multiple instances. A sample usage is shown in the following
* example:
* <pre>
* <code>
* JsonReaderFactory factory = Json.createReaderFactory(config);
* JsonReader reader1 = factory.createReader(...);
* JsonReader reader2 = factory.createReader(...);
* </code>
* </pre>
*/
public interface JsonReader extends /*Auto*/Closeable {
/**
* Returns a JSON array or object that is represented in
* the input source. This method needs to be called
* only once for a reader instance.
*
* @return a JSON object or array
* @throws JsonException if a JSON object or array cannot
* be created due to i/o error (IOException would be
* cause of JsonException)
* @throws javax.json.stream.JsonParsingException if a JSON object or array
* cannot be created due to incorrect representation
* @throws IllegalStateException if read, readObject, readArray,
* readValue or close method is already called
*/
JsonStructure read();
/**
* Returns a JSON object that is represented in
* the input source. This method needs to be called
* only once for a reader instance.
*
* @return a JSON object
* @throws JsonException if a JSON object cannot
* be created due to i/o error (IOException would be
* cause of JsonException)
* @throws javax.json.stream.JsonParsingException if a JSON object cannot
* be created due to incorrect representation
* @throws IllegalStateException if read, readObject, readArray,
* readValue or close method is already called
*/
JsonObject readObject();
/**
* Returns a JSON array that is represented in
* the input source. This method needs to be called
* only once for a reader instance.
*
* @return a JSON array
* @throws JsonException if a JSON array cannot
* be created due to i/o error (IOException would be
* cause of JsonException)
* @throws javax.json.stream.JsonParsingException if a JSON array cannot
* be created due to incorrect representation
* @throws IllegalStateException if read, readObject, readArray,
* readValue or close method is already called
*/
JsonArray readArray();
/**
* Returns a JSON value that is represented in
* the input source. This method needs to be called
* only once for a reader instance.
*
* @return a JSON value
* @throws JsonException if a JSON value
* be created due to i/o error (IOException would be
* cause of JsonException)
* @throws javax.json.stream.JsonParsingException if a JSON value
* cannot be created due to incorrect representation
* @throws IllegalStateException if read, readObject, readArray,
* readValue or close method is already called
*
* @since 1.1
*/
default JsonValue readValue() {
throw new UnsupportedOperationException();
}
/**
* Closes this reader and frees any resources associated with the
* reader. This method closes the underlying input source.
*
* @throws JsonException if an i/o error occurs (IOException would be
* cause of JsonException)
*/
@Override
void close();
}