MutableLong (ph-commons 5.2.0 API)

java.lang.Object
- java.lang.Number
- - com.helger.commons.mutable.MutableLong

All Implemented Interfaces:

ICloneable<MutableLong>, IMutable<MutableLong>, IMutableInteger<MutableLong>, IMutableNumeric<MutableLong>, Serializable, Comparable<MutableLong>
```
@NotThreadSafe
public final class MutableLong
extends Number
implements IMutableInteger<MutableLong>
```
Object wrapper around a long 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 long DEFAULT_VALUE
The default value if the default constructor is used.

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

Constructor Summary

Constructors
Constructor and Description
`MutableLong()` Initialize with default value 0L.
`MutableLong(long nValue)` Initialize with a certain value.
`MutableLong(Long aValue)` Initialize with a certain value.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(MutableLong rhs)`
`long`	`dec()`
`long`	`dec(long nDelta)`
`double`	`doubleValue()`
`boolean`	`equals(Object o)`
`float`	`floatValue()`
`Long`	`getAsLong()`
`MutableLong`	`getClone()`
`int`	`hashCode()`
`long`	`inc()` Increment by 1 and return the modified value.
`long`	`inc(long nDelta)`
`int`	`intValue()`
`boolean`	`is0()`
`boolean`	`isEven()`
`boolean`	`isGreater0()`
`boolean`	`isGreaterOrEqual0()`
`boolean`	`isNot0()`
`boolean`	`isOdd()`
`boolean`	`isSmaller0()`
`boolean`	`isSmallerOrEqual0()`
`long`	`longValue()`
`EChange`	`set(long 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 long DEFAULT_VALUE
```
    The default value if the default constructor is used.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - MutableLong
```
public MutableLong()
```
    Initialize with default value 0L.
  - MutableLong
```
public MutableLong(@Nonnull
           Long aValue)
```
    Initialize with a certain value.
    
    Parameters:
    aValue - The value to be used.
  - MutableLong
```
public MutableLong(long nValue)
```
    Initialize with a certain value.
    
    Parameters:
    nValue - The value to be used.
- Method Detail
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class Number
  - getAsLong
```
@Nonnull
public Long getAsLong()
```
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class Number
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class Number
  - inc
```
public long inc()
```
    Increment by 1 and return the modified value.
    
    Returns:
    The by 1 incremented value.
  - inc
```
public long inc(long nDelta)
```
  - dec
```
public long dec()
```
  - dec
```
public long dec(long nDelta)
```
  - set
```
@Nonnull
public EChange set(long nValue)
```
  - is0
```
public boolean is0()
```
    Specified by:
    
    is0 in interface IMutableNumeric<MutableLong>
    
    Returns:
    true if the value is 0
  - isNot0
```
public boolean isNot0()
```
    Specified by:
    
    isNot0 in interface IMutableNumeric<MutableLong>
    
    Returns:
    true if the value is not 0
  - isSmaller0
```
public boolean isSmaller0()
```
    Specified by:
    
    isSmaller0 in interface IMutableNumeric<MutableLong>
    
    Returns:
    true if the value is < 0
  - isSmallerOrEqual0
```
public boolean isSmallerOrEqual0()
```
    Specified by:
    
    isSmallerOrEqual0 in interface IMutableNumeric<MutableLong>
    
    Returns:
    true if the value is ≤ 0
  - isGreater0
```
public boolean isGreater0()
```
    Specified by:
    
    isGreater0 in interface IMutableNumeric<MutableLong>
    
    Returns:
    true if the value is > 0
  - isGreaterOrEqual0
```
public boolean isGreaterOrEqual0()
```
    Specified by:
    
    isGreaterOrEqual0 in interface IMutableNumeric<MutableLong>
    
    Returns:
    true if the value is ≥ 0
  - isEven
```
public boolean isEven()
```
    Specified by:
    
    isEven in interface IMutableInteger<MutableLong>
    
    Returns:
    true if the value is even
  - isOdd
```
public boolean isOdd()
```
    Specified by:
    
    isOdd in interface IMutableInteger<MutableLong>
    
    Returns:
    true if the value is odd
  - compareTo
```
public int compareTo(@Nonnull
            MutableLong rhs)
```
    Specified by:
    
    compareTo in interface Comparable<MutableLong>
  - getClone
```
@Nonnull
public MutableLong getClone()
```
    Specified by:
    
    getClone in interface ICloneable<MutableLong>
    
    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 MutableLong

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

MutableLong

MutableLong

MutableLong

Method Detail

longValue

getAsLong

floatValue

doubleValue

intValue

inc

inc

dec

dec

set

is0

isNot0

isSmaller0

isSmallerOrEqual0

isGreater0

isGreaterOrEqual0

isEven

isOdd

compareTo

getClone

equals

hashCode

toString