pro.fessional.mirana.math

Class BigDecimalUtil

java.lang.Object

pro.fessional.mirana.math.BigDecimalUtil

public class BigDecimalUtil
extends Object

Null-friendly BigDecimal utility

Since:

2015-12-11.

Author:

trydofor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigDecimalUtil.W null treated as zero, not thread safe.

Constructor Summary

Constructors

Constructor and Description
BigDecimalUtil()

Method Summary

Modifier and Type	Method and Description
static @NotNull BigDecimal	add(Object a, Object b)
static @NotNull BigDecimal	add(Object a, Object b, Object... nums)
static BigDecimal	addElse(BigDecimal elze, Object a, Object b)
static BigDecimal	addElse(BigDecimal elze, Object a, Object b, Object... nums)
static @NotNull BigDecimal	addMap(Iterable<?> nums)
static <T> @NotNull BigDecimal	addMap(Iterable<T> nums, Function<? super T,?> mapper)
static BigDecimal	addMapElse(BigDecimal elze, Iterable<?> nums)
static <T> BigDecimal	addMapElse(BigDecimal elze, Iterable<T> nums, Function<? super T,?> mapper)
static @Nullable BigDecimal	addMapNull(Iterable<?> nums)
static <T> @Nullable BigDecimal	addMapNull(Iterable<T> nums, Function<? super T,?> mapper)
static @Nullable BigDecimal	addNull(Object a, Object b)
static @Nullable BigDecimal	addNull(Object a, Object b, Object... nums)
static @NotNull BigDecimal	avg(Object... nums) skip null num and get the average, NullPointerException if get null.
static @NotNull BigDecimal	avgMap(Iterable<?> nums) skip null num and get the average, NullPointerException if get null.
static <T> @NotNull BigDecimal	avgMap(Iterable<T> nums, Function<? super T,?> mapper) skip null num and get the average, NullPointerException if get null.
static @Nullable BigDecimal	avgMapNull(Iterable<?> nums) skip null num and get the average
static <T> @Nullable BigDecimal	avgMapNull(Iterable<T> nums, Function<? super T,?> mapper) mapping and skip null num and get the average
static @Nullable BigDecimal	avgNull(Object... nums) skip null num and get the average
static @NotNull BigDecimal	ceil(Object num, int scale) Remove all digit after `scale` (exclude), then ceil the `num`.
static int	compareTo(Object a, Object b) parse and compare the number, null less than any number
static int	compareTo(Object a, Object b, int scale, RoundingMode mode) parse, round and compare the number, null less than any number
static @NotNull BigDecimal	div(Object a, Object b)
static @NotNull BigDecimal	div(Object a, Object b, Object... nums)
static @NotNull BigDecimal	divMap(Object a, Iterable<?> cols)
static <T> @NotNull BigDecimal	divMap(Object a, Iterable<T> cols, Function<? super T,?> mapper)
static boolean	equalsValue(Object a, Object b)
static boolean	equalsValue(Object a, Object b, int scale, RoundingMode mode) parse, round and compare the number, null == null, null != notnull
static @NotNull BigDecimal	floor(Object num, int scale) Remove all digit after `scale` (exclude), then floor the `num`.
static @NotNull BigDecimal	ifElse(boolean cond, Object a, Object b) parse `a` if `cond`, else `b`, NullPointerException if all null.
static @NotNull BigDecimal	max(Object... nums)
static @NotNull BigDecimal	maxMap(Iterable<?> cols)
static <T> @NotNull BigDecimal	maxMap(Iterable<T> cols, Function<? super T,?> mapper)
static @Nullable BigDecimal	maxMapNull(Iterable<?> cols)
static <T> @Nullable BigDecimal	maxMapNull(Iterable<T> cols, Function<? super T,?> mapper)
static @Nullable BigDecimal	maxNull(Object... nums)
static @NotNull BigDecimal	min(Object... nums)
static @NotNull BigDecimal	minMap(Iterable<?> cols)
static <T> @NotNull BigDecimal	minMap(Iterable<T> cols, Function<? super T,?> mapper)
static @Nullable BigDecimal	minMapNull(Iterable<?> cols)
static <T> @Nullable BigDecimal	minMapNull(Iterable<T> cols, Function<? super T,?> mapper)
static @Nullable BigDecimal	minNull(Object... nums)
static @NotNull BigDecimal	mul(Object a, Object b)
static @NotNull BigDecimal	mul(Object a, Object b, Object... nums)
static BigDecimal	mulElse(BigDecimal e, Object a, Object b)
static BigDecimal	mulElse(BigDecimal e, Object a, Object b, Object... nums)
static @NotNull BigDecimal	mulMap(Iterable<?> cols)
static <T> @NotNull BigDecimal	mulMap(Iterable<T> cols, Function<? super T,?> mapper)
static <T> BigDecimal	mulMapElse(BigDecimal e, Iterable<T> cols)
static <T> BigDecimal	mulMapElse(BigDecimal e, Iterable<T> cols, Function<? super T,?> mapper)
static @Nullable BigDecimal	mulMapNull(Iterable<?> cols)
static <T> @Nullable BigDecimal	mulMapNull(Iterable<T> cols, Function<? super T,?> mapper)
static @Nullable BigDecimal	mulNull(Object a, Object b)
static @Nullable BigDecimal	mulNull(Object a, Object b, Object... nums)
static @NotNull BigDecimal	neg(Object num)
static @Nullable BigDecimal	negNull(Object num)
static @NotNull BigDecimal	notNull(Object... nums) get the first parsed non-null number, NullPointerException if all null.
static BigDecimal	object(Object num) convert `num` object to BigDecimal
static BigDecimal	object(Object num, BigDecimal elze) convert `num` object to BigDecimal, return `elze` if `num` is null.
static BigDecimal	object(Object num, BigDecimal elze, boolean fail) convert `num` object to BigDecimal, return `elze` if `num` is null.
static @NotNull BigDecimal[]	objects(BigDecimal elze, Object... nums)
static @NotNull BigDecimal	pow(Object num, int n)
static BigDecimal	powNull(Object num, int n)
static @NotNull BigDecimal	prd(Object a, Object b, Object... nums) product `a`, `b` and `sums`
static @NotNull BigDecimal	prdMap(Iterable<?> cols)
static <T> @NotNull BigDecimal	prdMap(Iterable<T> cols, Function<? super T,?> mapper)
static @NotNull BigDecimal	round(Object num, int scale) Remove all digit after `scale` (exclude), then round the `num`.
static @NotNull BigDecimal	scale(Object num, int scale, RoundingMode mode) Remove all digit after `scale` (exclude), then apply RoundingMode
static @NotNull String	string(BigDecimal num) Return empty if `num` is null
static @NotNull String	string(BigDecimal num, boolean strip) Remove zeros at the end if `strip`.
static @NotNull String	string(BigDecimal num, int scale) Remove all digit after `scale` (exclude) then `ceil` the number.
static @NotNull String	string(BigDecimal num, int scale, boolean strip) Remove all digit after `scale` (exclude), then `ceil` the number Remove zeros at the end if `strip`.
static String	string(BigDecimal num, String elze) Return `elze` if `num` is null
static String	string(BigDecimal num, String elze, boolean strip) Return `elze` if `num` null.
static @NotNull BigDecimal	sub(Object a, Object b)
static @NotNull BigDecimal	sub(Object a, Object b, Object... nums)
static @NotNull BigDecimal	subMap(Object a, Iterable<?> nums)
static <T> @NotNull BigDecimal	subMap(Object a, Iterable<T> nums, Function<? super T,?> mapper)
static @NotNull BigDecimal	sum(Object a, Object b, Object... nums) sum `a`, `b` and `nums`, return zero if result is null
static @NotNull BigDecimal	sumMap(Iterable<?> nums) sum `nums`, return zero if result is null
static <T> @NotNull BigDecimal	sumMap(Iterable<T> nums, Function<? super T,?> mapper) mapping and sum `nums`, return zero if get null
static @NotNull BigDecimal	unitDown(Object num, @NotNull BigDecimal unit, @NotNull BigDecimal accuracy) The `unit` is round down, and scale is based on unit.
static @NotNull BigDecimal	unitUp(Object num, @NotNull BigDecimal unit, @NotNull BigDecimal accuracy) The `unit` is round up, and scale is based on unit.
static @NotNull BigDecimalUtil.W	w(BigDecimal v, int scale)
static @NotNull BigDecimalUtil.W	w(Object v)

