Package com.landawn.abacus.util

Class MutableDouble

java.lang.Object
java.lang.Number
com.landawn.abacus.util.MutableDouble
All Implemented Interfaces:
Mutable, Serializable, Comparable<MutableDouble>
public final class MutableDouble extends Number implements Comparable<MutableDouble>, 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 double wrapper.

Note that as MutableDouble does not extend Double, it is not treated by String.format as a Double parameter.

MutableDouble is NOT thread-safe.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(double operand)
    Adds a value to the value of this instance.
    double
    addAndGet(double delta)
    Adds the given value to the current value.
    int
    compareTo(MutableDouble other)
    Compares this mutable to another in ascending order.
    void
    decrement()
    Decrements the value.
    double
    decrementAndGet()
    Decrements by one the current value.
    double
    doubleValue()
    Returns the value of this MutableDouble as a double.
    boolean
    equals(Object obj)
    Compares this object against the specified object.
    float
    floatValue()
    Returns the value of this MutableDouble as a float.
    double
    getAndAdd(double delta)
    Adds the given value to the current value.
    double
    getAndDecrement()
    Decrements by one the current value.
    double
    getAndIncrement()
    Increments by one the current value.
    double
    getAndSet(double value)
    Gets the and set.
    double
    getValue()
    Deprecated.
    replace by value().
    int
    hashCode()
    Returns a suitable hash code for this mutable.
    void
    increment()
    Increments the value.
    double
    incrementAndGet()
    Increments by one the current value.
    int
    intValue()
    Returns the value of this MutableDouble as an int.
    boolean
    isInfinite()
    Checks whether the double value is infinite.
    boolean
    isNaN()
    Checks whether the double value is the special NaN value.
    long
    longValue()
    Returns the value of this MutableDouble as a long.
    static MutableDouble
    of(double value)
     
    double
    setAndGet(double value)
    Sets the and get.
    <E extends Exception>
    boolean
    setIf(double newValue, Throwables.DoublePredicate<E> predicate)
    Set with the specified new value and returns true if predicate returns true.
    void
    setValue(double value)
    Sets the value.
    void
    subtract(double operand)
    Subtracts a value from the value of this instance.
    String
    toString()
    Returns the String value of this mutable.
    double
    value()
     

    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 MutableDouble of(double value)
      Parameters:
      value -
      Returns:

    • value

      public double value()

    • getValue

      @Deprecated public double getValue()
      Deprecated.
      replace by value().
      Gets the value as a Double instance.
      Returns:

    • setValue

      public void setValue(double value)
      Sets the value.
      Parameters:
      value - the value to set

    • getAndSet

      public double getAndSet(double value)
      Gets the and set.
      Parameters:
      value -
      Returns:

    • setAndGet

      public double setAndGet(double value)
      Sets the and get.
      Parameters:
      value -
      Returns:

    • setIf

      public <E extends Exception> boolean setIf(double newValue, Throwables.DoublePredicate<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

    • isNaN

      public boolean isNaN()
      Checks whether the double value is the special NaN value.
      Returns:
      true if NaN

    • isInfinite

      public boolean isInfinite()
      Checks whether the double value is infinite.
      Returns:
      true if infinite

    • 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(double operand)
      Adds a value to the value of this instance.
      Parameters:
      operand - the value to add
      Since:
      Commons Lang 2.2

    • subtract

      public void subtract(double 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 double getAndIncrement()
      Increments by one the current value.
      Returns:

    • getAndDecrement

      public double getAndDecrement()
      Decrements by one the current value.
      Returns:

    • incrementAndGet

      public double incrementAndGet()
      Increments by one the current value.
      Returns:

    • decrementAndGet

      public double decrementAndGet()
      Decrements by one the current value.
      Returns:

    • getAndAdd

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

    • addAndGet

      public double addAndGet(double 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 MutableDouble as an int.
      Specified by:
      intValue in class Number
      Returns:

    • longValue

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

    • floatValue

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

    • doubleValue

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

    • compareTo

      public int compareTo(MutableDouble other)
      Compares this mutable to another in ascending order.
      Specified by:
      compareTo in interface Comparable<MutableDouble>
      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 against the specified object. The result is true if and only if the argument is not null and is a Double object that represents a double that has the identical bit pattern to the bit pattern of the double represented by this object. For this purpose, two double values are considered to be the same if and only if the method Double.doubleToLongBits(double)returns the same long value when applied to each.

      Note that in most cases, for two instances of class Double,d1 and d2, the value of d1.equals(d2) is true if and only if 

         d1.doubleValue() == d2.doubleValue()

      also has the value true. However, there are two exceptions:

      • If d1 and d2 both represent Double.NaN, then the equals method returns true, even though Double.NaN==Double.NaN has the value false.
      • If d1 represents +0.0 while d2 represents -0.0, or vice versa, the equal test has the value false, even though +0.0==-0.0 has the value true. This allows hashtables to operate properly.
      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: