MutableInt (phloc-commons 4.4.4 API)

java.lang.Object
- java.lang.Number
- - com.phloc.commons.mutable.MutableInt

All Implemented Interfaces:

ICloneable<MutableInt>, IMutable<MutableInt>, IMutableInteger<MutableInt>, IMutableNumeric<MutableInt>, Serializable, Comparable<MutableInt>
```
@NotThreadSafe
public final class MutableInt
extends Number
implements IMutableInteger<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.

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(Integer aValue)` Initialize with a certain value.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(MutableInt rhs)`
`int`	`dec()`
`int`	`dec(int nDelta)`
`double`	`doubleValue()`
`boolean`	`equals(Object o)`
`float`	`floatValue()`
`Integer`	`getAsInteger()`
`MutableInt`	`getClone()`
`int`	`hashCode()`
`int`	`inc()` Increment by 1 and return the modified value.
`int`	`inc(int nDelta)`
`int`	`intValue()`
`boolean`	`is0()`
`boolean`	`isEven()`
`boolean`	`isGreater0()`
`boolean`	`isGreaterOrEqual0()`
`boolean`	`isNot0()`
`boolean`	`isOdd()`
`boolean`	`isSmaller0()`
`boolean`	`isSmallerOrEqual0()`
`long`	`longValue()`
`EChange`	`set(int nValue)`
`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 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
          Integer 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
  - getAsInteger
```
@Nonnull
public Integer getAsInteger()
```
  - 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)
```
  - dec
```
public int dec()
```
  - dec
```
public int dec(int nDelta)
```
  - set
```
@Nonnull
public EChange set(int nValue)
```
  - is0
```
public boolean is0()
```
    Specified by:
    
    is0 in interface IMutableNumeric<MutableInt>
    
    Returns:
    true if the value is 0
  - isNot0
```
public boolean isNot0()
```
    Specified by:
    
    isNot0 in interface IMutableNumeric<MutableInt>
    
    Returns:
    true if the value is not 0
  - isSmaller0
```
public boolean isSmaller0()
```
    Specified by:
    
    isSmaller0 in interface IMutableNumeric<MutableInt>
    
    Returns:
    true if the value is < 0
  - isSmallerOrEqual0
```
public boolean isSmallerOrEqual0()
```
    Specified by:
    
    isSmallerOrEqual0 in interface IMutableNumeric<MutableInt>
    
    Returns:
    true if the value is ≤ 0
  - isGreater0
```
public boolean isGreater0()
```
    Specified by:
    
    isGreater0 in interface IMutableNumeric<MutableInt>
    
    Returns:
    true if the value is > 0
  - isGreaterOrEqual0
```
public boolean isGreaterOrEqual0()
```
    Specified by:
    
    isGreaterOrEqual0 in interface IMutableNumeric<MutableInt>
    
    Returns:
    true if the value is ≥ 0
  - isEven
```
public boolean isEven()
```
    Specified by:
    
    isEven in interface IMutableInteger<MutableInt>
    
    Returns:
    true if the value is even
  - isOdd
```
public boolean isOdd()
```
    Specified by:
    
    isOdd in interface IMutableInteger<MutableInt>
    
    Returns:
    true if the value is odd
  - compareTo
```
public int compareTo(@Nonnull
            MutableInt rhs)
```
    Specified by:
    
    compareTo in interface Comparable<MutableInt>
  - getClone
```
@Nonnull
public MutableInt getClone()
```
    Specified by:
    
    getClone in interface ICloneable<MutableInt>
    
    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

Class MutableInt

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_VALUE

Constructor Detail

MutableInt

MutableInt

MutableInt

Method Detail

intValue

getAsInteger

floatValue

doubleValue

longValue

inc

inc

dec

dec

set

is0

isNot0

isSmaller0

isSmallerOrEqual0

isGreater0

isGreaterOrEqual0

isEven

isOdd

compareTo

getClone

equals

hashCode

toString