MutableNumber.java

package com.osroyale.util;
 
import java.util.concurrent.atomic.AtomicInteger;

 
* The container class that contains functions to simplify the modification of a
 * number.
 * <p>
 * <p>
 * This class is similar in functionality to {@link AtomicInteger} but does not
 * support atomic operations, and therefore should not be used across multiple
 * threads.
 *
 * @author lare96 <http://github.com/lare96>
 */
public final class MutableNumber extends Number implements Comparable<MutableNumber> {

    private static final long serialVersionUID = -7475363158492415879L;

    private int value;

    public MutableNumber(int value) {
        this.value = value;
    }

    public MutableNumber() {
        this(0);
    }
 
    @Override
    public String toString() {
        return Integer.toString(value);
    }
 
    @Override
    public int hashCode() {
        return Integer.hashCode(value);
    }
 
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (!(obj instanceof MutableNumber))
            return false;
        MutableNumber other = (MutableNumber) obj;
        return value == other.value;
    }
 
    @Override
    public int compareTo(MutableNumber o) {
        return Integer.compare(value, o.value);
    }

    @Override
    public int intValue() {
        return value;
    }
 
    @Override
    public long longValue() {
        return (long) value;
    }
 
    @Override
    public float floatValue() {
        return (float) value;
    }
 
    @Override
    public double doubleValue() {
        return (double) value;
    }

    public int getAndIncrement(int amount, int maximum) {
        int val = value;
        value += amount;
        if (value > maximum)
            value = maximum;
        return val;
    }

    public int getAndIncrement(int amount) {
        return getAndIncrement(amount, Integer.MAX_VALUE);
    }

    public int getAndIncrement() {
        return getAndIncrement(1);
    }

    public int incrementAndGet(int amount, int maximum) {
        value += amount;
        if (value > maximum)
            value = maximum;
        return value;
    }

    public int incrementAndGet(int amount) {
        return incrementAndGet(amount, Integer.MAX_VALUE);
    }

    public int incrementAndGet() {
        return incrementAndGet(1);
    }

    public MutableNumber increment() {
        incrementAndGet(1);
        return this;
    }

    public int getAndDecrement(int amount, int minimum) {
        int val = value;
        value -= amount;
        if (value < minimum)
            value = minimum;
        return val;
    }

    public int getAndDecrement(int amount) {
        return getAndDecrement(amount, Integer.MIN_VALUE);
    }

    public int getAndDecrement() {
        return getAndDecrement(1);
    }

    public int decrementAndGet(int amount, int minimum) {
        value -= amount;
        if (value < minimum)
            value = minimum;
        return value;
    }

    public int decrementAndGet(int amount) {
        return decrementAndGet(amount, Integer.MIN_VALUE);
    }

    public int decrementAndGet() {
        return decrementAndGet(1);
    }

    public int get() {
        return value;
    }

    public void set(int value) {
        this.value = value;
    }
}