 
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
public final enum RoundingMode extends Enum
Specifies a rounding behavior for numerical operations capable of discarding precision. Each rounding mode indicates how the least significant returned digit of a rounded result is to be calculated. If fewer digits are returned than the digits needed to represent the exact numerical result, the discarded digits will be referred to as the discarded fraction regardless the digits' contribution to the value of the number. In other words, considered as a numerical value, the discarded fraction could have an absolute value greater than one.
Each rounding mode description includes a table listing how different twodigit decimal values would round to a one digit decimal value under the rounding mode in question. The result column in the tables could be gotten by creating a BigDecimal number with the specified value, forming a {@link MathContext} object with the proper settings (precision set to 1, and the roundingMode set to the rounding mode in question), and calling {@link BigDecimal#round round} on this number with the proper MathContext. A summary table showing the results of these rounding operations for all rounding modes appears below.
Result of rounding input to one digit with the given rounding mode  

Input Number  UP  DOWN  CEILING  FLOOR  HALF_UP  HALF_DOWN  HALF_EVEN  UNNECESSARY 
5.5  6  5  6  5  6  5  6  throw ArithmeticException 
2.5  3  2  3  2  3  2  2  throw ArithmeticException 
1.6  2  1  2  1  2  2  2  throw ArithmeticException 
1.1  2  1  2  1  1  1  1  throw ArithmeticException 
1.0  1  1  1  1  1  1  1  1 
1.0  1  1  1  1  1  1  1  1 
1.1  2  1  1  2  1  1  1  throw ArithmeticException 
1.6  2  1  1  2  2  2  2  throw ArithmeticException 
2.5  3  2  2  3  3  2  2  throw ArithmeticException 
5.5  6  5  5  6  6  5  6  throw ArithmeticException 
This enum is intended to replace the integerbased enumeration of rounding mode constants in {@link BigDecimal} ({@link BigDecimal#ROUND_UP}, {@link BigDecimal#ROUND_DOWN}, etc. ).
Field Summary  

static RoundingMode 
CEILING
Rounding mode to round towards positive infinity. 
static RoundingMode 
DOWN
Rounding mode to round towards zero. 
static RoundingMode 
FLOOR
Rounding mode to round towards negative infinity. 
static RoundingMode 
HALF_DOWN
Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down. 
static RoundingMode 
HALF_EVEN
Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor. 
static RoundingMode 
HALF_UP
Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. 
static RoundingMode 
UNNECESSARY
Rounding mode to assert that the requested operation has an exact result, hence no rounding is necessary. 
static RoundingMode 
UP
Rounding mode to round away from zero. 
Method Summary  

static RoundingMode 
valueOf(int rm) Returns the RoundingMode object corresponding to a legacy integer rounding mode constant in java.math.BigDecimal. 
static RoundingMode 

static RoundingMode[] 
values() 
Methods inherited from class java.lang.Enum 

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf 
Methods inherited from class java.lang.Object 

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 
Field Detail 

public static final RoundingMode CEILING
Example:
Input Number  Input rounded to one digit with CEILING rounding 

5.5  6 
2.5  3 
1.6  2 
1.1  2 
1.0  1 
1.0  1 
1.1  1 
1.6  1 
2.5  2 
5.5  5 
public static final RoundingMode DOWN
Example:
Input Number  Input rounded to one digit with DOWN rounding 

5.5  5 
2.5  2 
1.6  1 
1.1  1 
1.0  1 
1.0  1 
1.1  1 
1.6  1 
2.5  2 
5.5  5 
public static final RoundingMode FLOOR
Example:
Input Number  Input rounded to one digit with FLOOR rounding 

5.5  5 
2.5  2 
1.6  1 
1.1  1 
1.0  1 
1.0  1 
1.1  2 
1.6  2 
2.5  3 
5.5  6 
public static final RoundingMode HALF_DOWN
Example:
Input Number  Input rounded to one digit with HALF_DOWN rounding 

5.5  5 
2.5  2 
1.6  2 
1.1  1 
1.0  1 
1.0  1 
1.1  1 
1.6  2 
2.5  2 
5.5  5 
public static final RoundingMode HALF_EVEN
Example:
Input Number  Input rounded to one digit with HALF_EVEN rounding 

5.5  6 
2.5  2 
1.6  2 
1.1  1 
1.0  1 
1.0  1 
1.1  1 
1.6  2 
2.5  2 
5.5  6 
public static final RoundingMode HALF_UP
Example:
Input Number  Input rounded to one digit with HALF_UP rounding 

5.5  6 
2.5  3 
1.6  2 
1.1  1 
1.0  1 
1.0  1 
1.1  1 
1.6  2 
2.5  3 
5.5  6 
public static final RoundingMode UNNECESSARY
Example:
Input Number  Input rounded to one digit with UNNECESSARY rounding 

5.5  throw ArithmeticException 
2.5  throw ArithmeticException 
1.6  throw ArithmeticException 
1.1  throw ArithmeticException 
1.0  1 
1.0  1 
1.1  throw ArithmeticException 
1.6  throw ArithmeticException 
2.5  throw ArithmeticException 
5.5  throw ArithmeticException 
public static final RoundingMode UP
Example:
Input Number  Input rounded to one digit with UP rounding 

5.5  6 
2.5  3 
1.6  2 
1.1  2 
1.0  1 
1.0  1 
1.1  2 
1.6  2 
2.5  3 
5.5  6 
Method Detail 

public static RoundingMode valueOf(int rm)
rm
 legacy integer rounding mode to convertpublic static RoundingMode valueOf(String name)
name
public static RoundingMode[] values()
 
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 