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 | package Torello.JSON;
import javax.json.*;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.function.Function;
import static javax.json.JsonValue.ValueType.*;
import static Torello.JSON.JFlag.*;
import static Torello.JSON.RJInternal.*;
/**
* Builds on the J2EE Standard Release JSON Parsing Tools by providing additional
* help with converting JSON Data into the Best-Fit
* <B STYLE='color: red'><CODE>java.lang.Number</CODE></B>
*
* <EMBED CLASS='external-html' DATA-FILE-ID=ALL_CLASSES_NOTE>
* <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUMBER_JSON>
*
* @see Json
* @see JsonObject
* @see JsonArray
*/
@Torello.JavaDoc.Annotations.StaticFunctional
public class ReadNumberJSON
{
// This is a static class. Has no program state.
private ReadNumberJSON() { }
// ********************************************************************************************
// ********************************************************************************************
// Number from JsonArray
// ********************************************************************************************
// ********************************************************************************************
/**
* Retrieve a {@link JsonArray} element, and transform it to a {@code java.lang.Number}.
* <EMBED CLASS=defs DATA-JTYPE=JsonNumber DATA-TYPE='java.lang.Number'>
* <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_NOTE>
*
* @param ja Any instance of {@link JsonArray}
* @param index A valid index into {@code 'ja'}
* @param throwOnNull Asks that an exception throw if Json-Null is encountered
* @return <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_RET_JA>
*
* @throws IndexOutOfBoundsException If {@code 'index'} is out of the bounds of {@code 'ja'}
* @throws JsonTypeArrException <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_JTAEX>
* @throws JsonNullArrException <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_JNAEX>
*
* @see JsonValue#getValueType()
* @see #convertToNumber(JsonNumber)
*/
public static Number get(final JsonArray ja, final int index, final boolean throwOnNull)
{
// This will throw an IndexOutOfBoundsException if the index is out of bounds.
JsonValue jv = ja.get(index);
switch (jv.getValueType())
{
case NULL:
// This is simple-stuff (not rocket-science). "Type Mapping" Code has to worry
// about what the meaning of "null" should be.
if (throwOnNull) throw new JsonNullArrException(ja, index, NUMBER, Number.class);
else return null;
case NUMBER: return convertToNumber((JsonNumber) jv);
// The JsonValue at the specified array-index does not contain a JsonString.
default: throw new JsonTypeArrException(ja, index, NUMBER, jv, Number.class);
}
}
/**
* Retrieve a {@link JsonArray} element, and transform it to a {@code java.lang.Number}.
* <EMBED CLASS=defs DATA-TYPE='java.lang.Number' DATA-JTYPE=JsonNumber>
* <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_NOTE>
*
* @param ja Any instance of {@link JsonArray}
* @param index The array index containing the element to retrieve.
* @param FLAGS Return-value / exception-throw constants defined in {@link JFlag}
* @param defaultValue <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_DEF_VAL>
* @return Best fit boxed number, or null.
*
* @throws IndexOutOfBoundsException <EMBED CLASS='external-html' DATA-FILE-ID=IOOBEX>
* @throws JsonNullArrException <EMBED CLASS='external-html' DATA-FILE-ID=JNAEX>
* @throws JsonTypeArrException <EMBED CLASS='external-html' DATA-FILE-ID=JTAEX>
*
* @see ReadBoxedJSON#GET(JsonArray, int, int, Number, Class, Function, Function)
* @see #convertToNumber(JsonNumber)
*/
public static Number get(
final JsonArray ja,
final int index,
final int FLAGS,
final Number defaultValue
)
{
return ReadBoxedJSON.GET
(ja, index, FLAGS, defaultValue, Number.class, ReadNumberJSON::convertToNumber, null);
}
/**
* Retrieve a {@link JsonArray} element containing a {@link JsonString}, and transform it to a
* {@code java.lang.Number}, with either a user-provided parser, or the standard java parser
*
* <EMBED CLASS=defs DATA-TYPE='java.lang.Number' DATA-JTYPE=JsonString
* DATA-PARSER='new BigDecimal'>
*
* <BR /><BR />If {@code 'parser'} is passed null, the default parser is used, which is just
* the {@code java.math.BigDecimal} constructor which accepts a {@code String}. What is done
* with the parsed {@code BigDecimal} instance is explained below.
*
* <BR /><BR /><EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_PARSE_DESC>
*
* @param ja Any instance of {@link JsonArray}
* @param index The array index containing the {@link JsonString} element to retrieve.
* @param FLAGS Return-value / exception-throw constants defined in {@link JFlag}
* @param defaultValue <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_DEF_VAL>
* @param optionalParser <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_PARSER>
* @return <EMBED CLASS='external-html' DATA-FILE-ID=PARSE_BOXED_RET_JA>
*
* @throws IndexOutOfBoundsException <EMBED CLASS='external-html' DATA-FILE-ID=IOOBEX>
* @throws JsonStrParseArrException <EMBED CLASS='external-html' DATA-FILE-ID=JSPAEX>
* @throws JsonNullArrException <EMBED CLASS='external-html' DATA-FILE-ID=JNAEX>
* @throws JsonTypeArrException <EMBED CLASS='external-html' DATA-FILE-ID=JTAEX>
*
* @see ParseBoxedJSON#PARSE(JsonObject, String, int, Number, Class, Function, Function, Function)
* @see #convertToNumber(String)
*/
public static Number parse(
final JsonArray ja,
final int index,
final int FLAGS,
final Number defaultValue,
final Function<String, Number> optionalParser
)
{
return ParseBoxedJSON.PARSE(
ja, index, FLAGS, defaultValue, Number.class, optionalParser,
ReadNumberJSON::convertToNumber, null /* Not Needed, convertToNumber won't throw */
);
}
// ********************************************************************************************
// ********************************************************************************************
// Number from JsonObject
// ********************************************************************************************
// ********************************************************************************************
/**
* Extract a {@link JsonObject} property, and transform it to a {@code java.lang.Number}.
* <EMBED CLASS=defs DATA-TYPE='java.lang.Number' DATA-JTYPE=JsonNumber>
* <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_NOTE>
*
* @param jo Any instance of {@link JsonObject}.
* @param propertyName Any property name contained by {@code 'jo'}
* @param isOptional <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_IS_OPTIONAL>
* @param throwOnNull <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_THROW_ON_JO>
* @return <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_RET_JO>
*
* @throws JsonPropMissingException <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_JPMEX>
* @throws JsonTypeObjException <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_JTOEX>
* @throws JsonNullObjException <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_JNOEX>
*
* @see JsonValue#getValueType()
* @see #convertToNumber(JsonNumber)
*/
public static Number get(
final JsonObject jo,
final String propertyName,
final boolean isOptional,
final boolean throwOnNull
)
{
if (! jo.containsKey(propertyName))
{
if (isOptional) return null;
else throw new JsonPropMissingException(jo, propertyName, NUMBER, Number.class);
}
JsonValue jv = jo.get(propertyName);
switch (jv.getValueType())
{
case NULL:
// This is simple-stuff (not rocket-science). "Type Mapping" Code has to worry
// about what the meaning of "null" should be.
if (throwOnNull) throw new JsonNullObjException
(jo, propertyName, NUMBER, Number.class);
else return null;
case NUMBER: return convertToNumber((JsonNumber) jv);
// The JsonObject propertydoes not contain a JsonNumber.
default: throw new JsonTypeObjException
(jo, propertyName, NUMBER, jv, Number.class);
}
}
/**
* Retrieve a {@link JsonObject} property, and transform it to a {@code java.lang.Number}.
* <EMBED CLASS=defs DATA-TYPE='java.lang.Number' DATA-JTYPE=JsonNumber>
* <EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_NOTE>
*
* @param jo Any instance of {@link JsonObject}
* @param propertyName Any property name contained by {@code 'jo'}
* @param FLAGS Return-value / exception-throw constants defined in {@link JFlag}
* @param defaultValue <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_DEF_VAL>
* @return Best fit boxed number, or null.
*
* @throws JsonPropMissingException <EMBED CLASS='external-html' DATA-FILE-ID=JPMEX>
* @throws JsonNullObjException <EMBED CLASS='external-html' DATA-FILE-ID=JNOEX>
* @throws JsonTypeObjException <EMBED CLASS='external-html' DATA-FILE-ID=JTOEX>
*
* @see ReadBoxedJSON#GET(JsonObject, String, int, Number, Class, Function, Function)
* @see #convertToNumber(JsonNumber)
*/
public static Number get(
final JsonObject jo,
final String propertyName,
final int FLAGS,
final Number defaultValue
)
{
return ReadBoxedJSON.GET(
jo, propertyName, FLAGS, defaultValue, Number.class,
ReadNumberJSON::convertToNumber,
null
);
}
/**
* Retrieve a {@link JsonObject} property containing a {@link JsonString}, and transform it to
* a {@code java.lang.Number}, with either a user-provided parser, or the standard java
* parser
*
* <EMBED CLASS=defs DATA-TYPE='java.lang.Number' DATA-JTYPE=JsonString
* DATA-PARSER='new BigDecimal'>
*
* <BR /><BR />If {@code 'parser'} is passed null, the default parser is used, which is just
* the {@code java.math.BigDecimal} constructor which accepts a {@code String}. What is done
* with the parsed {@code BigDecimal} instance is explained below.
*
* <BR /><BR /><EMBED CLASS='external-html' DATA-FILE-ID=READ_NUM_PARSE_DESC>
*
* @param jo Any instance of {@link JsonObject}
* @param propertyName Any property name contained by {@code 'jo'}
* @param FLAGS Return-value / exception-throw constants defined in {@link JFlag}
* @param defaultValue <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_DEF_VAL>
* @param optionalParser <EMBED CLASS='external-html' DATA-FILE-ID=COMMON_PARSER>
* @return <EMBED CLASS='external-html' DATA-FILE-ID=PARSE_BOXED_RET_JO>
*
* @throws JsonPropMissingException <EMBED CLASS='external-html' DATA-FILE-ID=JPMEX>
* @throws JsonStrParseObjException <EMBED CLASS='external-html' DATA-FILE-ID=JSPOEX>
* @throws JsonNullObjException <EMBED CLASS='external-html' DATA-FILE-ID=JNOEX>
* @throws JsonTypeObjException <EMBED CLASS='external-html' DATA-FILE-ID=JTOEX>
*
* @see ParseBoxedJSON#PARSE(JsonObject, String, int, Number, Class, Function, Function, Function)
* @see #convertToNumber(String)
*/
public static Number parse(
final JsonObject jo,
final String propertyName,
final int FLAGS,
final Number defaultValue,
final Function<String, Number> optionalParser
)
{
return ParseBoxedJSON.PARSE(
jo, propertyName, FLAGS, defaultValue, Number.class, optionalParser,
ReadNumberJSON::convertToNumber,
null /* Not Needed, convertToNumber won't throw */
);
}
// ********************************************************************************************
// ********************************************************************************************
// Number from JsonString Parse **OR** from JsonNumber
// ********************************************************************************************
// ********************************************************************************************
/**
* <EMBED CLASS=defs DATA-TYPE=Number DATA-PARSER='new BigDecimal'>
* <EMBED CLASS='external-html' DATA-FILE-ID=RORP_BOXED_WF_JA>
*
* @param ja Any {@link JsonArray}
* @param i Any index into the {@code JsonArray}
* @param FLAGS Return-value / exception-throw constants defined in {@link JFlag}
* @param defaultValue <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_DEFVAL>
* @param optionalParser <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_PARSER>
* @return <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_RET_JA>
*
* @throws IndexOutOfBoundsException <EMBED CLASS='external-html' DATA-FILE-ID=IOOBEX>
* @throws JsonStrParseArrException <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_JSPAEX>
* @throws JsonNullArrException <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_JNAEX>
* @throws JsonTypeArrException <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_JTAEX>
*
* @see #get(JsonArray, int, int, Number)
* @see #parse(JsonArray, int, int, Number, Function)
*/
public static Number get(
final JsonArray ja,
final int i,
final int FLAGS,
final Number defaultValue,
Function<String, Number> optionalParser
)
{
JsonValue.ValueType t;
return ((i >= ja.size()) || ((t=ja.get(i).getValueType()) == NUMBER) || (t != STRING))
? get(ja, i, FLAGS, defaultValue)
: parse(ja, i, FLAGS, defaultValue, optionalParser);
}
/**
* <EMBED CLASS=defs DATA-TYPE=Number DATA-PARSER='new BigDecimal'>
* <EMBED CLASS='external-html' DATA-FILE-ID=RORP_BOXED_WF_JO>
*
* @param jo Any {@link JsonObject}
* @param propertyName Any of the properties defined in the {@code JsonObject}
* @param FLAGS Return-value / exception-throw constants defined in {@link JFlag}
* @param defaultValue <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_DEFVAL>
* @param optionalParser <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_PARSER>
* @return <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_RET_JO>
*
* @throws JsonPropMissingException <EMBED CLASS='external-html' DATA-FILE-ID=JPMEX>
* @throws JsonStrParseObjException <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_JSPOEX>
* @throws JsonNullObjException <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_JNOEX>
* @throws JsonTypeObjException <EMBED CLASS='external-html' DATA-FILE-ID=ROPB_JTOEX>
*
* @see #get(JsonObject, String, int, Number)
* @see #parse(JsonObject, String, int, Number, Function)
*/
public static Number get(
final JsonObject jo,
final String propertyName,
final int FLAGS,
final Number defaultValue,
final Function<String, Number> optionalParser
)
{
JsonValue.ValueType t;
return ( (! jo.containsKey(propertyName))
|| ((t = jo.get(propertyName).getValueType()) == NUMBER)
|| (t != STRING)
)
? get(jo, propertyName, FLAGS, defaultValue)
: parse(jo, propertyName, FLAGS, defaultValue, optionalParser);
}
// ********************************************************************************************
// ********************************************************************************************
// Internal Use Only Helpers
// ********************************************************************************************
// ********************************************************************************************
/**
* Converts any {@link JsonNumber} into one of the inheriting subclasses of Java class
* {@code Number}
* @param jn Any {@link JsonNumber}
* @return The most appropriate intance of {@code java.lang.Number}
* @see #get(JsonObject, String, int, Number)
* @see ]#get(JsonArray, int, int, Number)
* @see JsonNumber#isIntegral()
* @see JsonNumber#bigIntegerValue()
* @see JsonNumber#bigDecimalValue()
*/
protected static Number convertToNumber(final JsonNumber jn)
{
if (jn.isIntegral())
{
BigInteger bi = jn.bigIntegerValue();
int l = bi.bitLength();
if (l <= 32) return Integer.valueOf(bi.intValue());
if (l <= 64) return Long.valueOf(bi.longValue());
return bi;
}
else
{
BigDecimal bd = jn.bigDecimalValue();
// This probably isn't the most efficient thing I've ever written, but I do not
// have the energy to stare at java.math.BigDecimal at the moment. The JavaDoc for
// this JSON => Java-Type Conversion is quite intricate. I will figure this out at
// at later date.
float f = bd.floatValue();
if ( (! Float.isInfinite(f))
&& (BigDecimal.valueOf(f).compareTo(bd) == 0)
)
return (Float) f;
double d = bd.doubleValue();
if ( (! Double.isInfinite(d))
&& (BigDecimal.valueOf(d).compareTo(bd) == 0)
)
return (Double) d;
return bd;
}
}
/**
* Converts any {@code java.lang.String} into one of the inheriting subclasses of Java class
* {@code Number}
* @param s Any {@code String}
* @return The most appropriate instance of {@code java.lang.Number}
* @throws NumberFormatException If the input {@code String} isn't properly formatted as a
* number.
* @see ReadNumberJSON#parse(JsonObject, String, int, Number, Function)
* @see ReadNumberJSON#parse(JsonArray, int, int, Number, Function)
*/
protected static Number convertToNumber(final String s)
{ return convertToNumber(new BigDecimal(s.trim())); }
/**
* Converts any {@code java.math.BigDecimal} into one of the inheriting subclasses of
* {@code Number}.
* @param bd Any {@code BigDecimal}
* @return The most appropriate instance of {@code java.lang.Number}
*/
protected static Number convertToNumber(final BigDecimal bd)
{
if (bd.scale() == 0)
{
BigInteger bi = bd.toBigInteger();
int l = bi.bitLength();
if (l <= 32) return Integer.valueOf(bi.intValue());
if (l <= 64) return Long.valueOf(bi.longValue());
return bi;
}
else
{
// This probably isn't the most efficient thing I've ever written, but I do not
// have the energy to stare at java.math.BigDecimal at the moment. The JavaDoc for
// this JSON => Java-Type Conversion is quite intricate. I will figure this out at
// at later date.
float f = bd.floatValue();
if ( (! Float.isInfinite(f))
&& (BigDecimal.valueOf(f).compareTo(bd) == 0)
)
return (Float) f;
double d = bd.doubleValue();
if ( (! Double.isInfinite(d))
&& (BigDecimal.valueOf(d).compareTo(bd) == 0)
)
return (Double) d;
return bd;
}
}
}
|