Methods inherited from class java.lang.Object

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

Constructor Detail

BigDecimalUtil

public BigDecimalUtil()

Method Detail

string

@NotNull
public static @NotNull String string(BigDecimal num)

Return empty if `num` is null

string

@NotNull
public static @NotNull String string(BigDecimal num,
                                              int scale)

Remove all digit after `scale` (exclude) then `ceil` the number.

string

public static String string(BigDecimal num,
                            String elze)

Return `elze` if `num` is null

string

@NotNull
public static @NotNull String string(BigDecimal num,
                                              boolean strip)

Remove zeros at the end if `strip`.

string

@NotNull
public static @NotNull String string(BigDecimal num,
                                              int scale,
                                              boolean strip)

 Remove all digit after `scale` (exclude), then `ceil` the number
 Remove zeros at the end if `strip`.
 

string

public static String string(BigDecimal num,
                            String elze,
                            boolean strip)

 Return `elze` if `num` null.
 Remove all digit after `scale` (exclude), then `ceil` the number
 Remove zeros at the end if `strip`.
 

object

@Contract(value="!null -> !null")
public static BigDecimal object(Object num)

convert `num` object to BigDecimal

object

@Contract(value="_, !null -> !null")
public static BigDecimal object(Object num,
                                                                     BigDecimal elze)

