Package org.agrona.collections
Class MutableLong
- java.lang.Object
-
- java.lang.Number
-
- org.agrona.collections.MutableLong
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<MutableLong>
public class MutableLong extends java.lang.Number implements java.lang.Comparable<MutableLong>
Holder for a long value that is mutable. Useful for being a counter in aMap
or for passing by reference.
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
long
value
The value.
-
Constructor Summary
Constructors Constructor 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 Description long
addAndGet(long delta)
Add thedelta
and get the value.byte
byteValue()
Return value asbyte
.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 asdouble
.boolean
equals(java.lang.Object o)
float
floatValue()
Return value asfloat
.long
get()
Get the value.long
getAndAdd(long delta)
Get the value and adddelta
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 asint
.long
longValue()
Return value aslong
.void
set(long value)
Set the value.short
shortValue()
Return value asshort
.java.lang.String
toString()
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
value
public long value
The value. Default value is0
.
-
-
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 asbyte
.- Overrides:
byteValue
in classjava.lang.Number
- Returns:
- value as
byte
.
-
shortValue
public short shortValue()
Return value asshort
.- Overrides:
shortValue
in classjava.lang.Number
- Returns:
- value as
short
.
-
intValue
public int intValue()
Return value asint
.- Specified by:
intValue
in classjava.lang.Number
- Returns:
- value as
int
.
-
longValue
public long longValue()
Return value aslong
.- Specified by:
longValue
in classjava.lang.Number
- Returns:
- value as
long
.
-
floatValue
public float floatValue()
Return value asfloat
.- Specified by:
floatValue
in classjava.lang.Number
- Returns:
- value as
float
.
-
doubleValue
public double doubleValue()
Return value asdouble
.- Specified by:
doubleValue
in classjava.lang.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 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
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(MutableLong that)
- Specified by:
compareTo
in interfacejava.lang.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
iflhs == rhs
; a value less than0
iflhs < rhs
; and a value greater than0
iflhs > rhs
-
-