Package 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:

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

@NotThreadSafe
public 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

Constructor Summary

Constructors

Constructor	Description
MutableBigInteger(long nValue)
MutableBigInteger(MutableBigInteger aOther)
MutableBigInteger(BigInteger aValue)

Method Summary

Modifier and Type	Method	Description
int	compareTo(MutableBigInteger rhs)
BigInteger	dec()
BigInteger	dec(long nDelta)
BigInteger	dec(MutableBigInteger aDelta)
BigInteger	dec(BigInteger aDelta)
BigInteger	divide(long nDivisor)
BigInteger	divide(MutableBigInteger aDivisor)
BigInteger	divide(BigInteger aDivisor)
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.
BigInteger	getAndInc()
BigDecimal	getAsBigDecimal()
BigInteger	getAsBigInteger()
MutableBigInteger	getClone()
int	hashCode()
BigInteger	inc()	Increment by 1 and return the modified value.
BigInteger	inc(long nDelta)
BigInteger	inc(MutableBigInteger aDelta)
BigInteger	inc(BigInteger aDelta)
BigInteger	incAndGet()
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.
BigInteger	multiply(long nMultiplicand)
BigInteger	multiply(MutableBigInteger aMultiplicand)
BigInteger	multiply(BigInteger aMultiplicand)
EChange	set(long nDelta)
EChange	set(MutableBigInteger aValue)
EChange	set(BigInteger 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.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.IMutableNumeric

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

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

byteValue, shortValue

Constructor Detail

MutableBigInteger

public MutableBigInteger(long nValue)

MutableBigInteger

public MutableBigInteger(@Nonnull
                         MutableBigInteger aOther)

MutableBigInteger

public MutableBigInteger(@Nonnull
                         BigInteger aValue)

Method Detail

getAsBigDecimal

@Nonnull
public BigDecimal getAsBigDecimal()

getAsBigInteger

@Nonnull
public BigInteger getAsBigInteger()

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

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

getAndInc

@Nonnull
public BigInteger getAndInc()

incAndGet

@Nonnull
public BigInteger incAndGet()

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