/
JsonArray.java
312 lines (275 loc) · 11.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
/*
* Copyright (c) 2012, FOSS Nova Software foundation (FNSF),
* and individual contributors as indicated by the @author tags.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.fossnova.json;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.List;
import org.fossnova.json.stream.JsonException;
import org.fossnova.json.stream.JsonWriter;
/**
* JSON array.
* @author <a href="mailto:opalka dot richard at gmail dot com">Richard Opalka</a>
* @see JsonValue
* @see JsonValueFactory
*/
public interface JsonArray extends JsonValue, List< JsonValue > {
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#add(Object)} method.
* @param value string to wrap
* @return <tt>true</tt> if this JSON array contained the specified JSON string
*/
boolean add( final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#add(Object)} method.
* @param value number to wrap
* @return <tt>true</tt> if this JSON array contained the specified JSON number
*/
boolean add( final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#add(Object)} method.
* @param value boolean to wrap
* @return <tt>true</tt> if this JSON array contained the specified JSON boolean
*/
boolean add( final Boolean value );
/**
* Delegates the call to {@link java.util.List#add(Object)} method.
* @param value JSON value
* @return <tt>true</tt> if this JSON array contained the specified JSON value
*/
boolean add( final JsonValue value );
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#add(int, Object)} method.
* @param index index at which the specified JSON string is to be inserted
* @param value string to wrap
*/
void add( final int index, final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#add(int, Object)} method.
* @param index index at which the specified JSON number is to be inserted
* @param value number to wrap
*/
void add( final int index, final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#add(int, Object)} method.
* @param index index at which the specified JSON boolean is to be inserted
* @param value boolean to wrap
*/
void add( final int index, final Boolean value );
/**
* Delegates the call to {@link java.util.List#add(int, Object)} method.
* @param index index at which the specified JSON value is to be inserted
* @param value JSON value
*/
void add( final int index, final JsonValue value );
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#contains(Object)} method.
* @param value string to wrap
* @return <tt>true</tt> if this JSON array contains the specified JSON string
*/
boolean contains( final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#contains(Object)} method.
* @param value number to wrap
* @return <tt>true</tt> if this JSON array contains the specified JSON number
*/
boolean contains( final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#contains(Object)} method.
* @param value boolean to wrap
* @return <tt>true</tt> if this JSON array contains the specified JSON boolean
*/
boolean contains( final Boolean value );
/**
* Delegates the call to {@link java.util.List#contains(Object)} method.
* @param value JSON value
* @return <tt>true</tt> if this JSON array contains the specified JSON value
*/
boolean contains( final JsonValue value );
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#indexOf(Object)} method.
* @param value string to wrap
* @return the index of the first occurrence of the specified JSON string in
* this JSON array, or -1 if this JSON array does not contain the JSON string
*/
int indexOf( final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#indexOf(Object)} method.
* @param value number to wrap
* @return the index of the first occurrence of the specified JSON number in
* this JSON array, or -1 if this JSON array does not contain the JSON number
*/
int indexOf( final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#indexOf(Object)} method.
* @param value boolean to wrap
* @return the index of the first occurrence of the specified JSON boolean in
* this JSON array, or -1 if this JSON array does not contain the JSON boolean
*/
int indexOf( final Boolean value );
/**
* Delegates the call to {@link java.util.List#indexOf(Object)} method.
* @param value JSON value
* @return the index of the first occurrence of the specified JSON value in
* this JSON array, or -1 if this JSON array does not contain the JSON value
*/
int indexOf( final JsonValue value );
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#lastIndexOf(Object)} method.
* @param value string to wrap
* @return he index of the last occurrence of the specified JSON string in
* this JSON array, or -1 if this JSON array does not contain the JSON string
*/
int lastIndexOf( final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#lastIndexOf(Object)} method.
* @param value string to wrap
* @return he index of the last occurrence of the specified JSON number in
* this JSON array, or -1 if this JSON array does not contain the JSON number
*/
int lastIndexOf( final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#lastIndexOf(Object)} method.
* @param value string to wrap
* @return he index of the last occurrence of the specified JSON boolean in
* this JSON array, or -1 if this JSON array does not contain the JSON boolean
*/
int lastIndexOf( final Boolean value );
/**
* Delegates the call to {@link java.util.List#lastIndexOf(Object)} method.
* @param value JSON value
* @return he index of the last occurrence of the specified JSON value in
* this JSON array, or -1 if this JSON array does not contain the JSON value
*/
int lastIndexOf( final JsonValue value );
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#remove(Object)} method.
* @param value string to wrap
* @return <tt>true</tt> if this JSON array contained the specified JSON string
*/
boolean remove( final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#remove(Object)} method.
* @param value number to wrap
* @return <tt>true</tt> if this JSON array contained the specified JSON number
*/
boolean remove( final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#remove(Object)} method.
* @param value boolean to wrap
* @return <tt>true</tt> if this JSON array contained the specified JSON boolean
*/
boolean remove( final Boolean value );
/**
* Delegates the call to {@link java.util.List#remove(Object)} method.
* @param value JSON value
* @return <tt>true</tt> if this JSON array contained the specified JSON value
*/
boolean remove( final JsonValue value );
/**
* Wraps passed value with JsonString and delegates the call to
* {@link java.util.List#set(int, Object)} method.
* @param index index of the JSON value to replace
* @param value string to wrap
* @return the JSON value previously held at the specified position
*/
JsonValue set( final int index, final String value );
/**
* Wraps passed value with JsonNumber and delegates the call to
* {@link java.util.List#set(int, Object)} method.
* @param index index of the JSON value to replace
* @param value number to wrap
* @return the JSON value previously held at the specified position
*/
JsonValue set( final int index, final Number value );
/**
* Wraps passed value with JsonBoolean and delegates the call to
* {@link java.util.List#set(int, Object)} method.
* @param index index of the JSON value to replace
* @param value boolean to wrap
* @return the JSON value previously held at the specified position
*/
JsonValue set( final int index, final Boolean value );
/**
* Delegates the call to {@link java.util.List#set(int, Object)} method.
* @param index index of the JSON value to replace
* @param value JSON value
* @return the JSON value previously held at the specified position
*/
JsonValue set( final int index, final JsonValue value );
/**
* Translates this JSON array to Java array.
* @return java array
*/
JsonValue[] toArray();
/**
* Serializes this JSON array to the writer.
* @param output to write to
* @throws IOException if some I/O error occurs
* @throws JsonException if wrong JSON is detected
*/
void writeTo( JsonWriter output ) throws IOException, JsonException;
/**
* Serializes this JSON array to the writer.
* @param output to write to
* @throws IOException if some I/O error occurs
* @throws JsonException if wrong JSON is detected
*/
void writeTo( Writer output ) throws IOException, JsonException;
/**
* Serializes this JSON array to the stream using default character set.
* @param output to write to
* @throws IOException if some I/O error occurs
* @throws JsonException if wrong JSON is detected
*/
void writeTo( OutputStream output ) throws IOException, JsonException;
/**
* Serializes this JSON array to the writer using specified character set.
* @param output to write to
* @param charset character set
* @throws IOException if some I/O error occurs
* @throws JsonException if wrong JSON is detected
*/
void writeTo( OutputStream output, Charset charset ) throws IOException, JsonException;
/**
* Clones this JSON array.
* @return new JSON array clone.
*/
JsonArray clone();
}