Class MutableLong

java.lang.Object
java.lang.Number
com.landawn.abacus.util.MutableLong
All Implemented Interfaces:
Mutable, Serializable, Comparable<MutableLong>

public final class MutableLong extends Number implements 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.

MutableLong is NOT thread-safe.

Since:
2.1
Version:
$Id: MutableLong.java 1669791 2015-03-28 15:22:59Z britter $
See Also:
  • Method Summary

    Modifier and Type
    Method
    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
    Compares this mutable to another in ascending order.
    void
    Decrements the value.
    long
    Decrements by one the current value.
    double
    Returns the value of this MutableLong as a double.
    boolean
    Compares this object to the specified object.
    float
    Returns the value of this MutableLong as a float.
    long
    getAndAdd(long delta)
    Adds the given value to the current value.
    long
    Decrements by one the current value.
    long
    Increments by one the current value.
    long
    getAndSet(long value)
    Gets the and set.
    long
    Deprecated.
    replace by value().
    int
    Returns a suitable hash code for this mutable.
    void
    Increments the value.
    long
    Increments by one the current value.
    int
    Returns the value of this MutableLong as an int.
    long
    Returns the value of this MutableLong as a long.
    of(long value)
     
    long
    setAndGet(long value)
    Sets the and get.
    <E extends Exception>
    boolean
    setIf(long newValue, Throwables.LongPredicate<E> predicate)
    Set with the specified new value and returns true if predicate returns true.
    void
    setValue(long value)
    Sets the value.
    void
    subtract(long operand)
    Subtracts a value from the value of this instance.
    Returns the String value of this mutable.
    long
     

    Methods inherited from class java.lang.Number

    byteValue, shortValue

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Method Details

    • of

      public static MutableLong of(long value)
      Parameters:
      value -
      Returns:
    • value

      public long value()
      Returns:
    • getValue

      @Deprecated public long getValue()
      Deprecated.
      replace by value().
      Gets the value as a Long instance.
      Returns:
    • setValue

      public void setValue(long value)
      Sets the value.
      Parameters:
      value - the value to set
    • getAndSet

      public long getAndSet(long value)
      Gets the and set.
      Parameters:
      value -
      Returns:
    • setAndGet

      public long setAndGet(long value)
      Sets the and get.
      Parameters:
      value -
      Returns:
    • setIf

      public <E extends Exception> boolean setIf(long newValue, Throwables.LongPredicate<E> predicate) throws E
      Set with the specified new value and returns true if predicate returns true. Otherwise just return false without setting the value to new value.
      Type Parameters:
      E -
      Parameters:
      newValue -
      predicate - - test the current value.
      Returns:
      Throws:
      E - the e
    • 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 long getAndIncrement()
      Increments by one the current value.
      Returns:
    • getAndDecrement

      public long getAndDecrement()
      Decrements by one the current value.
      Returns:
    • incrementAndGet

      public long incrementAndGet()
      Increments by one the current value.
      Returns:
    • decrementAndGet

      public long decrementAndGet()
      Decrements by one the current value.
      Returns:
    • getAndAdd

      public long getAndAdd(long delta)
      Adds the given value to the current value.
      Parameters:
      delta - the value to add
      Returns:
    • addAndGet

      public long addAndGet(long delta)
      Adds the given value to the current value.
      Parameters:
      delta - the value to add
      Returns:
    • intValue

      public int intValue()
      Returns the value of this MutableLong as an int.
      Specified by:
      intValue in class Number
      Returns:
    • longValue

      public long longValue()
      Returns the value of this MutableLong as a long.
      Specified by:
      longValue in class Number
      Returns:
    • floatValue

      public float floatValue()
      Returns the value of this MutableLong as a float.
      Specified by:
      floatValue in class Number
      Returns:
    • doubleValue

      public double doubleValue()
      Returns the value of this MutableLong as a double.
      Specified by:
      doubleValue in class Number
      Returns:
    • compareTo

      public int compareTo(MutableLong other)
      Compares this mutable to another in ascending order.
      Specified by:
      compareTo in interface 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(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 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 Object
      Returns:
      a suitable hash code
    • toString

      public String toString()
      Returns the String value of this mutable.
      Overrides:
      toString in class Object
      Returns: