net.objectlab.kit.util

Class Total

java.lang.Object

net.objectlab.kit.util.Total

All Implemented Interfaces:

Serializable

public class Total
extends Object
implements Serializable

Mutable class representing a sum of BigDecimals.

Author:

Benoit Xhenseval

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Total()
Total(BigDecimal start)
Total(BigDecimal start, int scale)
Total(Total start)

Method Summary

Modifier and Type	Method and Description
Total	add(BigDecimal... value)
Total	add(Integer value)
Total	add(Total value)
Total	addIfTrue(boolean condition, BigDecimal... values)
int	getCount()
BigDecimal	getTotal()
boolean	isNegative()
boolean	isNotZero()
boolean	isZero()
boolean	isZeroOrLess()
Total	minus(BigDecimal... value)
Total	minus(Total value)
Total	setTotal(BigDecimal total)
Total	subtract(BigDecimal... value)
Total	subtractIfTrue(boolean condition, BigDecimal... values)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Total

public Total()

Total

public Total(BigDecimal start)

Total

public Total(BigDecimal start,
             int scale)

Total

public Total(Total start)

Method Detail

getTotal

public BigDecimal getTotal()

setTotal

public Total setTotal(BigDecimal total)

addIfTrue

public Total addIfTrue(boolean condition,
                       BigDecimal... values)

Parameters:

condition - if true, do the addition.

values -

Returns:

the total with changed value if condition is true.

Since:

1.4.0

add

public Total add(BigDecimal... value)

Returns:

the current Sum with new total.

subtractIfTrue

public Total subtractIfTrue(boolean condition,
                            BigDecimal... values)

Parameters:

condition - if true, do the subtraction.

values -

Returns:

the total with changed value if condition is true.

Since:

1.4.0

subtract

public Total subtract(BigDecimal... value)

add

public Total add(Integer value)

add

public Total add(Total value)

Returns:

the current Sum with new total.

minus

public Total minus(BigDecimal... value)

Returns:

the current Sum with new total.

minus

public Total minus(Total value)

Returns:

the current Sum with new total.

toString

public String toString()

Overrides:

toString in class Object

isZero

public boolean isZero()

isNotZero

public boolean isNotZero()

isNegative

public boolean isNegative()

isZeroOrLess

public boolean isZeroOrLess()

getCount

public int getCount()