MutableInt (abacus-common-se 2.3.11 API)

java.lang.Object
- java.lang.Number
- - com.landawn.abacus.util.MutableInt

All Implemented Interfaces:

Mutable, Serializable, Comparable<MutableInt>
```
public final class MutableInt
extends Number
implements Comparable<MutableInt>, 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 int wrapper.
Note that as MutableInt does not extend Integer, it is not treated by String.format as an Integer parameter.
MutableInt is NOT thread-safe.

Since:

2.1

Version:

$Id: MutableInt.java 1669791 2015-03-28 15:22:59Z britter $

See Also:

Integer, Serialized Form

Method Summary

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

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static MutableInt of(int value)
```
    Parameters:
    
    value -
    
    Returns:
  - value
```
public int value()
```
  - getValue
```
@Deprecated
public int getValue()
```
    Deprecated. replace by value().
    
    Gets the value as a Integer instance.
    
    Returns:
  - setValue
```
public void setValue(int value)
```
    Sets the value.
    
    Parameters:
    
    value - the value to set
  - getAndSet
```
public int getAndSet(int value)
```
    Gets the and set.
    
    Parameters:
    
    value -
    
    Returns:
  - setAndGet
```
public int setAndGet(int value)
```
    Sets the and get.
    
    Parameters:
    
    value -
    
    Returns:
  - setIf
```
public <E extends Exception> boolean setIf(int newValue,
                                           Throwables.IntPredicate<E> predicate)
                                    throws E extends Exception
```
    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
    
    E extends Exception
  - setIf
```
@Deprecated
public <E extends Exception> boolean setIf(int newValue,
                                                        Throwables.IntBiPredicate<E> predicate)
                                                 throws E extends Exception
```
    Deprecated.
    
    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 - the first parameter is the current value, the second parameter is the new value.
    
    Returns:
    
    Throws:
    
    E - the e
    
    E extends Exception
  - 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(int 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(int 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 final int getAndIncrement()
```
    Increments by one the current value.
    
    Returns:
  - getAndDecrement
```
public final int getAndDecrement()
```
    Decrements by one the current value.
    
    Returns:
  - incrementAndGet
```
public final int incrementAndGet()
```
    Increments by one the current value.
    
    Returns:
  - decrementAndGet
```
public final int decrementAndGet()
```
    Decrements by one the current value.
    
    Returns:
  - getAndAdd
```
public final int getAndAdd(int delta)
```
    Adds the given value to the current value.
    
    Parameters:
    
    delta - the value to add
    
    Returns:
  - addAndGet
```
public final int addAndGet(int 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 MutableInt as an int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
  - longValue
```
public long longValue()
```
    Returns the value of this MutableInt as a long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
  - floatValue
```
public float floatValue()
```
    Returns the value of this MutableInt as a float.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this MutableInt as a double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
  - compareTo
```
public int compareTo(MutableInt other)
```
    Compares this mutable to another in ascending order.
    
    Specified by:
    
    compareTo in interface Comparable<MutableInt>
    
    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 MutableInt object that contains the same int 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:

Class MutableInt

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Method Detail

of

value

getValue

setValue

getAndSet

setAndGet

setIf

setIf

increment

decrement

add

subtract

getAndIncrement

getAndDecrement

incrementAndGet

decrementAndGet

getAndAdd

addAndGet

intValue

longValue

floatValue

doubleValue

compareTo

equals

hashCode

toString