-
Notifications
You must be signed in to change notification settings - Fork 24
/
JSONArray.java
707 lines (627 loc) · 21.6 KB
/
JSONArray.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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
package org.json;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.NoSuchElementException;
/**
* A JSONArray is an ordered sequence of values. Its external form is a string
* wrapped in square brackets with commas between the values. The internal form
* is an object having get() and opt() methods for accessing the values by
* index, and put() methods for adding or replacing values. The values can be
* any of these types: Boolean, JSONArray, JSONObject, Number, String, or the
* JSONObject.NULL object.
* <p>
* The constructor can convert a JSON external form string into an
* internal form Java object. The toString() method creates an external
* form string.
* <p>
* A get() method returns a value if one can be found, and throws an exception
* if one cannot be found. An opt() method returns a default value instead of
* throwing an exception, and so is useful for obtaining optional values.
* <p>
* The generic get() and opt() methods return an object which you can cast or
* query for type. There are also typed get() and opt() methods that do typing
* checking and type coersion for you.
* <p>
* The texts produced by the toString() methods are very strict.
* The constructors are more forgiving in the texts they will accept.
* <ul>
* <li>An extra <code>,</code> <small>(comma)</small> may appear just before the closing bracket.</li>
* <li>The value null will be inserted when there is <code>,</code> <small>(comma)</small> elision.</li>
* <li>Strings may be quoted with <code>'</code> <small>(single quote)</small>.</li>
* <li>Strings do not need to be quoted at all if they do not contain leading
* or trailing spaces, and if they do not contain any of these characters:
* <code>{ } [ ] / \ : , ' "</code></li>
* <li>Numbers may have the 0- (octal) or 0x- (hex) prefix.</li>
* </ul>
* <p>
* Public Domain 2002 JSON.org
* @author JSON.org
* @version 0.1
*/
public class JSONArray {
/**
* The getArrayList where the JSONArray's properties are kept.
*/
private ArrayList<Object> myArrayList;
/**
* Construct an empty JSONArray.
*/
public JSONArray() {
myArrayList = new ArrayList<Object>();
}
/**
* Construct a JSONArray from a JSONTokener.
* @param x A JSONTokener
* @exception ParseException A JSONArray must start with '['
* @exception ParseException Expected a ',' or ']'
*/
public JSONArray(JSONTokener x) throws ParseException {
this();
if (x.nextClean() != '[') {
throw x.syntaxError("A JSONArray must start with '['");
}
if (x.nextClean() == ']') {
return;
}
x.back();
while (true) {
if (x.nextClean() == ',') {
x.back();
myArrayList.add(null);
} else {
x.back();
myArrayList.add(x.nextValue());
}
switch (x.nextClean()) {
case ',':
if (x.nextClean() == ']') {
return;
}
x.back();
break;
case ']':
return;
default:
throw x.syntaxError("Expected a ',' or ']'");
}
}
}
/**
* Construct a JSONArray from a source string.
* @param string A string that begins with
* <code>[</code> <small>(left bracket)</small>
* and ends with <code>]</code> <small>(right bracket)</small>.
* @exception ParseException The string must conform to JSON syntax.
*/
public JSONArray(String string) throws ParseException {
this(new JSONTokener(string));
}
/**
* Construct a JSONArray from a Collection.
* @param collection A Collection.
*/
public JSONArray(Collection<Object> collection) {
myArrayList = new ArrayList<Object>(collection);
}
/**
* Get the object value associated with an index.
* @param index
* The index must be between 0 and length() - 1.
* @return An object value.
* @exception NoSuchElementException
*/
public Object get(int index) throws NoSuchElementException {
Object o = opt(index);
if (o == null) {
throw new NoSuchElementException("JSONArray[" + index +
"] not found.");
}
return o;
}
/**
* Get the ArrayList which is holding the elements of the JSONArray.
* @return The ArrayList.
*/
ArrayList<Object> getArrayList() {
return myArrayList;
}
/**
* Get the boolean value associated with an index.
* The string values "true" and "false" are converted to boolean.
* @param index The index must be between 0 and length() - 1.
* @return The truth.
* @exception NoSuchElementException if the index is not found
* @exception ClassCastException
*/
public boolean getBoolean(int index)
throws ClassCastException, NoSuchElementException {
Object o = get(index);
if (o == Boolean.FALSE || o.equals("false")) {
return false;
} else if (o == Boolean.TRUE || o.equals("true")) {
return true;
}
throw new ClassCastException("JSONArray[" + index +
"] not a Boolean.");
}
/**
* Get the double value associated with an index.
* @param index The index must be between 0 and length() - 1.
* @return The value.
* @exception NoSuchElementException if the key is not found
* @exception NumberFormatException
* if the value cannot be converted to a number.
*
*/
public double getDouble(int index)
throws NoSuchElementException, NumberFormatException {
Object o = get(index);
if (o instanceof Number) {
return ((Number) o).doubleValue();
}
if (o instanceof String) {
return Double.parseDouble((String) o);
}
throw new NumberFormatException("JSONObject[" +
index + "] is not a number.");
}
/**
* Get the int value associated with an index.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
* @exception NoSuchElementException if the key is not found
* @exception NumberFormatException
* if the value cannot be converted to a number.
*
*/
public int getInt(int index)
throws NoSuchElementException, NumberFormatException {
Object o = get(index);
if (o instanceof Number) {
return ((Number)o).intValue();
}
return (int)getDouble(index);
}
/**
* Get the JSONArray associated with an index.
* @param index The index must be between 0 and length() - 1.
* @return A JSONArray value.
* @exception NoSuchElementException if the index is not found or if the
* value is not a JSONArray
*/
public JSONArray getJSONArray(int index) throws NoSuchElementException {
Object o = get(index);
if (o instanceof JSONArray) {
return (JSONArray)o;
}
throw new NoSuchElementException("JSONArray[" + index +
"] is not a JSONArray.");
}
/**
* Get the JSONObject associated with an index.
* @param index subscript
* @return A JSONObject value.
* @exception NoSuchElementException if the index is not found or if the
* value is not a JSONObject
*/
public JSONObject getJSONObject(int index) throws NoSuchElementException {
Object o = get(index);
if (o instanceof JSONObject) {
return (JSONObject)o;
}
throw new NoSuchElementException("JSONArray[" + index +
"] is not a JSONObject.");
}
/**
* Get the string associated with an index.
* @param index The index must be between 0 and length() - 1.
* @return A string value.
* @exception NoSuchElementException
*/
public String getString(int index) throws NoSuchElementException {
return get(index).toString();
}
/**
* Determine if the value is null.
* @param index The index must be between 0 and length() - 1.
* @return true if the value at the index is null, or if there is no value.
*/
public boolean isNull(int index) {
Object o = opt(index);
return o == null || o.equals(null);
}
/**
* Make a string from the contents of this JSONArray. The separator string
* is inserted between each element.
* Warning: This method assumes that the data structure is acyclical.
* @param separator A string that will be inserted between the elements.
* @return a string.
*/
public String join(String separator) {
int i;
Object o;
StringBuffer sb = new StringBuffer();
for (i = 0; i < myArrayList.size(); i += 1) {
if (i > 0) {
sb.append(separator);
}
o = myArrayList.get(i);
if (o == null) {
sb.append("null");
} else if (o instanceof String) {
sb.append(JSONObject.quote((String)o));
} else if (o instanceof Number) {
sb.append(JSONObject.numberToString((Number)o));
} else {
sb.append(o.toString());
}
}
return sb.toString();
}
/**
* Get the length of the JSONArray.
*
* @return The length (or size).
*/
public int length() {
return myArrayList.size();
}
/**
* Get the optional object value associated with an index.
* @param index The index must be between 0 and length() - 1.
* @return An object value, or null if there is no
* object at that index.
*/
public Object opt(int index) {
if (index < 0 || index >= length()) {
return null;
} else {
return myArrayList.get(index);
}
}
/**
* Get the optional boolean value associated with an index.
* It returns false if there is no value at that index,
* or if the value is not Boolean.TRUE or the String "true".
*
* @param index The index must be between 0 and length() - 1.
* @return The truth.
*/
public boolean optBoolean(int index) {
return optBoolean(index, false);
}
/**
* Get the optional boolean value associated with an index.
* It returns the defaultValue if there is no value at that index or if it is not
* a Boolean or the String "true" or "false".
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue A boolean default.
* @return The truth.
*/
public boolean optBoolean(int index, boolean defaultValue) {
Object o = opt(index);
if (o != null) {
if (o == Boolean.FALSE || o.equals("false")) {
return false;
} else if (o == Boolean.TRUE || o.equals("true")) {
return true;
}
}
return defaultValue;
}
/**
* Get the optional double value associated with an index.
* NaN is returned if the index is not found,
* or if the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
*/
public double optDouble(int index) {
return optDouble(index, Double.NaN);
}
/**
* Get the optional double value associated with an index.
* The defaultValue is returned if the index is not found,
* or if the value is not a number and cannot be converted to a number.
*
* @param index subscript
* @param defaultValue The default value.
* @return The value.
*/
public double optDouble(int index, double defaultValue) {
Object o = opt(index);
if (o != null) {
if (o instanceof Number) {
return ((Number) o).doubleValue();
}
try {
return Double.parseDouble((String) o);
}
catch (Exception e) {
}
}
return defaultValue;
}
/**
* Get the optional int value associated with an index.
* Zero is returned if the index is not found,
* or if the value is not a number and cannot be converted to a number.
*
* @param index The index must be between 0 and length() - 1.
* @return The value.
*/
public int optInt(int index) {
return optInt(index, 0);
}
/**
* Get the optional int value associated with an index.
* The defaultValue is returned if the index is not found,
* or if the value is not a number and cannot be converted to a number.
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
* @return The value.
*/
public int optInt(int index, int defaultValue) {
Object o = opt(index);
if (o != null) {
if (o instanceof Number) {
return ((Number)o).intValue();
}
try {
return Integer.parseInt((String)o);
}
catch (Exception e) {
}
}
return defaultValue;
}
/**
* Get the optional JSONArray associated with an index.
* @param index subscript
* @return A JSONArray value, or null if the index has no value,
* or if the value is not a JSONArray.
*/
public JSONArray optJSONArray(int index) {
Object o = opt(index);
if (o instanceof JSONArray) {
return (JSONArray)o;
}
return null;
}
/**
* Get the optional JSONObject associated with an index.
* Null is returned if the key is not found, or null if the index has
* no value, or if the value is not a JSONObject.
*
* @param index The index must be between 0 and length() - 1.
* @return A JSONObject value.
*/
public JSONObject optJSONObject(int index) {
Object o = opt(index);
if (o instanceof JSONObject) {
return (JSONObject)o;
}
return null;
}
/**
* Get the optional string value associated with an index. It returns an
* empty string if there is no value at that index. If the value
* is not a string and is not null, then it is coverted to a string.
*
* @param index The index must be between 0 and length() - 1.
* @return A String value.
*/
public String optString(int index){
return optString(index, "");
}
/**
* Get the optional string associated with an index.
* The defaultValue is returned if the key is not found.
*
* @param index The index must be between 0 and length() - 1.
* @param defaultValue The default value.
* @return A String value.
*/
public String optString(int index, String defaultValue){
Object o = opt(index);
if (o != null) {
return o.toString();
}
return defaultValue;
}
/**
* Append a boolean value.
*
* @param value A boolean value.
* @return this.
*/
public JSONArray put(boolean value) {
put(new Boolean(value));
return this;
}
/**
* Append a double value.
*
* @param value A double value.
* @return this.
*/
public JSONArray put(double value) {
put(new Double(value));
return this;
}
/**
* Append an int value.
*
* @param value An int value.
* @return this.
*/
public JSONArray put(int value) {
put(new Integer(value));
return this;
}
/**
* Append an object value.
* @param value An object value. The value should be a
* Boolean, Double, Integer, JSONArray, JSObject, or String, or the
* JSONObject.NULL object.
* @return this.
*/
public JSONArray put(Object value) {
myArrayList.add(value);
return this;
}
/**
* Put or replace a boolean value in the JSONArray.
* @param index subscript The subscript. If the index is greater than the length of
* the JSONArray, then null elements will be added as necessary to pad
* it out.
* @param value A boolean value.
* @return this.
* @exception NoSuchElementException The index must not be negative.
*/
public JSONArray put(int index, boolean value) {
put(index, new Boolean(value));
return this;
}
/**
* Put or replace a double value.
* @param index subscript The subscript. If the index is greater than the length of
* the JSONArray, then null elements will be added as necessary to pad
* it out.
* @param value A double value.
* @return this.
* @exception NoSuchElementException The index must not be negative.
*/
public JSONArray put(int index, double value) {
put(index, new Double(value));
return this;
}
/**
* Put or replace an int value.
* @param index subscript The subscript. If the index is greater than the length of
* the JSONArray, then null elements will be added as necessary to pad
* it out.
* @param value An int value.
* @return this.
* @exception NoSuchElementException The index must not be negative.
*/
public JSONArray put(int index, int value) {
put(index, new Integer(value));
return this;
}
/**
* Put or replace an object value in the JSONArray.
* @param index The subscript. If the index is greater than the length of
* the JSONArray, then null elements will be added as necessary to pad
* it out.
* @param value An object value.
* @return this.
* @exception NoSuchElementException The index must not be negative.
* @exception NullPointerException The value must not be null
*/
public JSONArray put(int index, Object value)
throws NoSuchElementException, NullPointerException {
if (index < 0) {
throw new NoSuchElementException("JSONArray[" + index +
"] not found.");
} else if (value == null) {
throw new NullPointerException();
} else if (index < length()) {
myArrayList.set(index, value);
} else {
while (index != length()) {
put(null);
}
put(value);
}
return this;
}
/**
* Produce a JSONObject by combining a JSONArray of names with the values
* of this JSONArray.
* @param names A JSONArray containing a list of key strings. These will be
* paired with the values.
* @return A JSONObject, or null if there are no names or if this JSONArray
* has no values.
*/
public JSONObject toJSONObject(JSONArray names) {
if (names == null || names.length() == 0 || length() == 0) {
return null;
}
JSONObject jo = new JSONObject();
for (int i = 0; i < names.length(); i += 1) {
jo.put(names.getString(i), this.opt(i));
}
return jo;
}
/**
* Make an JSON external form string of this JSONArray. For compactness, no
* unnecessary whitespace is added.
* Warning: This method assumes that the data structure is acyclical.
*
* @return a printable, displayable, transmittable
* representation of the array.
*/
public String toString() {
return '[' + join(",") + ']';
}
/**
* Make a prettyprinted JSON string of this JSONArray.
* Warning: This method assumes that the data structure is non-cyclical.
* @param indentFactor The number of spaces to add to each level of
* indentation.
* @return a printable, displayable, transmittable
* representation of the object, beginning
* with <code>[</code> <small>(left bracket)</small> and ending
* with <code>]</code> <small>(right bracket)</small>.
*/
public String toString(int indentFactor) {
return toString(indentFactor, 0);
}
/**
* Make a prettyprinted string of this JSONArray.
* Warning: This method assumes that the data structure is non-cyclical.
* @param indentFactor The number of spaces to add to each level of
* indentation.
* @param indent The indention of the top level.
* @return a printable, displayable, transmittable
* representation of the array.
*/
String toString(int indentFactor, int indent) {
int i;
Object o;
String pad = "";
StringBuffer sb = new StringBuffer();
indent += indentFactor;
for (i = 0; i < indent; i += 1) {
pad += ' ';
}
sb.append("[\n");
for (i = 0; i < myArrayList.size(); i += 1) {
if (i > 0) {
sb.append(",\n");
}
sb.append(pad);
o = myArrayList.get(i);
if (o == null) {
sb.append("null");
} else if (o instanceof String) {
sb.append(JSONObject.quote((String) o));
} else if (o instanceof Number) {
sb.append(JSONObject.numberToString((Number) o));
} else if (o instanceof JSONObject) {
sb.append(((JSONObject)o).toString(indentFactor, indent));
} else if (o instanceof JSONArray) {
sb.append(((JSONArray)o).toString(indentFactor, indent));
} else {
sb.append(o.toString());
}
}
sb.append(']');
return sb.toString();
}
}