com.helger.commons.mutable

Class MutableBigDecimal

java.lang.Object

java.lang.Number

com.helger.commons.mutable.AbstractMutableNumeric<MutableBigDecimal>

com.helger.commons.mutable.MutableBigDecimal

All Implemented Interfaces:

IComparable<MutableBigDecimal>, ICloneable<MutableBigDecimal>, IMutableNumeric<MutableBigDecimal>, IMutableObject<MutableBigDecimal>, INumber, IGenericImplTrait<MutableBigDecimal>, Serializable, Comparable<MutableBigDecimal>

@NotThreadSafe
public class MutableBigDecimal
extends AbstractMutableNumeric<MutableBigDecimal>

Object wrapper around a BigDecimal so that it can be passed a final object but is mutable.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MutableBigDecimal(BigDecimal aValue)
MutableBigDecimal(double dValue)
MutableBigDecimal(long nValue)
MutableBigDecimal(MutableBigDecimal aOther)

Method Summary

Modifier and Type	Method and Description
int	compareTo(MutableBigDecimal rhs)
BigDecimal	dec()
BigDecimal	dec(BigDecimal aDelta)
BigDecimal	dec(double dDelta)
BigDecimal	dec(long nDelta)
BigDecimal	dec(MutableBigDecimal aDelta)
BigDecimal	divide(BigDecimal aDivisor, int nScale, RoundingMode eRoundingMode)
BigDecimal	divide(double dDivisor, int nScale, RoundingMode eRoundingMode)
BigDecimal	divide(long nDivisor, int nScale, RoundingMode eRoundingMode)
BigDecimal	divide(MutableBigDecimal aDivisor, int nScale, RoundingMode eRoundingMode)
double	doubleValue() Returns the value of the specified number as a double, which may involve rounding.
boolean	equals(Object o)
float	floatValue() Returns the value of the specified number as a float, which may involve rounding.
BigDecimal	getAsBigDecimal()
MutableBigDecimal	getClone()
int	hashCode()
BigDecimal	inc() Increment by 1 and return the modified value.
BigDecimal	inc(BigDecimal aDelta)
BigDecimal	inc(double dDelta)
BigDecimal	inc(long nDelta)
BigDecimal	inc(MutableBigDecimal aDelta)
int	intValue() Returns the value of the specified number as an int, which may involve rounding or truncation.
boolean	is0()
boolean	isGE0()
boolean	isGT0()
boolean	isLE0()
boolean	isLT0()
long	longValue() Returns the value of the specified number as a long, which may involve rounding or truncation.
BigDecimal	multiply(BigDecimal aMultiplicand)
BigDecimal	multiply(double dMultiplicand)
BigDecimal	multiply(long nMultiplicand)
BigDecimal	multiply(MutableBigDecimal aMultiplicand)
EChange	set(BigDecimal aValue)
EChange	set(double dDelta)
EChange	set(long nDelta)
EChange	set(MutableBigDecimal aValue)
String	toString()

Methods inherited from class com.helger.commons.mutable.AbstractMutableNumeric

onAfterChange

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.mutable.IMutableNumeric

getAsBigInteger, getAsByte, getAsCharacter, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsShort, isNot0

Methods inherited from interface com.helger.commons.compare.IComparable

isEQ, isGE, isGT, isLE, isLT, isNE

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.mutable.INumber

byteValue, shortValue

Constructor Detail

MutableBigDecimal

public MutableBigDecimal(long nValue)

MutableBigDecimal

public MutableBigDecimal(double dValue)

MutableBigDecimal

public MutableBigDecimal(@Nonnull
                         MutableBigDecimal aOther)

MutableBigDecimal

public MutableBigDecimal(@Nonnull
                         BigDecimal aValue)

Method Detail

getAsBigDecimal

@Nonnull
public BigDecimal getAsBigDecimal()

doubleValue

public double doubleValue()

Description copied from interface: INumber

