RoundingUtils (Groovy Documentation)

SharedLib.elements.RoundingUtils

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`DEFAULT_DECIMAL_DIGITS`
`java.lang.Object`	`ROUNDING_MODES`
`java.lang.Object`	`ROUNDING_RULES`
`java.lang.Object`	`ROUNDING_TYPES`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected BigDecimal`	`getComparePart(BigDecimal numberToRound, BigDecimal roundingTarget)` Get compare part of a number
	`protected BigDecimal`	`getRoundedDownDecimal(BigDecimal numberToRound, BigDecimal roundingTarget)` Get the nearest number that less than the number to be rounded and have the suffix in decimal part
	`protected BigDecimal`	`getRoundedDownWhole(BigDecimal numberToRound, BigDecimal roundingTarget)` Get the nearest number that less than the number to be rounded and have the suffix in whole number part
	`protected BigDecimal`	`getRoundedNumber(BigDecimal down, BigDecimal up, BigDecimal numberToRound, java.lang.String roundingDirection)` Round a number with specified end points
	`protected BigDecimal`	`getRoundedUpDecimal(BigDecimal numberToRound, BigDecimal roundingTarget)` Get the nearest number that greater than the number to be rounded and have the suffix in decimal part
	`protected BigDecimal`	`getRoundedUpWhole(BigDecimal numberToRound, BigDecimal roundingTarget)` Get the nearest number that greater than the number to be rounded and have the suffix in whole number part
	`protected int`	`getRoundingModeEnum(java.lang.String direction)` Get rounding mode in standard enum
`null`	`static void`	`main(java.lang.String[] args)` Implicit main method for Groovy Scripts
	`BigDecimal`	`round(BigDecimal number, int decimalPlaces)` A general function that rounds a number to N decimals
	`BigDecimal`	`round(BigDecimal numberToRound, java.lang.String rule, java.lang.String direction)` Transforms a number to have a specific suffix.
	`BigDecimal`	`roundPercent(BigDecimal price)` Round a percentage to 2 decimals or upon based on a rounding lookup table name if provided.
	`BigDecimal`	`roundPrice(BigDecimal price, int decimalPlaces)` Rounds a price to N decimals
	`BigDecimal`	`roundUp(BigDecimal number, int decimalPlaces)` A general function that rounds up a number to N decimals
	`protected BigDecimal`	`trunc(BigDecimal number)` Remove decimal part of a BigDecimal

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.lang.Script`	groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(long), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()
`class groovy.lang.GroovyObjectSupport`	groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()

- Property Detail
  - @groovy.transform.Field java.lang.Object DEFAULT_DECIMAL_DIGITS
  - @groovy.transform.Field java.lang.Object ROUNDING_MODES
  - @groovy.transform.Field java.lang.Object ROUNDING_RULES
  - @groovy.transform.Field java.lang.Object ROUNDING_TYPES
