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:

ICloneable<MutableBigDecimal>, IMutableNumeric<MutableBigDecimal>, IMutableObject<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

Field Summary

Fields

Modifier and Type	Field and Description
static BigDecimal	DEFAULT_VALUE The default value if the default constructor is used.

Constructor Summary

Constructors

Constructor and Description
MutableBigDecimal() Initialize with default value DEFAULT_VALUE
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()
boolean	equals(Object o)
float	floatValue()
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()
boolean	is0()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isNot0()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
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

getAsBigInteger, getAsByte, getAsCharacter, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsShort, 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

Field Detail

DEFAULT_VALUE

public static final BigDecimal DEFAULT_VALUE

The default value if the default constructor is used.

Constructor Detail

MutableBigDecimal

public MutableBigDecimal()

Initialize with default value DEFAULT_VALUE

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()

Overrides:

getAsBigDecimal in class AbstractMutableNumeric<MutableBigDecimal>

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

floatValue

public float floatValue()

Specified by:

floatValue in class Number

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

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

isNot0

public boolean isNot0()

Returns:

true if the value is not 0

isSmaller0

public boolean isSmaller0()

Returns:

true if the value is < 0

isSmallerOrEqual0

public boolean isSmallerOrEqual0()

Returns:

true if the value is ≤ 0

isGreater0

public boolean isGreater0()

Returns:

true if the value is > 0

isGreaterOrEqual0

public boolean isGreaterOrEqual0()

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