MutableLong (abacus API Documentation)

java.lang.Object
- java.lang.Number
- - com.landawn.abacus.util.MutableLong

All Implemented Interfaces:

Mutable, java.io.Serializable, java.lang.Comparable<MutableLong>
```
public final class MutableLong
extends java.lang.Number
implements java.lang.Comparable<MutableLong>, Mutable
```
Note: it's copied from Apache Commons Lang developed at The Apache Software Foundation (http://www.apache.org/), or under the Apache License 2.0. The methods copied from other products/frameworks may be modified in this class.
A mutable long wrapper.
Note that as MutableLong does not extend Long, it is not treated by String.format as a Long parameter.

Since:

2.1

Version:

$Id: MutableLong.java 1669791 2015-03-28 15:22:59Z britter $

See Also:

Long, Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(long operand)` Adds a value to the value of this instance.
`long`	`addAndGet(long delta)` Adds the given value to the current value.
`int`	`compareTo(MutableLong other)` Compares this mutable to another in ascending order.
`void`	`decrement()` Decrements the value.
`long`	`decrementAndGet()` Decrements by one the current value.
`double`	`doubleValue()` Returns the value of this MutableLong as a double.
`boolean`	`equals(java.lang.Object obj)` Compares this object to the specified object.
`float`	`floatValue()` Returns the value of this MutableLong as a float.
`long`	`getAndAdd(long delta)` Adds the given value to the current value.
`long`	`getAndDecrement()` Decrements by one the current value.
`long`	`getAndIncrement()` Increments by one the current value.
`long`	`getAndSet(long value)`
`long`	`getValue()` Gets the value as a Long instance.
`int`	`hashCode()` Returns a suitable hash code for this mutable.
`void`	`increment()` Increments the value.
`long`	`incrementAndGet()` Increments by one the current value.
`int`	`intValue()` Returns the value of this MutableLong as an int.
`long`	`longValue()` Returns the value of this MutableLong as a long.
`static MutableLong`	`of(long value)`
`long`	`setAndGet(long value)`
`<E extends java.lang.Exception> boolean`	`setIf(long newValue, Try.LongBiPredicate<E> predicate)` Set with the specified new value and returns `true` if `predicate` returns true.
`<E extends java.lang.Exception> boolean`	`setIf(long newValue, Try.LongPredicate<E> predicate)` Set with the specified new value and returns `true` if `predicate` returns true.
`MutableLong`	`setValue(long value)` Sets the value.
`void`	`subtract(long operand)` Subtracts a value from the value of this instance.
`java.lang.String`	`toString()` Returns the String value of this mutable.
`long`	`value()`

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static MutableLong of(long value)
```
  - value
```
public long value()
```
  - getValue
```
public long getValue()
```
    Gets the value as a Long instance.
    
    Returns:
    
    the value as a Long, never null
  - setValue
```
public MutableLong setValue(long value)
```
    Sets the value.
    
    Parameters:
    
    value - the value to set
  - getAndSet
```
public long getAndSet(long value)
```
  - setAndGet
```
public long setAndGet(long value)
```
  - setIf
```
public <E extends java.lang.Exception> boolean setIf(long newValue,
                                                     Try.LongPredicate<E> predicate)
                                              throws E extends java.lang.Exception
```
    Set with the specified new value and returns true if predicate returns true. Otherwise just return false without setting the value to new value.
    
    Parameters:
    
    newValue -
    
    predicate - - test the current value.
    
    Returns:
    
    Throws:
    
    E extends java.lang.Exception
  - setIf
```
public <E extends java.lang.Exception> boolean setIf(long newValue,
                                                     Try.LongBiPredicate<E> predicate)
                                              throws E extends java.lang.Exception
```
    Set with the specified new value and returns true if predicate returns true. Otherwise just return false without setting the value to new value.
    
    Parameters:
    
    newValue -
    
    predicate - the first parameter is the current value, the second parameter is the new value.
    
    Returns:
    
    Throws:
    
    E extends java.lang.Exception
  - increment
```
public void increment()
```
    Increments the value.
    
    Since:
    
    Commons Lang 2.2
  - decrement
```
public void decrement()
```
    Decrements the value.
    
    Since:
    
    Commons Lang 2.2
  - add
```
public void add(long operand)
```
    Adds a value to the value of this instance.
    
    Parameters:
    
    operand - the value to add, not null
    
    Since:
    
    Commons Lang 2.2
  - subtract
```
public void subtract(long operand)
```
    Subtracts a value from the value of this instance.
    
    Parameters:
    
    operand - the value to subtract, not null
    
    Since:
    
    Commons Lang 2.2
  - getAndIncrement
```
public final long getAndIncrement()
```
    Increments by one the current value.
    
    Returns:
    
    the previous value
  - getAndDecrement
```
public final long getAndDecrement()
```
    Decrements by one the current value.
    
    Returns:
    
    the previous value
  - incrementAndGet
```
public final long incrementAndGet()
```
    Increments by one the current value.
    
    Returns:
    
    the updated value
  - decrementAndGet
```
public final long decrementAndGet()
```
    Decrements by one the current value.
    
    Returns:
    
    the updated value
  - getAndAdd
```
public final long getAndAdd(long delta)
```
    Adds the given value to the current value.
    
    Parameters:
    
    delta - the value to add
    
    Returns:
    
    the previous value
  - addAndGet
```
public final long addAndGet(long delta)
```
    Adds the given value to the current value.
    
    Parameters:
    
    delta - the value to add
    
    Returns:
    
    the updated value
  - intValue
```
public int intValue()
```
    Returns the value of this MutableLong as an int.
    
    Specified by:
    
    intValue in class java.lang.Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type int.
  - longValue
```
public long longValue()
```
    Returns the value of this MutableLong as a long.
    
    Specified by:
    
    longValue in class java.lang.Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type long.
  - floatValue
```
public float floatValue()
```
    Returns the value of this MutableLong as a float.
    
    Specified by:
    
    floatValue in class java.lang.Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type float.
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this MutableLong as a double.
    
    Specified by:
    
    doubleValue in class java.lang.Number
    
    Returns:
    
    the numeric value represented by this object after conversion to type double.
  - compareTo
```
public int compareTo(MutableLong other)
```
    Compares this mutable to another in ascending order.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<MutableLong>
    
    Parameters:
    
    other - the other mutable to compare to, not null
    
    Returns:
    
    negative if this is less, zero if equal, positive if greater
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compares this object to the specified object. The result is true if and only if the argument is not null and is a MutableLong object that contains the same long value as this object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to compare with, null returns false
    
    Returns:
    
    true if the objects are the same; false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns a suitable hash code for this mutable.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a suitable hash code
  - toString
```
public java.lang.String toString()
```
    Returns the String value of this mutable.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the mutable value as a string

Class MutableLong

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Method Detail

of

value

getValue

setValue

getAndSet

setAndGet

setIf

setIf

increment

decrement

add

subtract

getAndIncrement

getAndDecrement

incrementAndGet

decrementAndGet

getAndAdd

addAndGet

intValue

longValue

floatValue

doubleValue

compareTo

equals

hashCode

toString