Open Source Repository

Home /jodd/jodd-3.3.2 | Repository Home


jodd/mutable/MutableFloat.java
// Copyright (c) 2003-2012, Jodd Team (jodd.org). All Rights Reserved.

package jodd.mutable;

/**
 * A mutable <code>float</code> wrapper.
 */
public final class MutableFloat extends Number implements Comparable<MutableFloat>, Cloneable {

  public MutableFloat() {
  }

  public MutableFloat(float value) {
    this.value = value;
  }

  public MutableFloat(String value) {
    this.value = Float.parseFloat(value);
  }

  public MutableFloat(Number number) {
    this.value = number.floatValue();
  }

  // ---------------------------------------------------------------- value

  /**
   * The mutable value.
   */
  public float value;

  /**
   * Returns mutable value.
   */
  public float getValue() {
    return value;
  }

  /**
   * Sets mutable value.
   */
  public void setValue(float value) {
    this.value = value;
  }

  /**
   * Sets mutable value from a Number.
   */
  public void setValue(Number value) {
    this.value = value.floatValue();
  }

  // ---------------------------------------------------------------- object

  /**
   * Stringify the value.
   */
  @Override
  public String toString() {
    return Float.toString(value);
  }

  /**
   * Returns a hashcode for this value.
   */
  @Override
  public int hashCode() {
    return  Float.floatToIntBits(value);
  }

  /**
   * Compares this object to the specified object.
   *
   @param obj the object to compare with.
   @return <code>true</code> if the objects are the same;
   *         <code>false</code> otherwise.
   */
  @Override
  public boolean equals(Object obj) {
    if (obj != null) {
      if (obj instanceof Float) {
        return Float.floatToIntBits(value== Float.floatToIntBits(((Floatobj).floatValue());
      }
      if (obj instanceof MutableFloat) {
        return Float.floatToIntBits(value== Float.floatToIntBits(((MutableFloatobj).value);
      }
    }
    return false;
  }

  // ---------------------------------------------------------------- number

  /**
   * Returns the value as a int.
   */
  @Override
  public int intValue() {
    return (intvalue;
  }

  /**
   * Returns the value as a long.
   */
  @Override
  public long longValue() {
    return (longvalue;
  }

  /**
   * Returns the value as a float.
   */
  @Override
  public float floatValue() {
    return value;
  }

  /**
   * Returns the value as a double.
   */
  @Override
  public double doubleValue() {
    return value;
  }

  // ---------------------------------------------------------------- compare

  /**
   * Checks whether the value is the special NaN value.
   */
  public boolean isNaN() {
    return Float.isNaN(value);
  }

  /**
   * Checks whether the float value is infinite.
   */
  public boolean isInfinite() {
    return Float.isInfinite(value);
  }

  /**
   * Compares value of two same instances.
   */
  public int compareTo(MutableFloat other) {
    return Float.compare(value, other.value);
  }

  // ---------------------------------------------------------------- clone

  /**
   * Clones object.
   */
  @Override
  public MutableFloat clone() {
    return new MutableFloat(value);
  }

}