convert `num` object to BigDecimal, return `elze` if `num` is null.

object

@Contract(value="_, !null, _ -> !null")
public static BigDecimal object(Object num,
                                                                        BigDecimal elze,
                                                                        boolean fail)

convert `num` object to BigDecimal, return `elze` if `num` is null. throw the exception if there is exception and `fail`

objects

@NotNull
public static @NotNull BigDecimal[] objects(BigDecimal elze,
                                                     Object... nums)

notNull

@NotNull
public static @NotNull BigDecimal notNull(Object... nums)

get the first parsed non-null number, NullPointerException if all null.

ifElse

@NotNull
public static @NotNull BigDecimal ifElse(boolean cond,
                                                  Object a,
                                                  Object b)

parse `a` if `cond`, else `b`, NullPointerException if all null.

avg

@NotNull
public static @NotNull BigDecimal avg(Object... nums)

skip null num and get the average, NullPointerException if get null.

avgMap

@NotNull
public static @NotNull BigDecimal avgMap(Iterable<?> nums)

skip null num and get the average, NullPointerException if get null.

avgMap

@NotNull
public static <T> @NotNull BigDecimal avgMap(Iterable<T> nums,
                                                      Function<? super T,?> mapper)

skip null num and get the average, NullPointerException if get null.

avgNull

@Nullable
public static @Nullable BigDecimal avgNull(Object... nums)

skip null num and get the average

avgMapNull

@Nullable
public static @Nullable BigDecimal avgMapNull(Iterable<?> nums)

skip null num and get the average

avgMapNull

@Nullable
public static <T> @Nullable BigDecimal avgMapNull(Iterable<T> nums,
                                                            Function<? super T,?> mapper)

mapping and skip null num and get the average

max

@NotNull
public static @NotNull BigDecimal max(Object... nums)

maxMap

@NotNull
public static @NotNull BigDecimal maxMap(Iterable<?> cols)

maxMap

@NotNull
public static <T> @NotNull BigDecimal maxMap(Iterable<T> cols,
                                                      Function<? super T,?> mapper)

maxNull

@Nullable
public static @Nullable BigDecimal maxNull(Object... nums)

maxMapNull

@Nullable
public static @Nullable BigDecimal maxMapNull(Iterable<?> cols)

maxMapNull

@Nullable
public static <T> @Nullable BigDecimal maxMapNull(Iterable<T> cols,
                                                            Function<? super T,?> mapper)

min

@NotNull
public static @NotNull BigDecimal min(Object... nums)

minMap

@NotNull
public static @NotNull BigDecimal minMap(Iterable<?> cols)

minMap

@NotNull
public static <T> @NotNull BigDecimal minMap(Iterable<T> cols,
                                                      Function<? super T,?> mapper)

minNull

@Nullable
public static @Nullable BigDecimal minNull(Object... nums)

minMapNull

@Nullable
public static @Nullable BigDecimal minMapNull(Iterable<?> cols)

minMapNull

