MutableLong (Agrona)

java.lang.Object
- java.lang.Number
- - org.agrona.collections.MutableLong

All Implemented Interfaces:

Serializable, Comparable<MutableLong>
```
public class MutableLong
extends Number
implements Comparable<MutableLong>
```
Holder for a long value that is mutable. Useful for being a counter in a Map or for passing by reference.

Field Summary

Fields
Modifier and Type Field and Description

long value
The value.

Fields
Modifier and Type	Field and Description
`long`	`value` The value.

Constructor Summary

Constructors
Constructor and Description

MutableLong()
Default constructor.

MutableLong(long value)
Creates an instance with a value.

Constructors
Constructor and Description
`MutableLong()` Default constructor.
`MutableLong(long value)` Creates an instance with a value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`addAndGet(long delta)` Add the `delta` and get the value.
`byte`	`byteValue()` Return value as `byte`.
`static int`	`compare(long lhs, long rhs)` Compare two long values.
`int`	`compareTo(MutableLong that)`
`void`	`decrement()` Decrement the value.
`long`	`decrementAndGet()` Decrement and get the value.
`double`	`doubleValue()` Return value as `double`.
`boolean`	`equals(Object o)`
`float`	`floatValue()` Return value as `float`.
`long`	`get()` Get the value.
`long`	`getAndAdd(long delta)` Get the value and add `delta` to it.
`long`	`getAndDecrement()` Get the value and decrement it.
`long`	`getAndIncrement()` Get and increment the value.
`int`	`hashCode()`
`void`	`increment()` Increment the value.
`long`	`incrementAndGet()` Increment and return the value.
`int`	`intValue()` Return value as `int`.
`long`	`longValue()` Return value as `long`.
`void`	`set(long value)` Set the value.
`short`	`shortValue()` Return value as `short`.
`String`	`toString()`

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

- Field Detail
  - value
```
public long value
```
    The value. Default value is 0.
- Constructor Detail
  - MutableLong
```
public MutableLong()
```
    Default constructor.
  - MutableLong
```
public MutableLong(long value)
```
    Creates an instance with a value.
    
    Parameters:
    
    value - to assign.
- Method Detail
  - get
```
public long get()
```
    Get the value.
    
    Returns:
    
    the value.
  - set
```
public void set(long value)
```
    Set the value.
    
    Parameters:
    
    value - to be assigned.
  - byteValue
```
public byte byteValue()
```
    Return value as byte.
    
    Overrides:
    
    byteValue in class Number
    
    Returns:
    
    value as byte.
  - shortValue
```
public short shortValue()
```
    Return value as short.
    
    Overrides:
    
    shortValue in class Number
    
    Returns:
    
    value as short.
  - intValue
```
public int intValue()
```
    Return value as int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    
    value as int.
  - longValue
```
public long longValue()
```
    Return value as long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    
    value as long.
  - floatValue
```
public float floatValue()
```
    Return value as float.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    
    value as float.
  - doubleValue
```
public double doubleValue()
```
    Return value as double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    
    value as double.
  - increment
```
public void increment()
```
    Increment the value.
  - incrementAndGet
```
public long incrementAndGet()
```
    Increment and return the value.
    
    Returns:
    
    the value after increment.
  - getAndIncrement
```
public long getAndIncrement()
```
    Get and increment the value.
    
    Returns:
    
    the value before increment.
  - decrement
```
public void decrement()
```
    Decrement the value.
  - decrementAndGet
```
public long decrementAndGet()
```
    Decrement and get the value.
    
    Returns:
    
    value after the decrement.
  - getAndDecrement
```
public long getAndDecrement()
```
    Get the value and decrement it.
    
    Returns:
    
    the value before the decrement.
  - getAndAdd
```
public long getAndAdd(long delta)
```
    Get the value and add delta to it.
    
    Parameters:
    
    delta - to add.
    
    Returns:
    
    the value before the change.
  - addAndGet
```
public long addAndGet(long delta)
```
    Add the delta and get the value.
    
    Parameters:
    
    delta - to add.
    
    Returns:
    
    the value after the change.
  - 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
  - compareTo
```
public int compareTo(MutableLong that)
```
    Specified by:
    
    compareTo in interface Comparable<MutableLong>
  - compare
```
public static int compare(long lhs,
                          long rhs)
```
    Compare two long values. Calling this method is equivalent to calling:
```
     Long.compare(lhs, rhs);
 
```
    Parameters:
    
    lhs - first value.
    
    rhs - second value.
    
    Returns:
    
    the value 0 if lhs == rhs; a value less than 0 if lhs < rhs; and a value greater than 0 if lhs > rhs

Class MutableLong

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

value

Constructor Detail

MutableLong

MutableLong

Method Detail

get

set

byteValue

shortValue

intValue

longValue

floatValue

doubleValue

increment

incrementAndGet

getAndIncrement

decrement

decrementAndGet

getAndDecrement

getAndAdd

addAndGet

equals

hashCode

toString

compareTo

compare