Package org.apache.commons.lang3.mutable
Class MutableInt
java.lang.Object
java.lang.Number
org.apache.commons.lang3.mutable.MutableInt
- All Implemented Interfaces:
Serializable,Comparable<MutableInt>,Mutable<Number>
A mutable
int wrapper.
Note that as MutableInt does not extend Integer, it is not treated by String.format as an Integer parameter.
- Since:
- 2.1
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new MutableInt with the default value of zero.MutableInt(int value) Constructs a new MutableInt with the specified value.MutableInt(Number value) Constructs a new MutableInt with the specified value.MutableInt(String value) Constructs a new MutableInt parsing the given string. -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(int operand) Adds a value to the value of this instance.voidAdds a value to the value of this instance.intaddAndGet(int operand) Increments this instance's value byoperand; this method returns the value associated with the instance immediately after the addition operation.intIncrements this instance's value byoperand; this method returns the value associated with the instance immediately after the addition operation.intcompareTo(MutableInt other) Compares this mutable to another in ascending order.voidDecrements the value.intDecrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation.doubleReturns the value of this MutableInt as a double.booleanCompares this object to the specified object.floatReturns the value of this MutableInt as a float.intgetAndAdd(int operand) Increments this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation.intIncrements this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation.intDecrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation.intIncrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation.getValue()Gets the value as a Integer instance.inthashCode()Returns a suitable hash code for this mutable.voidIncrements the value.intIncrements this instance's value by 1; this method returns the value associated with the instance immediately after the increment operation.intintValue()Returns the value of this MutableInt as an int.longReturns the value of this MutableInt as a long.voidsetValue(int value) Sets the value.voidSets the value from any Number instance.voidsubtract(int operand) Subtracts a value from the value of this instance.voidSubtracts a value from the value of this instance.Gets this mutable as an instance of Integer.toString()Returns the String value of this mutable.Methods inherited from class java.lang.Number
byteValue, shortValue
-
Constructor Details
-
MutableInt
public MutableInt()Constructs a new MutableInt with the default value of zero. -
MutableInt
Constructs a new MutableInt with the specified value.- Parameters:
value- the initial value to store
-
MutableInt
Constructs a new MutableInt with the specified value.- Parameters:
value- the initial value to store, not null- Throws:
NullPointerException- if the object is null
-
MutableInt
Constructs a new MutableInt parsing the given string.- Parameters:
value- the string to parse, not null- Throws:
NumberFormatException- if the string cannot be parsed into an int- Since:
- 2.5
-
-
Method Details
-
add
Adds a value to the value of this instance.- Parameters:
operand- the value to add, not null- Since:
- 2.2
-
add
Adds a value to the value of this instance.- Parameters:
operand- the value to add, not null- Throws:
NullPointerException- if the object is null- Since:
- 2.2
-
addAndGet
Increments this instance's value byoperand; this method returns the value associated with the instance immediately after the addition operation. This method is not thread safe.- Parameters:
operand- the quantity to add, not null- Returns:
- the value associated with this instance after adding the operand
- Since:
- 3.5
-
addAndGet
Increments this instance's value byoperand; this method returns the value associated with the instance immediately after the addition operation. This method is not thread safe.- Parameters:
operand- the quantity to add, not null- Returns:
- the value associated with this instance after adding the operand
- Throws:
NullPointerException- ifoperandis null- Since:
- 3.5
-
compareTo
Compares this mutable to another in ascending order.- Specified by:
compareToin interfaceComparable<MutableInt>- Parameters:
other- the other mutable to compare to, not null- Returns:
- negative if this is less, zero if equal, positive if greater
-
decrement
Decrements the value.- Since:
- 2.2
-
decrementAndGet
Decrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation. This method is not thread safe.- Returns:
- the value associated with the instance after it is decremented
- Since:
- 3.5
-
doubleValue
Returns the value of this MutableInt as a double.- Specified by:
doubleValuein classNumber- Returns:
- the numeric value represented by this object after conversion to type double.
-
equals
Compares this object to the specified object. The result istrueif and only if the argument is notnulland is aMutableIntobject that contains the sameintvalue as this object. -
floatValue
Returns the value of this MutableInt as a float.- Specified by:
floatValuein classNumber- Returns:
- the numeric value represented by this object after conversion to type float.
-
getAndAdd
Increments this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation. This method is not thread safe.- Parameters:
operand- the quantity to add, not null- Returns:
- the value associated with this instance immediately before the operand was added
- Since:
- 3.5
-
getAndAdd
Increments this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation. This method is not thread safe.- Parameters:
operand- the quantity to add, not null- Returns:
- the value associated with this instance immediately before the operand was added
- Throws:
NullPointerException- ifoperandis null- Since:
- 3.5
-
getAndDecrement
Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation. This method is not thread safe.- Returns:
- the value associated with the instance before it was decremented
- Since:
- 3.5
-
getAndIncrement
Increments this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation. This method is not thread safe.- Returns:
- the value associated with the instance before it was incremented
- Since:
- 3.5
-
getValue
Gets the value as a Integer instance. -
hashCode
Returns a suitable hash code for this mutable. -
increment
Increments the value.- Since:
- 2.2
-
incrementAndGet
Increments this instance's value by 1; this method returns the value associated with the instance immediately after the increment operation. This method is not thread safe.- Returns:
- the value associated with the instance after it is incremented
- Since:
- 3.5
-
intValue
Returns the value of this MutableInt as an int. -
longValue
Returns the value of this MutableInt as a long. -
setValue
Sets the value.- Parameters:
value- the value to set
-
setValue
Sets the value from any Number instance.- Specified by:
setValuein interfaceMutable<Number>- Parameters:
value- the value to set, not null- Throws:
NullPointerException- if the object is null
-
subtract
Subtracts a value from the value of this instance.- Parameters:
operand- the value to subtract, not null- Since:
- 2.2
-
subtract
Subtracts a value from the value of this instance.- Parameters:
operand- the value to subtract, not null- Throws:
NullPointerException- if the object is null- Since:
- 2.2
-
toInteger
Gets this mutable as an instance of Integer.- Returns:
- an Integer instance containing the value from this mutable, never null
-
toString
Returns the String value of this mutable.
-