Returns the value of the specified number as a double, which may involve rounding.

Specified by:

doubleValue in interface INumber

Specified by:

doubleValue in class Number

Returns:

the numeric value represented by this object after conversion to type double.

floatValue

public float floatValue()

Description copied from interface: INumber

Returns the value of the specified number as a float, which may involve rounding.

Specified by:

floatValue in interface INumber

Specified by:

floatValue in class Number

Returns:

the numeric value represented by this object after conversion to type float.

intValue

public int intValue()

Description copied from interface: INumber

Returns the value of the specified number as an int, which may involve rounding or truncation.

Specified by:

intValue in interface INumber

Specified by:

intValue in class Number

Returns:

the numeric value represented by this object after conversion to type int.

longValue

public long longValue()

Description copied from interface: INumber

Returns the value of the specified number as a long, which may involve rounding or truncation.

Specified by:

longValue in interface INumber

Specified by:

longValue in class Number

Returns:

the numeric value represented by this object after conversion to type long.

inc

@Nonnull
public BigDecimal inc()

Increment by 1 and return the modified value.

Returns:

The by 1 incremented value.

inc

@Nonnull
public BigDecimal inc(long nDelta)

inc

@Nonnull
public BigDecimal inc(double dDelta)

inc

@Nonnull
public BigDecimal inc(@Nonnull
                                MutableBigDecimal aDelta)

inc

@Nonnull
public BigDecimal inc(@Nonnull
                                BigDecimal aDelta)

dec

@Nonnull
public BigDecimal dec()

dec

@Nonnull
public BigDecimal dec(long nDelta)

dec

@Nonnull
public BigDecimal dec(double dDelta)

dec

@Nonnull
public BigDecimal dec(@Nonnull
                                BigDecimal aDelta)

dec

@Nonnull
public BigDecimal dec(@Nonnull
                                MutableBigDecimal aDelta)

divide

@Nonnull
public BigDecimal divide(long nDivisor,
                                   @Nonnegative
                                   int nScale,
                                   @Nonnull
                                   RoundingMode eRoundingMode)

divide

@Nonnull
public BigDecimal divide(double dDivisor,
                                   @Nonnegative
                                   int nScale,
                                   @Nonnull
                                   RoundingMode eRoundingMode)

divide

@Nonnull
public BigDecimal divide(@Nonnull
                                   MutableBigDecimal aDivisor,
                                   @Nonnegative
                                   int nScale,
                                   @Nonnull
                                   RoundingMode eRoundingMode)

divide

@Nonnull
public BigDecimal divide(@Nonnull
                                   BigDecimal aDivisor,
                                   @Nonnegative
                                   int nScale,
                                   @Nonnull
                                   RoundingMode eRoundingMode)

multiply

@Nonnull
public BigDecimal multiply(long nMultiplicand)

multiply

@Nonnull
public BigDecimal multiply(double dMultiplicand)

multiply

@Nonnull
public BigDecimal multiply(@Nonnull
                                     MutableBigDecimal aMultiplicand)

multiply

@Nonnull
public BigDecimal multiply(@Nonnull
                                     BigDecimal aMultiplicand)

set

@Nonnull
public EChange set(long nDelta)

set

@Nonnull
public EChange set(double dDelta)

set

@Nonnull
public EChange set(@Nonnull
                             MutableBigDecimal aValue)

set

@Nonnull
public EChange set(@Nonnull
                             BigDecimal aValue)

is0

public boolean is0()

Returns:

true if the value is 0

isLT0

public boolean isLT0()

Returns:

true if the value is < 0

isLE0

public boolean isLE0()

Returns:

true if the value is ≤ 0

isGT0

public boolean isGT0()

Returns:

true if the value is > 0

isGE0

public boolean isGE0()

Returns:

true if the value is ≥ 0

compareTo

public int compareTo(@Nonnull
                     MutableBigDecimal rhs)

getClone

@Nonnull
public MutableBigDecimal getClone()

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object