- Method Detail
  - protected BigDecimal getComparePart(BigDecimal numberToRound, BigDecimal roundingTarget)
    
    Get compare part of a number
    Parameters:
    numberToRound - BigDecimal the number contains part to be taken
    roundingTarget - BigDecimal the number to be compared
    Returns:
  - protected BigDecimal getRoundedDownDecimal(BigDecimal numberToRound, BigDecimal roundingTarget)
    
    Get the nearest number that less than the number to be rounded and have the suffix in decimal part
    Parameters:
    numberToRound - BigDecimal the number to be rounded
    roundingTarget - BigDecimal the suffix number to have
    Returns:
    the nearest number. If there is no such number, return 0
  - protected BigDecimal getRoundedDownWhole(BigDecimal numberToRound, BigDecimal roundingTarget)
    
    Get the nearest number that less than the number to be rounded and have the suffix in whole number part
    Parameters:
    numberToRound - BigDecimal the number to be rounded
    roundingTarget - BigDecimal the suffix number to have
    Returns:
    the nearest number
  - protected BigDecimal getRoundedNumber(BigDecimal down, BigDecimal up, BigDecimal numberToRound, java.lang.String roundingDirection)
    
    Round a number with specified end points
    Parameters:
    down - BigDecimal the lower end
    up - BigDecimal the higher end
    numberToRound - BigDecimal the number to be rounded
    roundingDirection - String rounding direction / mode
    Returns:
    rounded number
  - protected BigDecimal getRoundedUpDecimal(BigDecimal numberToRound, BigDecimal roundingTarget)
    
    Get the nearest number that greater than the number to be rounded and have the suffix in decimal part
    Parameters:
    numberToRound - BigDecimal the number to be rounded
    roundingTarget - BigDecimal the suffix number to have
    Returns:
    the nearest number
  - protected BigDecimal getRoundedUpWhole(BigDecimal numberToRound, BigDecimal roundingTarget)
    
    Get the nearest number that greater than the number to be rounded and have the suffix in whole number part
    Parameters:
    numberToRound - BigDecimal the number to be rounded
    roundingTarget - BigDecimal the suffix number to have
    Returns:
    the nearest number
  - protected int getRoundingModeEnum(java.lang.String direction)
    
    Get rounding mode in standard enum
    Parameters:
    direction - String rounding direction / mode
    Returns:
    rounded number
  - static void main(java.lang.String[] args)
    
    Implicit main method for Groovy Scripts
  - BigDecimal round(BigDecimal number, int decimalPlaces)
    
    A general function that rounds a number to N decimals
    Parameters:
    number
    decimalPlaces
    Returns:
    null if the price is null
  - BigDecimal round(BigDecimal numberToRound, java.lang.String rule, java.lang.String direction)
    
    Transforms a number to have a specific suffix.
    Parameters:
    numberToRound - BigDecimal the number to be rounded. Only positive numbers are supported.
    rule - String name of the rule to be applied supported rule: To49Cents, To50Cents, To95Cents, To99Cents, ToWhole, To5Whole, To49Whole, To99Whole, RawPrice, NoRounding
    direction - String the direction / mode of rounding supported direction: UP, DOWN, HALF_UP, HALF_DOWN
    Returns:
    rounded number. If numberToRound, rule, or direction is invalid, returns the raw number
  - BigDecimal roundPercent(BigDecimal price)
    
    Round a percentage to 2 decimals or upon based on a rounding lookup table name if provided.
    Parameters:
    price
    Returns:
    null if the price is null
  - BigDecimal roundPrice(BigDecimal price, int decimalPlaces)
    
    Rounds a price to N decimals
    Parameters:
    price
    decimalPlaces
    Returns:
  - BigDecimal roundUp(BigDecimal number, int decimalPlaces)
    
    A general function that rounds up a number to N decimals
    Parameters:
    number
    decimalPlaces
    Returns:
    null if the price is null
  - protected BigDecimal trunc(BigDecimal number)
    
    Remove decimal part of a BigDecimal
    Parameters:
    number - BigDecimal the number to be truncated
    Returns:
    truncated number

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Script RoundingUtils

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

@groovy.transform.Field java.lang.Object DEFAULT_DECIMAL_DIGITS

@groovy.transform.Field java.lang.Object ROUNDING_MODES

@groovy.transform.Field java.lang.Object ROUNDING_RULES

@groovy.transform.Field java.lang.Object ROUNDING_TYPES

Method Detail

protected BigDecimal getComparePart(BigDecimal numberToRound, BigDecimal roundingTarget)

protected BigDecimal getRoundedDownDecimal(BigDecimal numberToRound, BigDecimal roundingTarget)

protected BigDecimal getRoundedDownWhole(BigDecimal numberToRound, BigDecimal roundingTarget)

protected BigDecimal getRoundedNumber(BigDecimal down, BigDecimal up, BigDecimal numberToRound, java.lang.String roundingDirection)

protected BigDecimal getRoundedUpDecimal(BigDecimal numberToRound, BigDecimal roundingTarget)

protected BigDecimal getRoundedUpWhole(BigDecimal numberToRound, BigDecimal roundingTarget)

protected int getRoundingModeEnum(java.lang.String direction)

static void main(java.lang.String[] args)

BigDecimal round(BigDecimal number, int decimalPlaces)

BigDecimal round(BigDecimal numberToRound, java.lang.String rule, java.lang.String direction)

BigDecimal roundPercent(BigDecimal price)

BigDecimal roundPrice(BigDecimal price, int decimalPlaces)

BigDecimal roundUp(BigDecimal number, int decimalPlaces)

protected BigDecimal trunc(BigDecimal number)