com.helger.commons.mutable

Class MutableBigInteger

java.lang.Object

java.lang.Number

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

com.helger.commons.mutable.MutableBigInteger

All Implemented Interfaces:

ICloneable<MutableBigInteger>, IMutableNumeric<MutableBigInteger>, IMutableObject<MutableBigInteger>, Serializable, Comparable<MutableBigInteger>

@NotThreadSafe
public final class MutableBigInteger
extends AbstractMutableNumeric<MutableBigInteger>

Object wrapper around a BigInteger 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 BigInteger	DEFAULT_VALUE The default value if the default constructor is used.

Constructor Summary

Constructors

Constructor and Description
MutableBigInteger() Initialize with default value DEFAULT_VALUE
MutableBigInteger(BigInteger aValue)
MutableBigInteger(long nValue)
MutableBigInteger(MutableBigInteger aOther)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MutableBigInteger rhs)
BigInteger	dec()
BigInteger	dec(BigInteger aDelta)
BigInteger	dec(long nDelta)
BigInteger	dec(MutableBigInteger aDelta)
BigInteger	divide(BigInteger aDivisor)
BigInteger	divide(long nDivisor)
BigInteger	divide(MutableBigInteger aDivisor)
double	doubleValue()
boolean	equals(Object o)
float	floatValue()
BigDecimal	getAsBigDecimal()
BigInteger	getAsBigInteger()
MutableBigInteger	getClone()
int	hashCode()
BigInteger	inc() Increment by 1 and return the modified value.
BigInteger	inc(BigInteger aDelta)
BigInteger	inc(long nDelta)
BigInteger	inc(MutableBigInteger aDelta)
int	intValue()
boolean	is0()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isNot0()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
BigInteger	multiply(BigInteger aMultiplicand)
BigInteger	multiply(long nMultiplicand)
BigInteger	multiply(MutableBigInteger aMultiplicand)
EChange	set(BigInteger aValue)
EChange	set(long nDelta)
EChange	set(MutableBigInteger aValue)
String	toString()

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

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

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 BigInteger DEFAULT_VALUE

The default value if the default constructor is used.

Constructor Detail

MutableBigInteger

public MutableBigInteger()

Initialize with default value DEFAULT_VALUE

MutableBigInteger

public MutableBigInteger(long nValue)

MutableBigInteger

public MutableBigInteger(@Nonnull
                 MutableBigInteger aOther)

MutableBigInteger

public MutableBigInteger(@Nonnull
                 BigInteger aValue)

Method Detail

getAsBigDecimal

@Nonnull
public BigDecimal getAsBigDecimal()

Overrides:

getAsBigDecimal in class AbstractMutableNumeric<MutableBigInteger>

getAsBigInteger

@Nonnull
public BigInteger getAsBigInteger()

Overrides:

getAsBigInteger in class AbstractMutableNumeric<MutableBigInteger>

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

Increment by 1 and return the modified value.

Returns:

The by 1 incremented value.

inc

@Nonnull
public BigInteger inc(long nDelta)

inc

@Nonnull
public BigInteger inc(@Nonnull
                     MutableBigInteger aDelta)

inc

@Nonnull
public BigInteger inc(@Nonnull
                     BigInteger aDelta)

dec

@Nonnull
public BigInteger dec()

dec

@Nonnull
public BigInteger dec(long nDelta)

dec

@Nonnull
public BigInteger dec(@Nonnull
                     MutableBigInteger aDelta)

dec

@Nonnull
public BigInteger dec(@Nonnull
                     BigInteger aDelta)

divide

@Nonnull
public BigInteger divide(long nDivisor)

divide

@Nonnull
public BigInteger divide(@Nonnull
                        MutableBigInteger aDivisor)

divide

@Nonnull
public BigInteger divide(@Nonnull
                        BigInteger aDivisor)

multiply

@Nonnull
public BigInteger multiply(long nMultiplicand)

multiply

@Nonnull
public BigInteger multiply(@Nonnull
                          MutableBigInteger aMultiplicand)

multiply

@Nonnull
public BigInteger multiply(@Nonnull
                          BigInteger aMultiplicand)

set

@Nonnull
public EChange set(long nDelta)

set

@Nonnull
public EChange set(@Nonnull
                  MutableBigInteger aValue)

set

@Nonnull
public EChange set(@Nonnull
                  BigInteger 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
            MutableBigInteger rhs)

getClone

@Nonnull
public MutableBigInteger 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