@Nullable
public static <T> @Nullable BigDecimal minMapNull(Iterable<T> cols,
                                                            Function<? super T,?> mapper)

sum

@NotNull
public static @NotNull BigDecimal sum(Object a,
                                               Object b,
                                               Object... nums)

sum `a`, `b` and `nums`, return zero if result is null

sumMap

@NotNull
public static @NotNull BigDecimal sumMap(Iterable<?> nums)

sum `nums`, return zero if result is null

sumMap

@NotNull
public static <T> @NotNull BigDecimal sumMap(Iterable<T> nums,
                                                      Function<? super T,?> mapper)

mapping and sum `nums`, return zero if get null

add

@NotNull
public static @NotNull BigDecimal add(Object a,
                                               Object b)

add

@NotNull
public static @NotNull BigDecimal add(Object a,
                                               Object b,
                                               Object... nums)

addMap

@NotNull
public static @NotNull BigDecimal addMap(Iterable<?> nums)

addMap

@NotNull
public static <T> @NotNull BigDecimal addMap(Iterable<T> nums,
                                                      Function<? super T,?> mapper)

addElse

@Contract(value="!null,_,_ -> !null")
public static BigDecimal addElse(BigDecimal elze,
                                                                       Object a,
                                                                       Object b)

addElse

@Contract(value="!null,_,_,_ -> !null")
public static BigDecimal addElse(BigDecimal elze,
                                                                         Object a,
                                                                         Object b,
                                                                         Object... nums)

addMapElse

@Contract(value="!null,_ -> !null")
public static BigDecimal addMapElse(BigDecimal elze,
                                                                        Iterable<?> nums)

addMapElse

@Contract(value="!null,_,_ -> !null")
public static <T> BigDecimal addMapElse(BigDecimal elze,
                                                                              Iterable<T> nums,
                                                                              Function<? super T,?> mapper)

addNull

@Nullable
public static @Nullable BigDecimal addNull(Object a,
                                                     Object b)

addNull

@Nullable
public static @Nullable BigDecimal addNull(Object a,
                                                     Object b,
                                                     Object... nums)

addMapNull

@Nullable
public static @Nullable BigDecimal addMapNull(Iterable<?> nums)

addMapNull

@Nullable
public static <T> @Nullable BigDecimal addMapNull(Iterable<T> nums,
                                                            Function<? super T,?> mapper)

sub

@NotNull
public static @NotNull BigDecimal sub(Object a,
                                               Object b)

sub

@NotNull
public static @NotNull BigDecimal sub(Object a,
                                               Object b,
                                               Object... nums)

subMap

@NotNull
public static @NotNull BigDecimal subMap(Object a,
                                                  Iterable<?> nums)

subMap

@NotNull
public static <T> @NotNull BigDecimal subMap(Object a,
                                                      Iterable<T> nums,
                                                      Function<? super T,?> mapper)

prd

@NotNull
public static @NotNull BigDecimal prd(Object a,
                                               Object b,
                                               Object... nums)

product `a`, `b` and `sums`

prdMap

@NotNull
public static @NotNull BigDecimal prdMap(Iterable<?> cols)

prdMap

@NotNull
public static <T> @NotNull BigDecimal prdMap(Iterable<T> cols,
                                                      Function<? super T,?> mapper)

mul

@NotNull
public static @NotNull BigDecimal mul(Object a,
                                               Object b)

mul

@NotNull
public static @NotNull BigDecimal mul(Object a,
                                               Object b,
                                               Object... nums)

mulMap

@NotNull
public static @NotNull BigDecimal mulMap(Iterable<?> cols)

mulMap

@NotNull
public static <T> @NotNull BigDecimal mulMap(Iterable<T> cols,
                                                      Function<? super T,?> mapper)

mulElse

@Contract(value="!null,_,_ -> !null")
public static BigDecimal mulElse(BigDecimal e,
                                                                       Object a,
                                                                       Object b)

mulElse

@Contract(value="!null,_,_,_ -> !null")
public static BigDecimal mulElse(BigDecimal e,
                                                                         Object a,
                                                                         Object b,
                                                                         Object... nums)

mulMapElse

@Contract(value="!null,_ -> !null")
public static <T> BigDecimal mulMapElse(BigDecimal e,
                                                                            Iterable<T> cols)

mulMapElse

