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:

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MutableInt() Initialize with default value 0.
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()
boolean	equals(Object o)
float	floatValue()
MutableInt	getClone()
int	hashCode()
int	inc() Increment by 1 and return the modified value.
int	inc(int nDelta)
int	inc(Number aDelta)
int	intValue()
boolean	is0()
boolean	isEven()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
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

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

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.traits.IGenericImplTrait

thisAsT

Field Detail

DEFAULT_VALUE

public static final int DEFAULT_VALUE

The default value if the default constructor is used.

See Also:

Constant Field Values

Constructor Detail

MutableInt

public MutableInt()

Initialize with default value 0.

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

Specified by:

intValue in class Number

floatValue

public float floatValue()

Specified by:

floatValue in class Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

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

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

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