Package org.agrona.collections
Class MutableLong
java.lang.Object
java.lang.Number
org.agrona.collections.MutableLong
- All Implemented Interfaces:
Serializable
,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
FieldsModifier and TypeFieldDescriptionprivate static final long
long
The value. -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.MutableLong
(long value) Creates an instance with a value. -
Method Summary
Modifier and TypeMethodDescriptionlong
addAndGet
(long delta) Add thedelta
and get the value.byte
Return value asbyte
.static int
compare
(long lhs, long rhs) Compare two long values.int
compareTo
(MutableLong that) void
Decrement the value.long
Decrement and get the value.double
Return value asdouble
.boolean
float
Return value asfloat
.long
get()
Get the value.long
getAndAdd
(long delta) Get the value and adddelta
to it.long
Get the value and decrement it.long
Get and increment the value.int
hashCode()
void
Increment the value.long
Increment and return the value.int
intValue()
Return value asint
.long
Return value aslong
.void
set
(long value) Set the value.short
Return value asshort
.toString()
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
value
public long valueThe value. Default value is0
.
-
-
Constructor Details
-
MutableLong
public MutableLong()Default constructor. -
MutableLong
public MutableLong(long value) Creates an instance with a value.- Parameters:
value
- to assign.
-
-
Method Details
-
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 asbyte
. -
shortValue
public short shortValue()Return value asshort
.- Overrides:
shortValue
in classNumber
- Returns:
- value as
short
.
-
intValue
public int intValue()Return value asint
. -
longValue
public long longValue()Return value aslong
. -
floatValue
public float floatValue()Return value asfloat
.- Specified by:
floatValue
in classNumber
- Returns:
- value as
float
.
-
doubleValue
public double doubleValue()Return value asdouble
.- Specified by:
doubleValue
in classNumber
- 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 adddelta
to it.- Parameters:
delta
- to add.- Returns:
- the value before the change.
-
addAndGet
public long addAndGet(long delta) Add thedelta
and get the value.- Parameters:
delta
- to add.- Returns:
- the value after the change.
-
equals
-
hashCode
public int hashCode() -
toString
-
compareTo
- Specified by:
compareTo
in interfaceComparable<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
iflhs == rhs
; a value less than0
iflhs < rhs
; and a value greater than0
iflhs > rhs
-