forked from stleary/JSON-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStructureWriter.java
More file actions
179 lines (159 loc) · 7.45 KB
/
StructureWriter.java
File metadata and controls
179 lines (159 loc) · 7.45 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
package org.json.write;
/*
Copyright (c) 2006 JSON.org
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The Software shall be used for Good, not Evil.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
import org.json.JSONAppendable;
import org.json.JSONException;
import org.json.JSONString;
import org.json.util.StructureIdentifier;
/**
* Strategy interface for writing a JSON structure, either a JSON Object or
* a JSON Array. A strategy class can implement a compact or a pretty-print
* output.
*
* @author JSON.org
* @version 2016-09-14
*/
public interface StructureWriter extends StructureIdentifier {
/**
* Begin the structure represented by this object, either a JSON Object
* or a JSON Array.
*
* @param writer the Appendable to write any beginning structure content
* @throws JSONException there was a problem beginning the structure
*/
void beginStructure(Appendable writer) throws JSONException;
/**
* Write a key for a JSON Object.
*
* @param key the key to be written
* @param writer the Appendable to write the key
* @throws JSONException this structure is not a JSON Object, the key is
* {@code null}, or there was another problem writing the key
*/
void key(String key, Appendable writer) throws JSONException;
/**
* Indicates that a sub-structure is about to be written. Write any
* JSON content necessary prior to beginning the sub-structure.
*
* @param writer the Appendable to write any delimiters or separators
* @throws JSONException there was a problem writing the delimiter
*/
void subValue(Appendable writer) throws JSONException;
/**
* Write a simple value to the given {@code Appendable}.
*
* @param value the value to be written
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
* @see WriterUtil#isSimpleValue(Object)
*/
boolean simpleValue(Object value, Appendable writer) throws JSONException;
/**
* Write a {@code JSONString} value to the given {@code Appendable}.
*
* @param value the value to be written
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
*/
boolean jsonStringValue(JSONString value, Appendable writer) throws JSONException;
/**
* Write a {@code JSONAppendable} value to the given {@code Appendable}.
*
* @param value the value to be written
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
*/
boolean jsonAppendableValue(JSONAppendable value, Appendable writer) throws JSONException;
/**
* Write a JSON {@code null} value to the given {@code Appendable}.
*
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
*/
boolean nullValue(Appendable writer) throws JSONException;
/**
* Write a {@code boolean} value to the given {@code Appendable}.
*
* @param value the value to be written
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
*/
boolean booleanValue(boolean value, Appendable writer) throws JSONException;
/**
* Write a {@code double} value to the given {@code Appendable}.
*
* @param value the value to be written
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
*/
boolean doubleValue(double value, Appendable writer) throws JSONException;
/**
* Write a {@code long} value to the given {@code Appendable}.
*
* @param value the value to be written
* @param writer the Appendable to which the JSON value will be written
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem writing the value
*/
boolean longValue(long value, Appendable writer) throws JSONException;
/**
* End the structure represented by this object, either a JSON Object
* or a JSON Array.
*
* @param writer the Appendable to write any end structure content
* @return {@code true} to indicate JSON writing has been completed, and
* no more content may be written, otherwise {@code false} to indicate
* more JSON data may be written
* @throws JSONException there was a problem ending the structure
*/
boolean endStructure(Appendable writer) throws JSONException;
/**
* Returns the type of this structure as a char value. The values, by
* convention, are:
* <ul>
* <li>{@code 'i'} — the initial structure, before any JSON Object or
* JSON Array has been written</li>
* <li>{@code 'o'} — a JSON Object</li>
* <li>{@code 'a'} — a JSON Array</li>
* </ul>
* @return the type of this structure, as a char value
*/
char getStructureType();
}