Round (OpenL - DEV - Util 5.22.7 API)

java.lang.Object
- org.openl.rules.util.Round

```
public final class Round
extends Object
```
A set of rounding util methods. Note: For OpenL rules only! Don't use it in Java code.

Author:

Yury Molchan

Field Summary

Fields
Modifier and Type	Field and Description
`static RoundingMode`	`CEILING`
`static RoundingMode`	`DOWN`
`static RoundingMode`	`FLOOR`
`static RoundingMode`	`HALF_DOWN`
`static RoundingMode`	`HALF_EVEN`
`static RoundingMode`	`HALF_UP`
`static RoundingMode`	`UNNECESSARY`
`static RoundingMode`	`UP`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BigDecimal`	`round(BigDecimal value)` Returns the closest integer to the argument, with ties rounding up.
`static BigDecimal`	`round(BigDecimal value, int scale)` Round the given value to the specified number of decimal places.
`static BigDecimal`	`round(BigDecimal x, int scale, int rounding)` For backward compatibility
`static BigDecimal`	`round(BigDecimal x, int scale, RoundingMode rounding)` Round the given value to the specified number of decimal places.
`static long`	`round(double value)` Returns the closest `long` to the argument, with ties rounding up.
`static Long`	`round(Double value)` Like `round(double)` but null-safe.
`static double`	`round(double value, int scale)` Round the given value to the specified number of decimal places.
`static Double`	`round(Double value, int scale)` Like `round(double, int)` but null-safe.
`static Double`	`round(Double x, int scale, int rounding)` For backward compatibility
`static double`	`round(double x, int scale, RoundingMode rounding)` Round the given value to the specified number of decimal places.
`static Double`	`round(Double value, int scale, RoundingMode rounding)` Like `round(double, int, RoundingMode)` but null-safe.
`static int`	`round(float value)` Returns the closest `int` to the argument, with ties rounding up.
`static Integer`	`round(Float value)` Like `round(float)` but null-safe.
`static float`	`round(float value, int scale)` Round the given value to the specified number of decimal places.
`static Float`	`round(Float value, int scale)` Like `round(float, int)` but null-safe.
`static Float`	`round(Float x, int scale, int rounding)` For backward compatibility
`static float`	`round(float x, int scale, RoundingMode rounding)` Round the given value to the specified number of decimal places.
`static Float`	`round(Float value, int scale, RoundingMode rounding)` Like `round(float, int, RoundingMode)` but null-safe.
`static Long`	`roundStrict(Double value)` Like `round(double)` but without a ulp amendment
`static Double`	`roundStrict(Double value, int scale)` Like `round(double)` but without a ulp amendment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UP
```
public static final RoundingMode UP
```
  - DOWN
```
public static final RoundingMode DOWN
```
  - CEILING
```
public static final RoundingMode CEILING
```
  - FLOOR
```
public static final RoundingMode FLOOR
```
  - HALF_UP
```
public static final RoundingMode HALF_UP
```
  - HALF_DOWN
```
public static final RoundingMode HALF_DOWN
```
  - HALF_EVEN
```
public static final RoundingMode HALF_EVEN
```
  - UNNECESSARY
```
public static final RoundingMode UNNECESSARY
```
- Method Detail
  - round
```
public static Long round(Double value)
```
    Like round(double) but null-safe.
  - round
```
public static long round(double value)
```
    Returns the closest long to the argument, with ties rounding up. The value is rounded like using the RoundingMode.HALF_UP method.
    
    Special cases:
    - If the argument is NaN, the result is 0.
    - If the argument is negative infinity or any value less than or equal to the value of Long.MIN_VALUE, the result is equal to the value of Long.MIN_VALUE.
    - If the argument is positive infinity or any value greater than or equal to the value of Long.MAX_VALUE, the result is equal to the value of Long.MAX_VALUE.
    Parameters:
    
    value - a floating-point value to be rounded to a long.
    
    Returns:
    
    the value of the argument rounded to the nearest long value.
  - round
```
public static Integer round(Float value)
```
    Like round(float) but null-safe.
  - round
```
public static int round(float value)
```
    Returns the closest int to the argument, with ties rounding up. The value is rounded like using the RoundingMode.HALF_UP method.
    
    Special cases:
    - If the argument is NaN, the result is 0.
    - If the argument is negative infinity or any value less than or equal to the value of Integer.MIN_VALUE, the result is equal to the value of Integer.MIN_VALUE.
    - If the argument is positive infinity or any value greater than or equal to the value of Integer.MAX_VALUE, the result is equal to the value of Integer.MAX_VALUE.
    Parameters:
    
    value - a floating-point value to be rounded to an integer.
    
    Returns:
    
    the value of the argument rounded to the nearest int value.
  - round
```
public static BigDecimal round(BigDecimal value)
```
    Returns the closest integer to the argument, with ties rounding up. The value is rounded like using the RoundingMode.HALF_UP method.
  - round
```
public static Double round(Double value,
                           int scale)
