jaroslav@1258
|
1 |
/*
|
jaroslav@1258
|
2 |
* Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
|
jaroslav@1258
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
jaroslav@1258
|
4 |
*
|
jaroslav@1258
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
jaroslav@1258
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
jaroslav@1258
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
jaroslav@1258
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
jaroslav@1258
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
jaroslav@1258
|
10 |
*
|
jaroslav@1258
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
jaroslav@1258
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
jaroslav@1258
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
jaroslav@1258
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
jaroslav@1258
|
15 |
* accompanied this code).
|
jaroslav@1258
|
16 |
*
|
jaroslav@1258
|
17 |
* You should have received a copy of the GNU General Public License version
|
jaroslav@1258
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
jaroslav@1258
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
jaroslav@1258
|
20 |
*
|
jaroslav@1258
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
jaroslav@1258
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
jaroslav@1258
|
23 |
* questions.
|
jaroslav@1258
|
24 |
*/
|
jaroslav@1258
|
25 |
|
jaroslav@1258
|
26 |
/*
|
jaroslav@1258
|
27 |
* Portions Copyright IBM Corporation, 2001. All Rights Reserved.
|
jaroslav@1258
|
28 |
*/
|
jaroslav@1258
|
29 |
package java.math;
|
jaroslav@1258
|
30 |
|
jaroslav@1258
|
31 |
/**
|
jaroslav@1258
|
32 |
* Specifies a <i>rounding behavior</i> for numerical operations
|
jaroslav@1258
|
33 |
* capable of discarding precision. Each rounding mode indicates how
|
jaroslav@1258
|
34 |
* the least significant returned digit of a rounded result is to be
|
jaroslav@1258
|
35 |
* calculated. If fewer digits are returned than the digits needed to
|
jaroslav@1258
|
36 |
* represent the exact numerical result, the discarded digits will be
|
jaroslav@1258
|
37 |
* referred to as the <i>discarded fraction</i> regardless the digits'
|
jaroslav@1258
|
38 |
* contribution to the value of the number. In other words,
|
jaroslav@1258
|
39 |
* considered as a numerical value, the discarded fraction could have
|
jaroslav@1258
|
40 |
* an absolute value greater than one.
|
jaroslav@1258
|
41 |
*
|
jaroslav@1258
|
42 |
* <p>Each rounding mode description includes a table listing how
|
jaroslav@1258
|
43 |
* different two-digit decimal values would round to a one digit
|
jaroslav@1258
|
44 |
* decimal value under the rounding mode in question. The result
|
jaroslav@1258
|
45 |
* column in the tables could be gotten by creating a
|
jaroslav@1258
|
46 |
* {@code BigDecimal} number with the specified value, forming a
|
jaroslav@1258
|
47 |
* {@link MathContext} object with the proper settings
|
jaroslav@1258
|
48 |
* ({@code precision} set to {@code 1}, and the
|
jaroslav@1258
|
49 |
* {@code roundingMode} set to the rounding mode in question), and
|
jaroslav@1258
|
50 |
* calling {@link BigDecimal#round round} on this number with the
|
jaroslav@1258
|
51 |
* proper {@code MathContext}. A summary table showing the results
|
jaroslav@1258
|
52 |
* of these rounding operations for all rounding modes appears below.
|
jaroslav@1258
|
53 |
*
|
jaroslav@1258
|
54 |
*<p>
|
jaroslav@1258
|
55 |
*<table border>
|
jaroslav@1258
|
56 |
* <caption><b>Summary of Rounding Operations Under Different Rounding Modes</b></caption>
|
jaroslav@1258
|
57 |
* <tr><th></th><th colspan=8>Result of rounding input to one digit with the given
|
jaroslav@1258
|
58 |
* rounding mode</th>
|
jaroslav@1258
|
59 |
* <tr valign=top>
|
jaroslav@1258
|
60 |
* <th>Input Number</th> <th>{@code UP}</th>
|
jaroslav@1258
|
61 |
* <th>{@code DOWN}</th>
|
jaroslav@1258
|
62 |
* <th>{@code CEILING}</th>
|
jaroslav@1258
|
63 |
* <th>{@code FLOOR}</th>
|
jaroslav@1258
|
64 |
* <th>{@code HALF_UP}</th>
|
jaroslav@1258
|
65 |
* <th>{@code HALF_DOWN}</th>
|
jaroslav@1258
|
66 |
* <th>{@code HALF_EVEN}</th>
|
jaroslav@1258
|
67 |
* <th>{@code UNNECESSARY}</th>
|
jaroslav@1258
|
68 |
*
|
jaroslav@1258
|
69 |
* <tr align=right><td>5.5</td> <td>6</td> <td>5</td> <td>6</td> <td>5</td> <td>6</td> <td>5</td> <td>6</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
70 |
* <tr align=right><td>2.5</td> <td>3</td> <td>2</td> <td>3</td> <td>2</td> <td>3</td> <td>2</td> <td>2</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
71 |
* <tr align=right><td>1.6</td> <td>2</td> <td>1</td> <td>2</td> <td>1</td> <td>2</td> <td>2</td> <td>2</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
72 |
* <tr align=right><td>1.1</td> <td>2</td> <td>1</td> <td>2</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
73 |
* <tr align=right><td>1.0</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td> <td>1</td>
|
jaroslav@1258
|
74 |
* <tr align=right><td>-1.0</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>-1</td>
|
jaroslav@1258
|
75 |
* <tr align=right><td>-1.1</td> <td>-2</td> <td>-1</td> <td>-1</td> <td>-2</td> <td>-1</td> <td>-1</td> <td>-1</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
76 |
* <tr align=right><td>-1.6</td> <td>-2</td> <td>-1</td> <td>-1</td> <td>-2</td> <td>-2</td> <td>-2</td> <td>-2</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
77 |
* <tr align=right><td>-2.5</td> <td>-3</td> <td>-2</td> <td>-2</td> <td>-3</td> <td>-3</td> <td>-2</td> <td>-2</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
78 |
* <tr align=right><td>-5.5</td> <td>-6</td> <td>-5</td> <td>-5</td> <td>-6</td> <td>-6</td> <td>-5</td> <td>-6</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
79 |
*</table>
|
jaroslav@1258
|
80 |
*
|
jaroslav@1258
|
81 |
*
|
jaroslav@1258
|
82 |
* <p>This {@code enum} is intended to replace the integer-based
|
jaroslav@1258
|
83 |
* enumeration of rounding mode constants in {@link BigDecimal}
|
jaroslav@1258
|
84 |
* ({@link BigDecimal#ROUND_UP}, {@link BigDecimal#ROUND_DOWN},
|
jaroslav@1258
|
85 |
* etc. ).
|
jaroslav@1258
|
86 |
*
|
jaroslav@1258
|
87 |
* @see BigDecimal
|
jaroslav@1258
|
88 |
* @see MathContext
|
jaroslav@1258
|
89 |
* @author Josh Bloch
|
jaroslav@1258
|
90 |
* @author Mike Cowlishaw
|
jaroslav@1258
|
91 |
* @author Joseph D. Darcy
|
jaroslav@1258
|
92 |
* @since 1.5
|
jaroslav@1258
|
93 |
*/
|
jaroslav@1258
|
94 |
public enum RoundingMode {
|
jaroslav@1258
|
95 |
|
jaroslav@1258
|
96 |
/**
|
jaroslav@1258
|
97 |
* Rounding mode to round away from zero. Always increments the
|
jaroslav@1258
|
98 |
* digit prior to a non-zero discarded fraction. Note that this
|
jaroslav@1258
|
99 |
* rounding mode never decreases the magnitude of the calculated
|
jaroslav@1258
|
100 |
* value.
|
jaroslav@1258
|
101 |
*
|
jaroslav@1258
|
102 |
*<p>Example:
|
jaroslav@1258
|
103 |
*<table border>
|
jaroslav@1258
|
104 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
105 |
* <th>Input rounded to one digit<br> with {@code UP} rounding
|
jaroslav@1258
|
106 |
*<tr align=right><td>5.5</td> <td>6</td>
|
jaroslav@1258
|
107 |
*<tr align=right><td>2.5</td> <td>3</td>
|
jaroslav@1258
|
108 |
*<tr align=right><td>1.6</td> <td>2</td>
|
jaroslav@1258
|
109 |
*<tr align=right><td>1.1</td> <td>2</td>
|
jaroslav@1258
|
110 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
111 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
112 |
*<tr align=right><td>-1.1</td> <td>-2</td>
|
jaroslav@1258
|
113 |
*<tr align=right><td>-1.6</td> <td>-2</td>
|
jaroslav@1258
|
114 |
*<tr align=right><td>-2.5</td> <td>-3</td>
|
jaroslav@1258
|
115 |
*<tr align=right><td>-5.5</td> <td>-6</td>
|
jaroslav@1258
|
116 |
*</table>
|
jaroslav@1258
|
117 |
*/
|
jaroslav@1258
|
118 |
UP(BigDecimal.ROUND_UP),
|
jaroslav@1258
|
119 |
|
jaroslav@1258
|
120 |
/**
|
jaroslav@1258
|
121 |
* Rounding mode to round towards zero. Never increments the digit
|
jaroslav@1258
|
122 |
* prior to a discarded fraction (i.e., truncates). Note that this
|
jaroslav@1258
|
123 |
* rounding mode never increases the magnitude of the calculated value.
|
jaroslav@1258
|
124 |
*
|
jaroslav@1258
|
125 |
*<p>Example:
|
jaroslav@1258
|
126 |
*<table border>
|
jaroslav@1258
|
127 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
128 |
* <th>Input rounded to one digit<br> with {@code DOWN} rounding
|
jaroslav@1258
|
129 |
*<tr align=right><td>5.5</td> <td>5</td>
|
jaroslav@1258
|
130 |
*<tr align=right><td>2.5</td> <td>2</td>
|
jaroslav@1258
|
131 |
*<tr align=right><td>1.6</td> <td>1</td>
|
jaroslav@1258
|
132 |
*<tr align=right><td>1.1</td> <td>1</td>
|
jaroslav@1258
|
133 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
134 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
135 |
*<tr align=right><td>-1.1</td> <td>-1</td>
|
jaroslav@1258
|
136 |
*<tr align=right><td>-1.6</td> <td>-1</td>
|
jaroslav@1258
|
137 |
*<tr align=right><td>-2.5</td> <td>-2</td>
|
jaroslav@1258
|
138 |
*<tr align=right><td>-5.5</td> <td>-5</td>
|
jaroslav@1258
|
139 |
*</table>
|
jaroslav@1258
|
140 |
*/
|
jaroslav@1258
|
141 |
DOWN(BigDecimal.ROUND_DOWN),
|
jaroslav@1258
|
142 |
|
jaroslav@1258
|
143 |
/**
|
jaroslav@1258
|
144 |
* Rounding mode to round towards positive infinity. If the
|
jaroslav@1258
|
145 |
* result is positive, behaves as for {@code RoundingMode.UP};
|
jaroslav@1258
|
146 |
* if negative, behaves as for {@code RoundingMode.DOWN}. Note
|
jaroslav@1258
|
147 |
* that this rounding mode never decreases the calculated value.
|
jaroslav@1258
|
148 |
*
|
jaroslav@1258
|
149 |
*<p>Example:
|
jaroslav@1258
|
150 |
*<table border>
|
jaroslav@1258
|
151 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
152 |
* <th>Input rounded to one digit<br> with {@code CEILING} rounding
|
jaroslav@1258
|
153 |
*<tr align=right><td>5.5</td> <td>6</td>
|
jaroslav@1258
|
154 |
*<tr align=right><td>2.5</td> <td>3</td>
|
jaroslav@1258
|
155 |
*<tr align=right><td>1.6</td> <td>2</td>
|
jaroslav@1258
|
156 |
*<tr align=right><td>1.1</td> <td>2</td>
|
jaroslav@1258
|
157 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
158 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
159 |
*<tr align=right><td>-1.1</td> <td>-1</td>
|
jaroslav@1258
|
160 |
*<tr align=right><td>-1.6</td> <td>-1</td>
|
jaroslav@1258
|
161 |
*<tr align=right><td>-2.5</td> <td>-2</td>
|
jaroslav@1258
|
162 |
*<tr align=right><td>-5.5</td> <td>-5</td>
|
jaroslav@1258
|
163 |
*</table>
|
jaroslav@1258
|
164 |
*/
|
jaroslav@1258
|
165 |
CEILING(BigDecimal.ROUND_CEILING),
|
jaroslav@1258
|
166 |
|
jaroslav@1258
|
167 |
/**
|
jaroslav@1258
|
168 |
* Rounding mode to round towards negative infinity. If the
|
jaroslav@1258
|
169 |
* result is positive, behave as for {@code RoundingMode.DOWN};
|
jaroslav@1258
|
170 |
* if negative, behave as for {@code RoundingMode.UP}. Note that
|
jaroslav@1258
|
171 |
* this rounding mode never increases the calculated value.
|
jaroslav@1258
|
172 |
*
|
jaroslav@1258
|
173 |
*<p>Example:
|
jaroslav@1258
|
174 |
*<table border>
|
jaroslav@1258
|
175 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
176 |
* <th>Input rounded to one digit<br> with {@code FLOOR} rounding
|
jaroslav@1258
|
177 |
*<tr align=right><td>5.5</td> <td>5</td>
|
jaroslav@1258
|
178 |
*<tr align=right><td>2.5</td> <td>2</td>
|
jaroslav@1258
|
179 |
*<tr align=right><td>1.6</td> <td>1</td>
|
jaroslav@1258
|
180 |
*<tr align=right><td>1.1</td> <td>1</td>
|
jaroslav@1258
|
181 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
182 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
183 |
*<tr align=right><td>-1.1</td> <td>-2</td>
|
jaroslav@1258
|
184 |
*<tr align=right><td>-1.6</td> <td>-2</td>
|
jaroslav@1258
|
185 |
*<tr align=right><td>-2.5</td> <td>-3</td>
|
jaroslav@1258
|
186 |
*<tr align=right><td>-5.5</td> <td>-6</td>
|
jaroslav@1258
|
187 |
*</table>
|
jaroslav@1258
|
188 |
*/
|
jaroslav@1258
|
189 |
FLOOR(BigDecimal.ROUND_FLOOR),
|
jaroslav@1258
|
190 |
|
jaroslav@1258
|
191 |
/**
|
jaroslav@1258
|
192 |
* Rounding mode to round towards {@literal "nearest neighbor"}
|
jaroslav@1258
|
193 |
* unless both neighbors are equidistant, in which case round up.
|
jaroslav@1258
|
194 |
* Behaves as for {@code RoundingMode.UP} if the discarded
|
jaroslav@1258
|
195 |
* fraction is ≥ 0.5; otherwise, behaves as for
|
jaroslav@1258
|
196 |
* {@code RoundingMode.DOWN}. Note that this is the rounding
|
jaroslav@1258
|
197 |
* mode commonly taught at school.
|
jaroslav@1258
|
198 |
*
|
jaroslav@1258
|
199 |
*<p>Example:
|
jaroslav@1258
|
200 |
*<table border>
|
jaroslav@1258
|
201 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
202 |
* <th>Input rounded to one digit<br> with {@code HALF_UP} rounding
|
jaroslav@1258
|
203 |
*<tr align=right><td>5.5</td> <td>6</td>
|
jaroslav@1258
|
204 |
*<tr align=right><td>2.5</td> <td>3</td>
|
jaroslav@1258
|
205 |
*<tr align=right><td>1.6</td> <td>2</td>
|
jaroslav@1258
|
206 |
*<tr align=right><td>1.1</td> <td>1</td>
|
jaroslav@1258
|
207 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
208 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
209 |
*<tr align=right><td>-1.1</td> <td>-1</td>
|
jaroslav@1258
|
210 |
*<tr align=right><td>-1.6</td> <td>-2</td>
|
jaroslav@1258
|
211 |
*<tr align=right><td>-2.5</td> <td>-3</td>
|
jaroslav@1258
|
212 |
*<tr align=right><td>-5.5</td> <td>-6</td>
|
jaroslav@1258
|
213 |
*</table>
|
jaroslav@1258
|
214 |
*/
|
jaroslav@1258
|
215 |
HALF_UP(BigDecimal.ROUND_HALF_UP),
|
jaroslav@1258
|
216 |
|
jaroslav@1258
|
217 |
/**
|
jaroslav@1258
|
218 |
* Rounding mode to round towards {@literal "nearest neighbor"}
|
jaroslav@1258
|
219 |
* unless both neighbors are equidistant, in which case round
|
jaroslav@1258
|
220 |
* down. Behaves as for {@code RoundingMode.UP} if the discarded
|
jaroslav@1258
|
221 |
* fraction is > 0.5; otherwise, behaves as for
|
jaroslav@1258
|
222 |
* {@code RoundingMode.DOWN}.
|
jaroslav@1258
|
223 |
*
|
jaroslav@1258
|
224 |
*<p>Example:
|
jaroslav@1258
|
225 |
*<table border>
|
jaroslav@1258
|
226 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
227 |
* <th>Input rounded to one digit<br> with {@code HALF_DOWN} rounding
|
jaroslav@1258
|
228 |
*<tr align=right><td>5.5</td> <td>5</td>
|
jaroslav@1258
|
229 |
*<tr align=right><td>2.5</td> <td>2</td>
|
jaroslav@1258
|
230 |
*<tr align=right><td>1.6</td> <td>2</td>
|
jaroslav@1258
|
231 |
*<tr align=right><td>1.1</td> <td>1</td>
|
jaroslav@1258
|
232 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
233 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
234 |
*<tr align=right><td>-1.1</td> <td>-1</td>
|
jaroslav@1258
|
235 |
*<tr align=right><td>-1.6</td> <td>-2</td>
|
jaroslav@1258
|
236 |
*<tr align=right><td>-2.5</td> <td>-2</td>
|
jaroslav@1258
|
237 |
*<tr align=right><td>-5.5</td> <td>-5</td>
|
jaroslav@1258
|
238 |
*</table>
|
jaroslav@1258
|
239 |
*/
|
jaroslav@1258
|
240 |
HALF_DOWN(BigDecimal.ROUND_HALF_DOWN),
|
jaroslav@1258
|
241 |
|
jaroslav@1258
|
242 |
/**
|
jaroslav@1258
|
243 |
* Rounding mode to round towards the {@literal "nearest neighbor"}
|
jaroslav@1258
|
244 |
* unless both neighbors are equidistant, in which case, round
|
jaroslav@1258
|
245 |
* towards the even neighbor. Behaves as for
|
jaroslav@1258
|
246 |
* {@code RoundingMode.HALF_UP} if the digit to the left of the
|
jaroslav@1258
|
247 |
* discarded fraction is odd; behaves as for
|
jaroslav@1258
|
248 |
* {@code RoundingMode.HALF_DOWN} if it's even. Note that this
|
jaroslav@1258
|
249 |
* is the rounding mode that statistically minimizes cumulative
|
jaroslav@1258
|
250 |
* error when applied repeatedly over a sequence of calculations.
|
jaroslav@1258
|
251 |
* It is sometimes known as {@literal "Banker's rounding,"} and is
|
jaroslav@1258
|
252 |
* chiefly used in the USA. This rounding mode is analogous to
|
jaroslav@1258
|
253 |
* the rounding policy used for {@code float} and {@code double}
|
jaroslav@1258
|
254 |
* arithmetic in Java.
|
jaroslav@1258
|
255 |
*
|
jaroslav@1258
|
256 |
*<p>Example:
|
jaroslav@1258
|
257 |
*<table border>
|
jaroslav@1258
|
258 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
259 |
* <th>Input rounded to one digit<br> with {@code HALF_EVEN} rounding
|
jaroslav@1258
|
260 |
*<tr align=right><td>5.5</td> <td>6</td>
|
jaroslav@1258
|
261 |
*<tr align=right><td>2.5</td> <td>2</td>
|
jaroslav@1258
|
262 |
*<tr align=right><td>1.6</td> <td>2</td>
|
jaroslav@1258
|
263 |
*<tr align=right><td>1.1</td> <td>1</td>
|
jaroslav@1258
|
264 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
265 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
266 |
*<tr align=right><td>-1.1</td> <td>-1</td>
|
jaroslav@1258
|
267 |
*<tr align=right><td>-1.6</td> <td>-2</td>
|
jaroslav@1258
|
268 |
*<tr align=right><td>-2.5</td> <td>-2</td>
|
jaroslav@1258
|
269 |
*<tr align=right><td>-5.5</td> <td>-6</td>
|
jaroslav@1258
|
270 |
*</table>
|
jaroslav@1258
|
271 |
*/
|
jaroslav@1258
|
272 |
HALF_EVEN(BigDecimal.ROUND_HALF_EVEN),
|
jaroslav@1258
|
273 |
|
jaroslav@1258
|
274 |
/**
|
jaroslav@1258
|
275 |
* Rounding mode to assert that the requested operation has an exact
|
jaroslav@1258
|
276 |
* result, hence no rounding is necessary. If this rounding mode is
|
jaroslav@1258
|
277 |
* specified on an operation that yields an inexact result, an
|
jaroslav@1258
|
278 |
* {@code ArithmeticException} is thrown.
|
jaroslav@1258
|
279 |
*<p>Example:
|
jaroslav@1258
|
280 |
*<table border>
|
jaroslav@1258
|
281 |
*<tr valign=top><th>Input Number</th>
|
jaroslav@1258
|
282 |
* <th>Input rounded to one digit<br> with {@code UNNECESSARY} rounding
|
jaroslav@1258
|
283 |
*<tr align=right><td>5.5</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
284 |
*<tr align=right><td>2.5</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
285 |
*<tr align=right><td>1.6</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
286 |
*<tr align=right><td>1.1</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
287 |
*<tr align=right><td>1.0</td> <td>1</td>
|
jaroslav@1258
|
288 |
*<tr align=right><td>-1.0</td> <td>-1</td>
|
jaroslav@1258
|
289 |
*<tr align=right><td>-1.1</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
290 |
*<tr align=right><td>-1.6</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
291 |
*<tr align=right><td>-2.5</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
292 |
*<tr align=right><td>-5.5</td> <td>throw {@code ArithmeticException}</td>
|
jaroslav@1258
|
293 |
*</table>
|
jaroslav@1258
|
294 |
*/
|
jaroslav@1258
|
295 |
UNNECESSARY(BigDecimal.ROUND_UNNECESSARY);
|
jaroslav@1258
|
296 |
|
jaroslav@1258
|
297 |
// Corresponding BigDecimal rounding constant
|
jaroslav@1258
|
298 |
final int oldMode;
|
jaroslav@1258
|
299 |
|
jaroslav@1258
|
300 |
/**
|
jaroslav@1258
|
301 |
* Constructor
|
jaroslav@1258
|
302 |
*
|
jaroslav@1258
|
303 |
* @param oldMode The {@code BigDecimal} constant corresponding to
|
jaroslav@1258
|
304 |
* this mode
|
jaroslav@1258
|
305 |
*/
|
jaroslav@1258
|
306 |
private RoundingMode(int oldMode) {
|
jaroslav@1258
|
307 |
this.oldMode = oldMode;
|
jaroslav@1258
|
308 |
}
|
jaroslav@1258
|
309 |
|
jaroslav@1258
|
310 |
/**
|
jaroslav@1258
|
311 |
* Returns the {@code RoundingMode} object corresponding to a
|
jaroslav@1258
|
312 |
* legacy integer rounding mode constant in {@link BigDecimal}.
|
jaroslav@1258
|
313 |
*
|
jaroslav@1258
|
314 |
* @param rm legacy integer rounding mode to convert
|
jaroslav@1258
|
315 |
* @return {@code RoundingMode} corresponding to the given integer.
|
jaroslav@1258
|
316 |
* @throws IllegalArgumentException integer is out of range
|
jaroslav@1258
|
317 |
*/
|
jaroslav@1258
|
318 |
public static RoundingMode valueOf(int rm) {
|
jaroslav@1258
|
319 |
switch(rm) {
|
jaroslav@1258
|
320 |
|
jaroslav@1258
|
321 |
case BigDecimal.ROUND_UP:
|
jaroslav@1258
|
322 |
return UP;
|
jaroslav@1258
|
323 |
|
jaroslav@1258
|
324 |
case BigDecimal.ROUND_DOWN:
|
jaroslav@1258
|
325 |
return DOWN;
|
jaroslav@1258
|
326 |
|
jaroslav@1258
|
327 |
case BigDecimal.ROUND_CEILING:
|
jaroslav@1258
|
328 |
return CEILING;
|
jaroslav@1258
|
329 |
|
jaroslav@1258
|
330 |
case BigDecimal.ROUND_FLOOR:
|
jaroslav@1258
|
331 |
return FLOOR;
|
jaroslav@1258
|
332 |
|
jaroslav@1258
|
333 |
case BigDecimal.ROUND_HALF_UP:
|
jaroslav@1258
|
334 |
return HALF_UP;
|
jaroslav@1258
|
335 |
|
jaroslav@1258
|
336 |
case BigDecimal.ROUND_HALF_DOWN:
|
jaroslav@1258
|
337 |
return HALF_DOWN;
|
jaroslav@1258
|
338 |
|
jaroslav@1258
|
339 |
case BigDecimal.ROUND_HALF_EVEN:
|
jaroslav@1258
|
340 |
return HALF_EVEN;
|
jaroslav@1258
|
341 |
|
jaroslav@1258
|
342 |
case BigDecimal.ROUND_UNNECESSARY:
|
jaroslav@1258
|
343 |
return UNNECESSARY;
|
jaroslav@1258
|
344 |
|
jaroslav@1258
|
345 |
default:
|
jaroslav@1258
|
346 |
throw new IllegalArgumentException("argument out of range");
|
jaroslav@1258
|
347 |
}
|
jaroslav@1258
|
348 |
}
|
jaroslav@1258
|
349 |
}
|