/
JSONWriter.java
384 lines (338 loc) · 10.4 KB
/
JSONWriter.java
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
package org.codehaus.groovy.grails.web.json;
import static org.codehaus.groovy.grails.web.json.JSONWriter.Mode.*;
import groovy.lang.Writable;
import java.io.IOException;
import java.io.Writer;
import java.util.Stack;
/*
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.
*/
/**
* JSONWriter provides a quick and convenient way of producing JSON text.
* The texts produced strictly conform to JSON syntax rules. No whitespace is
* added, so the results are ready for transmission or storage. Each instance of
* JSONWriter can produce one JSON text.
* <p/>
* A JSONWriter instance provides a <code>value</code> method for appending
* values to the
* text, and a <code>key</code>
* method for adding keys before values in objects. There are <code>array</code>
* and <code>endArray</code> methods that make and bound array values, and
* <code>object</code> and <code>endObject</code> methods which make and bound
* object values. All of these methods return the JSONWriter instance,
* permitting a cascade style. For example, <pre>
* new JSONWriter(myWriter)
* .object()
* .key("JSON")
* .value("Hello, World!")
* .endObject();</pre> which writes <pre>
* {"JSON":"Hello, World!"}</pre>
* <p/>
* The first method called must be <code>array</code> or <code>object</code>.
* There are no methods for adding commas or colons. JSONWriter adds them for
* you. Objects and arrays can be nested up to 20 levels deep.
* <p/>
* This can sometimes be easier than using a JSONObject to build a string.
*
* @author JSON.org
* @version 2
*/
public class JSONWriter {
/**
* The comma flag determines if a comma should be output before the next
* value.
*/
protected boolean comma;
/**
* The current mode. Values:
*/
protected Mode mode;
/**
* The Mode stack.
*/
private Stack<Mode> stack = new Stack<Mode>();
/**
* The writer that will receive the output.
*/
protected Writer writer;
/**
* Make a fresh JSONWriter. It can be used to build one JSON text.
*/
public JSONWriter(Writer w) {
this.comma = false;
this.mode = INIT;
this.writer = w;
}
private static class WritableString implements Writable {
private String string;
WritableString(String string) {
this.string = string;
}
@Override
public Writer writeTo(Writer out) throws IOException {
out.write(string);
return out;
}
public String toString() {
return string;
}
}
/**
* Append a value.
* @param s A string value.
* @return this
*/
protected JSONWriter append(String s) {
if (s == null) {
throw new JSONException("Null pointer");
}
return append(new WritableString(s));
}
protected JSONWriter append(Writable writableValue) {
if (this.mode == OBJECT || this.mode == ARRAY) {
try {
if (this.comma && this.mode == ARRAY) {
this.comma();
}
writableValue.writeTo(writer);
} catch (IOException e) {
throw new JSONException(e);
}
if (this.mode == OBJECT) {
this.mode = KEY;
}
this.comma = true;
return this;
}
throw new JSONException("Value out of sequence: expected mode to be OBJECT or ARRAY when writing '" + writableValue + "' but was " + this.mode);
}
protected void comma() {
try {
this.writer.write(',');
} catch (IOException e) {
throw new JSONException(e);
}
}
/**
* Begin appending a new array. All values until the balancing
* <code>endArray</code> will be appended to this array. The
* <code>endArray</code> method must be called to mark the array's end.
*
* @return this
*/
public JSONWriter array() {
if (this.mode == INIT || this.mode == OBJECT || this.mode == ARRAY) {
this.push(ARRAY);
this.append("[");
this.comma = false;
return this;
}
throw new JSONException("Misplaced array: expected mode of INIT, OBJECT or ARRAY but was " + this.mode);
}
/**
* End something.
*
* @param m Mode
* @param c Closing character
* @return this
*/
protected JSONWriter end(Mode m, char c) {
if (this.mode != m) {
throw new JSONException(m == OBJECT ? "Misplaced endObject." :
"Misplaced endArray.");
}
this.pop(m);
try {
this.writer.write(c);
} catch (IOException e) {
throw new JSONException(e);
}
this.comma = true;
return this;
}
/**
* End an array. This method most be called to balance calls to
* <code>array</code>.
*
* @return this
*/
public JSONWriter endArray() {
return end(ARRAY, ']');
}
/**
* End an object. This method most be called to balance calls to
* <code>object</code>.
*
* @return this
*/
public JSONWriter endObject() {
return end(KEY, '}');
}
/**
* Append a key. The key will be associated with the next value. In an
* object, every value must be preceded by a key.
*
* @param s A key string.
* @return this
*/
public JSONWriter key(String s) {
if (s == null) {
throw new JSONException("Null key.");
}
if (this.mode == KEY) {
try {
if (this.comma) {
this.comma();
}
JSONObject.writeQuoted(this.writer, s);
this.writer.write(':');
this.comma = false;
this.mode = OBJECT;
return this;
} catch (IOException e) {
throw new JSONException(e);
}
}
throw new JSONException("Misplaced key: expected mode of KEY but was " + this.mode);
}
/**
* Begin appending a new object. All keys and values until the balancing
* <code>endObject</code> will be appended to this object. The
* <code>endObject</code> method must be called to mark the object's end.
*
* @return this
*/
public JSONWriter object() {
if (this.mode == INIT) {
this.mode = OBJECT;
}
if (this.mode == OBJECT || this.mode == ARRAY) {
this.append("{");
this.push(KEY);
this.comma = false;
return this;
}
throw new JSONException("Misplaced object: expected mode of INIT, OBJECT or ARRAY but was " + this.mode);
}
/**
* Pop an array or object scope.
*
* @param c The scope to close.
*/
protected void pop(Mode c) {
if (this.stack.size() == 0 || this.stack.pop() != c) {
throw new JSONException("Nesting error.");
}
if (this.stack.size() > 0)
this.mode = this.stack.peek();
else
this.mode = DONE;
}
/**
* Push an array or object scope.
*
* @param c The scope to open.
*/
protected void push(Mode c) {
this.stack.push(c);
this.mode = c;
}
/**
* Append either the value <code>true</code> or the value
* <code>false</code>.
*
* @param b A boolean.
* @return this
*/
public JSONWriter value(boolean b) {
return append(b ? "true" : "false");
}
/**
* Append a double value.
*
* @param d A double.
* @return this
*/
public JSONWriter value(double d) {
return value(Double.valueOf(d));
}
/**
* Append a long value.
*
* @param l A long.
* @return this
*/
public JSONWriter value(long l) {
return append(Long.toString(l));
}
/**
* Append a number value
*
* @param number
* @return
*/
public JSONWriter value(Number number) {
return number != null ? append(number.toString()) : valueNull();
}
public JSONWriter valueNull() {
return append(nullWritable);
}
static Writable nullWritable = new NullWritable();
private static class NullWritable implements Writable {
@Override
public Writer writeTo(Writer out) throws IOException {
out.write("null");
return out;
}
}
/**
* Append an object value.
*
* @param o The object to append. It can be null, or a Boolean, Number,
* String, JSONObject, or JSONArray.
* @return this
*/
public JSONWriter value(Object o) {
return o != null ? append(new QuotedWritable(o)) : valueNull();
}
private static class QuotedWritable implements Writable {
Object o;
QuotedWritable(Object o) {
this.o = o;
}
@Override
public Writer writeTo(Writer out) throws IOException {
JSONObject.writeValue(out, o);
return out;
}
public String toString() {
return String.valueOf(o);
}
}
/**
* Enumeration of the possible modes of the JSONWriter
*/
protected enum Mode {
INIT,
OBJECT,
ARRAY,
KEY,
DONE
}
}