This repository was archived by the owner on Nov 7, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 70
Expand file tree
/
Copy pathJsonNumber.java
More file actions
210 lines (193 loc) · 7.75 KB
/
JsonNumber.java
File metadata and controls
210 lines (193 loc) · 7.75 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
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
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.json;
import java.math.BigDecimal;
import java.math.BigInteger;
/**
* An immutable JSON number value.
*
* <p>
* Implementations may use a {@link BigDecimal} object to store the numeric
* value internally.
* The {@code BigDecimal} object can be constructed from the following types:
* <code>int</code> {@link BigDecimal#BigDecimal(int)},
* <code>long</code> {@link BigDecimal#BigDecimal(long)},
* <code>BigInteger</code> {@link BigDecimal#BigDecimal(BigInteger)},
* <code>double</code> {@link BigDecimal#valueOf(double)}, and
* <code>String</code> {@link BigDecimal#BigDecimal(String)}.
* Some of the method semantics in this class are defined using the
* {@code BigDecimal} semantics.
*/
public interface JsonNumber extends JsonValue {
/**
* Returns true if this JSON number is a integral number. This method
* semantics are defined using {@code bigDecimalValue().scale()}. If the
* scale is zero, then it is considered integral type. This integral type
* information can be used to invoke an appropriate accessor method to
* obtain a numeric value as in the following example:
*
* <pre>
* <code>
* JsonNumber num = ...
* if (num.isIntegral()) {
* num.longValue(); // or other methods to get integral value
* } else {
* num.doubleValue(); // or other methods to get decimal number value
* }
* </code>
* </pre>
*
* @return true if this number is a integral number, otherwise false
*/
boolean isIntegral();
/**
* Returns this JSON number as an {@code int}. Note that this conversion
* can lose information about the overall magnitude and precision of the
* number value as well as return a result with the opposite sign.
*
* @return an {@code int} representation of the JSON number
* @see java.math.BigDecimal#intValue()
*/
int intValue();
/**
* Returns this JSON number as an {@code int}.
*
* @return an {@code int} representation of the JSON number
* @throws ArithmeticException if the number has a nonzero fractional
* part or if it does not fit in an {@code int}
* @see java.math.BigDecimal#intValueExact()
*/
int intValueExact();
/**
* Returns this JSON number as a {@code long}. Note that this conversion
* can lose information about the overall magnitude and precision of the
* number value as well as return a result with the opposite sign.
*
* @return a {@code long} representation of the JSON number.
* @see java.math.BigDecimal#longValue()
*/
long longValue();
/**
* Returns this JSON number as a {@code long}.
*
* @return a {@code long} representation of the JSON number
* @throws ArithmeticException if the number has a non-zero fractional
* part or if it does not fit in a {@code long}
* @see java.math.BigDecimal#longValueExact()
*/
long longValueExact();
/**
* Returns this JSON number as a {@link BigInteger} object. This is a
* a convenience method for {@code bigDecimalValue().toBigInteger()}.
* Note that this conversion can lose information about the overall
* magnitude and precision of the number value as well as return a result
* with the opposite sign.
*
* @return a {@code BigInteger} representation of the JSON number.
* @see java.math.BigDecimal#toBigInteger()
*/
BigInteger bigIntegerValue();
/**
* Returns this JSON number as a {@link BigInteger} object. This is a
* convenience method for {@code bigDecimalValue().toBigIntegerExact()}.
*
* @return a {@link BigInteger} representation of the JSON number
* @throws ArithmeticException if the number has a nonzero fractional part
* @see java.math.BigDecimal#toBigIntegerExact()
*/
BigInteger bigIntegerValueExact();
/**
* Returns this JSON number as a {@code double}. This is a
* a convenience method for {@code bigDecimalValue().doubleValue()}.
* Note that this conversion can lose information about the overall
* magnitude and precision of the number value as well as return a result
* with the opposite sign.
*
* @return a {@code double} representation of the JSON number
* @see java.math.BigDecimal#doubleValue()
*/
double doubleValue();
/**
* Returns this JSON number as a {@link BigDecimal} object.
*
* @return a {@link BigDecimal} representation of the JSON number
*/
BigDecimal bigDecimalValue();
/**
* Returns this JSON number as a {@link Number} object.
*
* @return a {@link Number} representation of the JSON number
*
* @since 1.1
*/
default Number numberValue() {
throw new UnsupportedOperationException();
}
/**
* Returns a JSON text representation of the JSON number. The
* representation is equivalent to {@link BigDecimal#toString()}.
*
* @return JSON text representation of the number
*/
@Override
String toString();
/**
* Compares the specified object with this {@code JsonNumber} object for
* equality. Returns {@code true} if and only if the type of the specified
* object is also {@code JsonNumber} and their {@link #bigDecimalValue()}
* objects are <i>equal</i>
*
* @param obj the object to be compared for equality with
* this {@code JsonNumber}
* @return {@code true} if the specified object is equal to this
* {@code JsonNumber}
*/
@Override
boolean equals(Object obj);
/**
* Returns the hash code value for this {@code JsonNumber} object. The
* hash code of a {@code JsonNumber} object is defined as the hash code of
* its {@link #bigDecimalValue()} object.
*
* @return the hash code value for this {@code JsonNumber} object
*/
@Override
int hashCode();
}