com.helger.commons.mutable

Class MutableInt

java.lang.Object

java.lang.Number

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

com.helger.commons.mutable.AbstractMutableInteger<MutableInt>

com.helger.commons.mutable.MutableInt

All Implemented Interfaces:

IComparable<MutableInt>, ICloneable<MutableInt>, IMutableInteger<MutableInt>, IMutableNumeric<MutableInt>, IMutableObject<MutableInt>, INumber, IGenericImplTrait<MutableInt>, Serializable, Comparable<MutableInt>

@NotThreadSafe
public class MutableInt
extends AbstractMutableInteger<MutableInt>

Object wrapper around an int 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
MutableInt(int nValue) Initialize with a certain value.
MutableInt(Number aValue) Initialize with a certain value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(MutableInt rhs)
int	dec()
int	dec(int nDelta)
int	dec(Number aDelta)
int	divide(int nDivisor)
int	divide(Number 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.
MutableInt	getClone()
int	hashCode()
int	inc() Increment by 1 and return the modified value.
int	inc(int nDelta)
int	inc(Number aDelta)
int	intValue() Returns the value of the specified number as an int, which may involve rounding or truncation.
boolean	is0()
boolean	isEven()
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.
int	multiply(int nMultiplicand)
int	multiply(Number aMultiplicand)
EChange	set(int nValue)
EChange	set(Number 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.IMutableInteger

isOdd

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

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

MutableInt

public MutableInt(@Nonnull
                  Number aValue)

Initialize with a certain value.

Parameters:

aValue - The value to be used.

MutableInt

public MutableInt(int nValue)

Initialize with a certain value.

Parameters:

nValue - The value to be used.

Method Detail

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.

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.

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.

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

public int inc()

Increment by 1 and return the modified value.

Returns:

The by 1 incremented value.

inc

public int inc(int nDelta)

inc

public int inc(@Nonnull
               Number aDelta)

dec

public int dec()

dec

public int dec(int nDelta)

dec

public int dec(@Nonnull
               Number aDelta)

divide

public int divide(int nDivisor)

divide

public int divide(@Nonnull
                  Number aDivisor)

multiply

public int multiply(int nMultiplicand)

multiply

public int multiply(@Nonnull
                    Number aMultiplicand)

set

@Nonnull
public EChange set(int nValue)

set

@Nonnull
public EChange set(@Nonnull
                             Number 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

isEven

public boolean isEven()

Returns:

true if the value is even

compareTo

public int compareTo(@Nonnull
                     MutableInt rhs)

getClone

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