com.massa.util

Class Rounder

java.lang.Object

com.massa.util.Rounder

All Implemented Interfaces:

Serializable, Cloneable

public class Rounder
extends Object
implements Serializable, Cloneable

This class is used to store rounding directives for BigDecimals and to perform rounding. Non-provided or null rounding mode defaults to half up.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Rounder() Defaults to decimals = null (no limitation).
Rounder(Integer decimals) Defaults to mode = HALF_UP.
Rounder(Integer decimals, RoundingMode mode) Defaults to stripTrailingZeros = true.
Rounder(Integer decimals, RoundingMode mode, boolean stripTrailingZeros) Full constructor.
Rounder(String representation) Specific String constructor.

Method Summary

Modifier and Type	Method and Description
Rounder	clone()
boolean	equals(Object obj)
Integer	getDecimals()
RoundingMode	getMode()
int	hashCode()
boolean	isStripTrailingZeros()
BigDecimal	round(BigDecimal in) Performs rounding and striping.
void	setDecimals(Integer decimals)
void	setMode(RoundingMode mode) Null defaults to HALF_UP.
void	setStripTrailingZeros(boolean stripTrailingZeros)
BigDecimal	strip(BigDecimal in) Performs only striping.
static BigDecimal	stripDecimalZeros(BigDecimal in)
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Rounder

public Rounder()

Defaults to decimals = null (no limitation).

Rounder

public Rounder(Integer decimals)

Defaults to mode = HALF_UP.

Rounder

public Rounder(Integer decimals,
               RoundingMode mode)

Defaults to stripTrailingZeros = true.

Rounder

public Rounder(Integer decimals,
               RoundingMode mode,
               boolean stripTrailingZeros)

Full constructor.

Rounder

public Rounder(String representation)

Specific String constructor. Used to parse "toString" output.
Syntax is: [T|F]{0,1}[0-9]*[RoundingMode Value]{0,1}.

Throws:

IllegalArgumentException - if representation does not represent a Rounder.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

round

public BigDecimal round(BigDecimal in)

Performs rounding and striping.

strip

public BigDecimal strip(BigDecimal in)

Performs only striping.

stripDecimalZeros

public static BigDecimal stripDecimalZeros(BigDecimal in)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Rounder clone()

Overrides:

clone in class Object

getDecimals

public Integer getDecimals()

setDecimals

public void setDecimals(Integer decimals)

getMode

public RoundingMode getMode()

setMode

public final void setMode(RoundingMode mode)

Null defaults to HALF_UP.

isStripTrailingZeros

public boolean isStripTrailingZeros()

setStripTrailingZeros

public void setStripTrailingZeros(boolean stripTrailingZeros)