@Contract(value="!null,_,_ -> !null")
public static <T> BigDecimal mulMapElse(BigDecimal e,
                                                                              Iterable<T> cols,
                                                                              Function<? super T,?> mapper)

mulNull

@Nullable
public static @Nullable BigDecimal mulNull(Object a,
                                                     Object b)

mulNull

@Nullable
public static @Nullable BigDecimal mulNull(Object a,
                                                     Object b,
                                                     Object... nums)

mulMapNull

@Nullable
public static @Nullable BigDecimal mulMapNull(Iterable<?> cols)

mulMapNull

@Nullable
public static <T> @Nullable BigDecimal mulMapNull(Iterable<T> cols,
                                                            Function<? super T,?> mapper)

div

@NotNull
public static @NotNull BigDecimal div(Object a,
                                               Object b)

div

@NotNull
public static @NotNull BigDecimal div(Object a,
                                               Object b,
                                               Object... nums)

divMap

@NotNull
public static @NotNull BigDecimal divMap(Object a,
                                                  Iterable<?> cols)

divMap

@NotNull
public static <T> @NotNull BigDecimal divMap(Object a,
                                                      Iterable<T> cols,
                                                      Function<? super T,?> mapper)

pow

@NotNull
public static @NotNull BigDecimal pow(Object num,
                                               int n)

powNull

public static BigDecimal powNull(Object num,
                                 int n)

neg

@NotNull
public static @NotNull BigDecimal neg(Object num)

negNull

@Nullable
public static @Nullable BigDecimal negNull(Object num)

ceil

@NotNull
public static @NotNull BigDecimal ceil(Object num,
                                                int scale)

Remove all digit after `scale` (exclude), then ceil the `num`. return `0.xxx` if null, xxx is `scale`

floor

@NotNull
public static @NotNull BigDecimal floor(Object num,
                                                 int scale)

Remove all digit after `scale` (exclude), then floor the `num`. return `0.xxx` if null, xxx is `scale`

round

@NotNull
public static @NotNull BigDecimal round(Object num,
                                                 int scale)

Remove all digit after `scale` (exclude), then round the `num`. return `0.xxx` if null, xxx is `scale`

scale

@NotNull
public static @NotNull BigDecimal scale(Object num,
                                                 int scale,
                                                 RoundingMode mode)

Remove all digit after `scale` (exclude), then apply RoundingMode

unitUp

@NotNull
public static @NotNull BigDecimal unitUp(Object num,
                                                  @NotNull
                                                  @NotNull BigDecimal unit,
                                                  @NotNull
                                                  @NotNull BigDecimal accuracy)

 The `unit` is round up, and scale is based on unit.
 Take weighing and pricing as an example, pricing unit=0.5, weighing accuracy=0.01
 When x > 0.1, treated as 0.5, otherwise treated as 0.
 When x > 0.6, treated as 1, otherwise treated as 0.5.
 

Parameters:

num - the number

unit - the unit

accuracy - less than or equal to the value is rounded off

unitDown

@NotNull
public static @NotNull BigDecimal unitDown(Object num,
                                                    @NotNull
                                                    @NotNull BigDecimal unit,
                                                    @NotNull
                                                    @NotNull BigDecimal accuracy)

 The `unit` is round down, and scale is based on unit.
 Take weighing and pricing as an example, pricing unit=0.5, weighing accuracy=0.01
 When x > 0.4, treated as 0.5, otherwise treated as 0.
 When x > 0.9, treated as 1, otherwise treated as 0.5.
 

Parameters:

num - the number

unit - the unit

accuracy - greater than or equal to the value is rounded up

compareTo

public static int compareTo(Object a,
                            Object b)

parse and compare the number, null less than any number

compareTo

public static int compareTo(Object a,
                            Object b,
                            int scale,
                            RoundingMode mode)

parse, round and compare the number, null less than any number

equalsValue

public static boolean equalsValue(Object a,
                                  Object b)

equalsValue

public static boolean equalsValue(Object a,
                                  Object b,
                                  int scale,
                                  RoundingMode mode)

parse, round and compare the number, null == null, null != notnull

w

@NotNull
public static @NotNull BigDecimalUtil.W w(Object v)

w

@NotNull
public static @NotNull BigDecimalUtil.W w(BigDecimal v,
                                                   int scale)