```
    Like round(double, int) but null-safe.
  - round
```
public static double round(double value,
                           int scale)
```
    Round the given value to the specified number of decimal places. The value is rounded using the RoundingMode.HALF_UP method.
    
    Parameters:
    
    value - the value to round.
    
    scale - the number of digits to the right of the decimal point.
    
    Returns:
    
    the rounded value.
  - round
```
public static BigDecimal round(BigDecimal value,
                               int scale)
```
    Round the given value to the specified number of decimal places. The value is rounded using the RoundingMode.HALF_UP method.
    
    Parameters:
    
    value - the value to round.
    
    scale - the number of digits to the right of the decimal point.
    
    Returns:
    
    the rounded value.
  - round
```
public static Float round(Float value,
                          int scale)
```
    Like round(float, int) but null-safe.
  - round
```
public static float round(float value,
                          int scale)
```
    Round the given value to the specified number of decimal places. The value is rounded using the RoundingMode.HALF_UP method.
    
    Parameters:
    
    value - the value to round.
    
    scale - the number of digits to the right of the decimal point.
    
    Returns:
    
    the rounded value.
  - round
```
public static Double round(Double value,
                           int scale,
                           RoundingMode rounding)
```
    Like round(double, int, RoundingMode) but null-safe.
  - round
```
public static double round(double x,
                           int scale,
                           RoundingMode rounding)
```
    Round the given value to the specified number of decimal places. The value is rounded using the given method which is any method defined in RoundingMode.
    
    Parameters:
    
    x - the value to round.
    
    scale - the number of digits to the right of the decimal point.
    
    rounding - the rounding method as defined in RoundingMode.
    
    Returns:
    
    the rounded value.
  - round
```
public static Float round(Float value,
                          int scale,
                          RoundingMode rounding)
```
    Like round(float, int, RoundingMode) but null-safe.
  - round
```
public static float round(float x,
                          int scale,
                          RoundingMode rounding)
```
    Round the given value to the specified number of decimal places. The value is rounded using the given method which is any method defined in RoundingMode.
    
    Parameters:
    
    x - the value to round.
    
    scale - the number of digits to the right of the decimal point.
    
    rounding - the rounding method as defined in RoundingMode.
    
    Returns:
    
    the rounded value.
  - round
```
public static BigDecimal round(BigDecimal x,
                               int scale,
                               RoundingMode rounding)
```
    Round the given value to the specified number of decimal places. The value is rounded using the given method which is any method defined in RoundingMode.
    
    Parameters:
    
    x - the value to round.
    
    scale - the number of digits to the right of the decimal point.
    
    rounding - the rounding method as defined in RoundingMode.
    
    Returns:
    
    the rounded value.
  - round
```
public static Double round(Double x,
                           int scale,
                           int rounding)
```
    For backward compatibility
  - round
```
public static Float round(Float x,
                          int scale,
                          int rounding)
```
    For backward compatibility
  - round
```
public static BigDecimal round(BigDecimal x,
                               int scale,
                               int rounding)
```
    For backward compatibility
  - roundStrict
```
public static Long roundStrict(Double value)
```
    Like round(double) but without a ulp amendment
  - roundStrict
```
public static Double roundStrict(Double value,
                                 int scale)
```
    Like round(double) but without a ulp amendment

Class Round

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UP

DOWN

CEILING

FLOOR

HALF_UP

HALF_DOWN

HALF_EVEN

UNNECESSARY

Method Detail

round

round

round

round

round

round

round

round

round

round

round

round

round

round

round

round

round

round

roundStrict

roundStrict