com.phloc.commons.mutable

Class MutableBigDecimal

java.lang.Object

java.lang.Number

com.phloc.commons.mutable.MutableBigDecimal

All Implemented Interfaces:

ICloneable<MutableBigDecimal>, IMutable<MutableBigDecimal>, IMutableNumeric<MutableBigDecimal>, Serializable, Comparable<MutableBigDecimal>

@NotThreadSafe
public final class MutableBigDecimal
extends Number
implements IMutableNumeric<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
MutableBigDecimal(BigDecimal aValue)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MutableBigDecimal rhs)
BigDecimal	dec()
BigDecimal	dec(BigDecimal aDelta)
double	doubleValue()
boolean	equals(Object o)
float	floatValue()
BigDecimal	getAsBigDecimal()
Double	getAsDouble()
MutableBigDecimal	getClone()
int	hashCode()
BigDecimal	inc() Increment by 1 and return the modified value.
BigDecimal	inc(BigDecimal aDelta)
int	intValue()
boolean	is0()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isNot0()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
EChange	set(BigDecimal aValue)
String	toString()

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

MutableBigDecimal

public MutableBigDecimal(@Nonnull
                 BigDecimal aValue)

Method Detail

getAsBigDecimal

@Nonnull
public BigDecimal getAsBigDecimal()

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

getAsDouble

@Nonnull
public Double getAsDouble()

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(@Nonnull
                     BigDecimal aDelta)

dec

@Nonnull
public BigDecimal dec()

dec

@Nonnull
public BigDecimal dec(@Nonnull
                     BigDecimal aDelta)

set

@Nonnull
public EChange set(@Nonnull
                  BigDecimal aValue)

is0

public boolean is0()

Specified by:

is0 in interface IMutableNumeric<MutableBigDecimal>

Returns:

true if the value is 0

isNot0

public boolean isNot0()

Specified by:

isNot0 in interface IMutableNumeric<MutableBigDecimal>

Returns:

true if the value is not 0

isSmaller0

public boolean isSmaller0()

Specified by:

isSmaller0 in interface IMutableNumeric<MutableBigDecimal>

Returns:

true if the value is < 0

isSmallerOrEqual0

public boolean isSmallerOrEqual0()

Specified by:

isSmallerOrEqual0 in interface IMutableNumeric<MutableBigDecimal>

Returns:

true if the value is ≤ 0

isGreater0

public boolean isGreater0()

Specified by:

isGreater0 in interface IMutableNumeric<MutableBigDecimal>

Returns:

true if the value is > 0

isGreaterOrEqual0

public boolean isGreaterOrEqual0()

Specified by:

isGreaterOrEqual0 in interface IMutableNumeric<MutableBigDecimal>

Returns:

true if the value is ≥ 0

compareTo

public int compareTo(@Nonnull
            MutableBigDecimal rhs)

Specified by:

compareTo in interface Comparable<MutableBigDecimal>

getClone

@Nonnull
public MutableBigDecimal getClone()

Specified by:

getClone in interface ICloneable<MutableBigDecimal>

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