This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 1a49a5e33 Javadoc
1a49a5e33 is described below
commit 1a49a5e339c8ba57b99e7c3e9e6db79a980d501f
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Sep 19 10:27:47 2025 -0400
Javadoc
---
.../org/apache/commons/lang3/mutable/Mutable.java | 4 +-
.../apache/commons/lang3/mutable/MutableByte.java | 65 ++++++++++-----------
.../commons/lang3/mutable/MutableDouble.java | 68 +++++++++++-----------
.../apache/commons/lang3/mutable/MutableFloat.java | 66 ++++++++++-----------
.../apache/commons/lang3/mutable/MutableInt.java | 62 ++++++++++----------
.../apache/commons/lang3/mutable/MutableLong.java | 66 ++++++++++-----------
.../apache/commons/lang3/mutable/MutableShort.java | 64 ++++++++++----------
7 files changed, 197 insertions(+), 198 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
index 98b80da25..71254a5a1 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
@@ -49,7 +49,7 @@ default T get() {
/**
* Gets the value of this mutable.
*
- * @return the stored value
+ * @return the stored value.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -58,7 +58,7 @@ default T get() {
/**
* Sets the value of this mutable.
*
- * @param value the value to store
+ * @param value the value to store.
* @throws NullPointerException if the object is null and null is invalid.
* @throws ClassCastException if the type is invalid.
*/
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
index 59ea47f40..34d766bc4 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
@@ -26,7 +26,6 @@
* <p>
* Note that as MutableByte does not extend Byte, it is not treated by
String.format as a Byte parameter.
* </p>
- * <p>
*
* @see Byte
* @see AtomicInteger
@@ -62,8 +61,8 @@ public MutableByte(final byte value) {
/**
* Constructs a new MutableByte with the specified value.
*
- * @param value the initial value to store, not null
- * @throws NullPointerException if the object is null
+ * @param value the initial value to store, not null.
+ * @throws NullPointerException if the object is null.
*/
public MutableByte(final Number value) {
this.value = value.byteValue();
@@ -72,7 +71,7 @@ public MutableByte(final Number value) {
/**
* Constructs a new MutableByte parsing the given string.
*
- * @param value the string to parse, not null
+ * @param value the string to parse, not null.
* @throws NumberFormatException if the string cannot be parsed into a
byte, see {@link Byte#parseByte(String)}.
* @since 2.5
*/
@@ -83,7 +82,7 @@ public MutableByte(final String value) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
+ * @param operand the value to add, not null.
* @since 2.2
*/
public void add(final byte operand) {
@@ -93,8 +92,8 @@ public void add(final byte operand) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to add, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void add(final Number operand) {
@@ -105,8 +104,8 @@ public void add(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public byte addAndGet(final byte operand) {
@@ -118,9 +117,9 @@ public byte addAndGet(final byte operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public byte addAndGet(final Number operand) {
@@ -142,8 +141,8 @@ public byte byteValue() {
/**
* Compares this mutable to another in ascending order.
*
- * @param other the other mutable to compare to, not null
- * @return negative if this is less, zero if equal, positive if greater
+ * @param other the other mutable to compare to, not null.
+ * @return negative if this is less, zero if equal, positive if greater.
*/
@Override
public int compareTo(final MutableByte other) {
@@ -163,7 +162,7 @@ public void decrement() {
* 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.
*
- * @return the value associated with the instance after it is decremented
+ * @return the value associated with the instance after it is decremented.
* @since 3.5
*/
public byte decrementAndGet() {
@@ -186,7 +185,7 @@ public double doubleValue() {
* not {@code null} and is a {@link MutableByte} object that contains the
same {@code byte} value
* as this object.
*
- * @param obj the object to compare with, null returns false
+ * @param obj the object to compare with, null returns false.
* @return {@code true} if the objects are the same; {@code false}
otherwise.
*/
@Override
@@ -211,8 +210,8 @@ public float floatValue() {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public byte getAndAdd(final byte operand) {
@@ -225,9 +224,9 @@ public byte getAndAdd(final byte operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public byte getAndAdd(final Number operand) {
@@ -240,7 +239,7 @@ public byte getAndAdd(final Number operand) {
* 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.
*
- * @return the value associated with the instance before it was decremented
+ * @return the value associated with the instance before it was
decremented.
* @since 3.5
*/
public byte getAndDecrement() {
@@ -253,7 +252,7 @@ public byte getAndDecrement() {
* 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.
*
- * @return the value associated with the instance before it was incremented
+ * @return the value associated with the instance before it was
incremented.
* @since 3.5
*/
public byte getAndIncrement() {
@@ -277,7 +276,7 @@ public Byte getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return a suitable hash code
+ * @return a suitable hash code.
*/
@Override
public int hashCode() {
@@ -297,7 +296,7 @@ public void increment() {
* 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.
*
- * @return the value associated with the instance after it is incremented
+ * @return the value associated with the instance after it is incremented.
* @since 3.5
*/
public byte incrementAndGet() {
@@ -328,7 +327,7 @@ public long longValue() {
/**
* Sets the value.
*
- * @param value the value to set
+ * @param value the value to set.
*/
public void setValue(final byte value) {
this.value = value;
@@ -337,8 +336,8 @@ public void setValue(final byte value) {
/**
* Sets the value from any Number instance.
*
- * @param value the value to set, not null
- * @throws NullPointerException if the object is null
+ * @param value the value to set, not null.
+ * @throws NullPointerException if the object is null.
*/
@Override
public void setValue(final Number value) {
@@ -348,7 +347,7 @@ public void setValue(final Number value) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
+ * @param operand the value to subtract, not null.
* @since 2.2
*/
public void subtract(final byte operand) {
@@ -358,8 +357,8 @@ public void subtract(final byte operand) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to subtract, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void subtract(final Number operand) {
@@ -369,7 +368,7 @@ public void subtract(final Number operand) {
/**
* Gets this mutable as an instance of Byte.
*
- * @return a Byte instance containing the value from this mutable
+ * @return a Byte instance containing the value from this mutable.
*/
public Byte toByte() {
return Byte.valueOf(byteValue());
@@ -378,7 +377,7 @@ public Byte toByte() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return the mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
index 2b6b855e8..f05e8fdee 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
@@ -54,7 +54,7 @@ public MutableDouble() {
/**
* Constructs a new MutableDouble with the specified value.
*
- * @param value the initial value to store
+ * @param value the initial value to store.
*/
public MutableDouble(final double value) {
this.value = value;
@@ -63,8 +63,8 @@ public MutableDouble(final double value) {
/**
* Constructs a new MutableDouble with the specified value.
*
- * @param value the initial value to store, not null
- * @throws NullPointerException if the object is null
+ * @param value the initial value to store, not null.
+ * @throws NullPointerException if the object is null.
*/
public MutableDouble(final Number value) {
this.value = value.doubleValue();
@@ -73,7 +73,7 @@ public MutableDouble(final Number value) {
/**
* Constructs a new MutableDouble parsing the given string.
*
- * @param value the string to parse, not null
+ * @param value the string to parse, not null.
* @throws NumberFormatException if the string cannot be parsed into a
double, see {@link Double#parseDouble(String)}.
* @since 2.5
*/
@@ -84,7 +84,7 @@ public MutableDouble(final String value) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add
+ * @param operand the value to add.
* @since 2.2
*/
public void add(final double operand) {
@@ -94,8 +94,8 @@ public void add(final double operand) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to add, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void add(final Number operand) {
@@ -106,8 +106,8 @@ public void add(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public double addAndGet(final double operand) {
@@ -119,9 +119,9 @@ public double addAndGet(final double operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public double addAndGet(final Number operand) {
@@ -132,8 +132,8 @@ public double addAndGet(final Number operand) {
/**
* Compares this mutable to another in ascending order.
*
- * @param other the other mutable to compare to, not null
- * @return negative if this is less, zero if equal, positive if greater
+ * @param other the other mutable to compare to, not null.
+ * @return negative if this is less, zero if equal, positive if greater.
*/
@Override
public int compareTo(final MutableDouble other) {
@@ -153,7 +153,7 @@ public void decrement() {
* 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.
*
- * @return the value associated with the instance after it is decremented
+ * @return the value associated with the instance after it is decremented.
* @since 3.5
*/
public double decrementAndGet() {
@@ -216,8 +216,8 @@ public float floatValue() {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public double getAndAdd(final double operand) {
@@ -230,9 +230,9 @@ public double getAndAdd(final double operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public double getAndAdd(final Number operand) {
@@ -245,7 +245,7 @@ public double getAndAdd(final Number operand) {
* 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.
*
- * @return the value associated with the instance before it was decremented
+ * @return the value associated with the instance before it was
decremented.
* @since 3.5
*/
public double getAndDecrement() {
@@ -258,7 +258,7 @@ public double getAndDecrement() {
* 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.
*
- * @return the value associated with the instance before it was incremented
+ * @return the value associated with the instance before it was
incremented.
* @since 3.5
*/
public double getAndIncrement() {
@@ -282,7 +282,7 @@ public Double getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return a suitable hash code
+ * @return a suitable hash code.
*/
@Override
public int hashCode() {
@@ -303,7 +303,7 @@ public void increment() {
* 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.
*
- * @return the value associated with the instance after it is incremented
+ * @return the value associated with the instance after it is incremented.
* @since 3.5
*/
public double incrementAndGet() {
@@ -325,7 +325,7 @@ public int intValue() {
/**
* Checks whether the double value is infinite.
*
- * @return true if infinite
+ * @return true if infinite.
*/
public boolean isInfinite() {
return Double.isInfinite(value);
@@ -334,7 +334,7 @@ public boolean isInfinite() {
/**
* Checks whether the double value is the special NaN value.
*
- * @return true if NaN
+ * @return true if NaN.
*/
public boolean isNaN() {
return Double.isNaN(value);
@@ -353,7 +353,7 @@ public long longValue() {
/**
* Sets the value.
*
- * @param value the value to set
+ * @param value the value to set.
*/
public void setValue(final double value) {
this.value = value;
@@ -362,8 +362,8 @@ public void setValue(final double value) {
/**
* Sets the value from any Number instance.
*
- * @param value the value to set, not null
- * @throws NullPointerException if the object is null
+ * @param value the value to set, not null.
+ * @throws NullPointerException if the object is null.
*/
@Override
public void setValue(final Number value) {
@@ -373,7 +373,7 @@ public void setValue(final Number value) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
+ * @param operand the value to subtract, not null.
* @since 2.2
*/
public void subtract(final double operand) {
@@ -383,8 +383,8 @@ public void subtract(final double operand) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to subtract, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void subtract(final Number operand) {
@@ -394,7 +394,7 @@ public void subtract(final Number operand) {
/**
* Gets this mutable as an instance of Double.
*
- * @return a Double instance containing the value from this mutable, never
null
+ * @return a Double instance containing the value from this mutable, never
null.
*/
public Double toDouble() {
return Double.valueOf(doubleValue());
@@ -403,7 +403,7 @@ public Double toDouble() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return the mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
index 97abff768..0ca2de0b1 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
@@ -54,7 +54,7 @@ public MutableFloat() {
/**
* Constructs a new MutableFloat with the specified value.
*
- * @param value the initial value to store
+ * @param value the initial value to store.
*/
public MutableFloat(final float value) {
this.value = value;
@@ -63,8 +63,8 @@ public MutableFloat(final float value) {
/**
* Constructs a new MutableFloat with the specified value.
*
- * @param value the initial value to store, not null
- * @throws NullPointerException if the object is null
+ * @param value the initial value to store, not null.
+ * @throws NullPointerException if the object is null.
*/
public MutableFloat(final Number value) {
this.value = value.floatValue();
@@ -73,7 +73,7 @@ public MutableFloat(final Number value) {
/**
* Constructs a new MutableFloat parsing the given string.
*
- * @param value the string to parse, not null
+ * @param value the string to parse, not null.
* @throws NumberFormatException if the string cannot be parsed into a
float, see {@link Float#parseFloat(String)}.
* @since 2.5
*/
@@ -84,7 +84,7 @@ public MutableFloat(final String value) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
+ * @param operand the value to add, not null.
* @since 2.2
*/
public void add(final float operand) {
@@ -94,8 +94,8 @@ public void add(final float operand) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to add, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void add(final Number operand) {
@@ -106,8 +106,8 @@ public void add(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public float addAndGet(final float operand) {
@@ -119,9 +119,9 @@ public float addAndGet(final float operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public float addAndGet(final Number operand) {
@@ -132,8 +132,8 @@ public float addAndGet(final Number operand) {
/**
* Compares this mutable to another in ascending order.
*
- * @param other the other mutable to compare to, not null
- * @return negative if this is less, zero if equal, positive if greater
+ * @param other the other mutable to compare to, not null.
+ * @return negative if this is less, zero if equal, positive if greater.
*/
@Override
public int compareTo(final MutableFloat other) {
@@ -153,7 +153,7 @@ public void decrement() {
* 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.
*
- * @return the value associated with the instance after it is decremented
+ * @return the value associated with the instance after it is decremented.
* @since 3.5
*/
public float decrementAndGet() {
@@ -220,8 +220,8 @@ public float floatValue() {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public float getAndAdd(final float operand) {
@@ -234,9 +234,9 @@ public float getAndAdd(final float operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public float getAndAdd(final Number operand) {
@@ -249,7 +249,7 @@ public float getAndAdd(final Number operand) {
* 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.
*
- * @return the value associated with the instance before it was decremented
+ * @return the value associated with the instance before it was
decremented.
* @since 3.5
*/
public float getAndDecrement() {
@@ -262,7 +262,7 @@ public float getAndDecrement() {
* 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.
*
- * @return the value associated with the instance before it was incremented
+ * @return the value associated with the instance before it was
incremented.
* @since 3.5
*/
public float getAndIncrement() {
@@ -286,7 +286,7 @@ public Float getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return a suitable hash code
+ * @return a suitable hash code.
*/
@Override
public int hashCode() {
@@ -306,7 +306,7 @@ public void increment() {
* 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.
*
- * @return the value associated with the instance after it is incremented
+ * @return the value associated with the instance after it is incremented.
* @since 3.5
*/
public float incrementAndGet() {
@@ -337,7 +337,7 @@ public boolean isInfinite() {
/**
* Checks whether the float value is the special NaN value.
*
- * @return true if NaN
+ * @return true if NaN.
*/
public boolean isNaN() {
return Float.isNaN(value);
@@ -356,7 +356,7 @@ public long longValue() {
/**
* Sets the value.
*
- * @param value the value to set
+ * @param value the value to set.
*/
public void setValue(final float value) {
this.value = value;
@@ -365,8 +365,8 @@ public void setValue(final float value) {
/**
* Sets the value from any Number instance.
*
- * @param value the value to set, not null
- * @throws NullPointerException if the object is null
+ * @param value the value to set, not null.
+ * @throws NullPointerException if the object is null.
*/
@Override
public void setValue(final Number value) {
@@ -376,7 +376,7 @@ public void setValue(final Number value) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract
+ * @param operand the value to subtract.
* @since 2.2
*/
public void subtract(final float operand) {
@@ -386,8 +386,8 @@ public void subtract(final float operand) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to subtract, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void subtract(final Number operand) {
@@ -397,7 +397,7 @@ public void subtract(final Number operand) {
/**
* Gets this mutable as an instance of Float.
*
- * @return a Float instance containing the value from this mutable, never
null
+ * @return a Float instance containing the value from this mutable, never
null.
*/
public Float toFloat() {
return Float.valueOf(floatValue());
@@ -406,7 +406,7 @@ public Float toFloat() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return the mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
index 086d4d87c..d8b56cc23 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
@@ -52,7 +52,7 @@ public MutableInt() {
/**
* Constructs a new MutableInt with the specified value.
*
- * @param value the initial value to store
+ * @param value the initial value to store.
*/
public MutableInt(final int value) {
this.value = value;
@@ -61,8 +61,8 @@ public MutableInt(final int value) {
/**
* Constructs a new MutableInt with the specified value.
*
- * @param value the initial value to store, not null
- * @throws NullPointerException if the object is null
+ * @param value the initial value to store, not null.
+ * @throws NullPointerException if the object is null.
*/
public MutableInt(final Number value) {
this.value = value.intValue();
@@ -71,7 +71,7 @@ public MutableInt(final Number value) {
/**
* Constructs a new MutableInt parsing the given string.
*
- * @param value the string to parse, not null
+ * @param value the string to parse, not null.
* @throws NumberFormatException if the string cannot be parsed into an
int, see {@link Integer#parseInt(String)}.
* @since 2.5
*/
@@ -82,7 +82,7 @@ public MutableInt(final String value) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
+ * @param operand the value to add, not null.
* @since 2.2
*/
public void add(final int operand) {
@@ -92,8 +92,8 @@ public void add(final int operand) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to add, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void add(final Number operand) {
@@ -104,8 +104,8 @@ public void add(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public int addAndGet(final int operand) {
@@ -117,9 +117,9 @@ public int addAndGet(final int operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public int addAndGet(final Number operand) {
@@ -151,7 +151,7 @@ public void decrement() {
* 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.
*
- * @return the value associated with the instance after it is decremented
+ * @return the value associated with the instance after it is decremented.
* @since 3.5
*/
public int decrementAndGet() {
@@ -174,7 +174,7 @@ public double doubleValue() {
* not {@code null} and is a {@link MutableInt} object that contains the
same {@code int} value
* as this object.
*
- * @param obj the object to compare with, null returns false
+ * @param obj the object to compare with, null returns false.
* @return {@code true} if the objects are the same; {@code false}
otherwise.
*/
@Override
@@ -199,8 +199,8 @@ public float floatValue() {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public int getAndAdd(final int operand) {
@@ -213,9 +213,9 @@ public int getAndAdd(final int operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public int getAndAdd(final Number operand) {
@@ -228,7 +228,7 @@ public int getAndAdd(final Number operand) {
* 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.
*
- * @return the value associated with the instance before it was decremented
+ * @return the value associated with the instance before it was
decremented.
* @since 3.5
*/
public int getAndDecrement() {
@@ -241,7 +241,7 @@ public int getAndDecrement() {
* 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.
*
- * @return the value associated with the instance before it was incremented
+ * @return the value associated with the instance before it was
incremented.
* @since 3.5
*/
public int getAndIncrement() {
@@ -265,7 +265,7 @@ public Integer getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return a suitable hash code
+ * @return a suitable hash code.
*/
@Override
public int hashCode() {
@@ -285,7 +285,7 @@ public void increment() {
* 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.
*
- * @return the value associated with the instance after it is incremented
+ * @return the value associated with the instance after it is incremented.
* @since 3.5
*/
public int incrementAndGet() {
@@ -317,7 +317,7 @@ public long longValue() {
/**
* Sets the value.
*
- * @param value the value to set
+ * @param value the value to set.
*/
public void setValue(final int value) {
this.value = value;
@@ -326,8 +326,8 @@ public void setValue(final int value) {
/**
* Sets the value from any Number instance.
*
- * @param value the value to set, not null
- * @throws NullPointerException if the object is null
+ * @param value the value to set, not null.
+ * @throws NullPointerException if the object is null.
*/
@Override
public void setValue(final Number value) {
@@ -337,7 +337,7 @@ public void setValue(final Number value) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
+ * @param operand the value to subtract, not null.
* @since 2.2
*/
public void subtract(final int operand) {
@@ -347,8 +347,8 @@ public void subtract(final int operand) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to subtract, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void subtract(final Number operand) {
@@ -358,7 +358,7 @@ public void subtract(final Number operand) {
/**
* Gets this mutable as an instance of Integer.
*
- * @return an Integer instance containing the value from this mutable,
never null
+ * @return an Integer instance containing the value from this mutable,
never null.
*/
public Integer toInteger() {
return Integer.valueOf(intValue());
@@ -367,7 +367,7 @@ public Integer toInteger() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return the mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
index 9baa97db5..7e187bb36 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
@@ -52,7 +52,7 @@ public MutableLong() {
/**
* Constructs a new MutableLong with the specified value.
*
- * @param value the initial value to store
+ * @param value the initial value to store.
*/
public MutableLong(final long value) {
this.value = value;
@@ -61,8 +61,8 @@ public MutableLong(final long value) {
/**
* Constructs a new MutableLong with the specified value.
*
- * @param value the initial value to store, not null
- * @throws NullPointerException if the object is null
+ * @param value the initial value to store, not null.
+ * @throws NullPointerException if the object is null.
*/
public MutableLong(final Number value) {
this.value = value.longValue();
@@ -71,7 +71,7 @@ public MutableLong(final Number value) {
/**
* Constructs a new MutableLong parsing the given string.
*
- * @param value the string to parse, not null
+ * @param value the string to parse, not null.
* @throws NumberFormatException if the string cannot be parsed into a
long, see {@link Long#parseLong(String)}.
* @since 2.5
*/
@@ -82,7 +82,7 @@ public MutableLong(final String value) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
+ * @param operand the value to add, not null.
* @since 2.2
*/
public void add(final long operand) {
@@ -92,8 +92,8 @@ public void add(final long operand) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to add, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void add(final Number operand) {
@@ -104,8 +104,8 @@ public void add(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public long addAndGet(final long operand) {
@@ -117,9 +117,9 @@ public long addAndGet(final long operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public long addAndGet(final Number operand) {
@@ -130,8 +130,8 @@ public long addAndGet(final Number operand) {
/**
* Compares this mutable to another in ascending order.
*
- * @param other the other mutable to compare to, not null
- * @return negative if this is less, zero if equal, positive if greater
+ * @param other the other mutable to compare to, not null.
+ * @return negative if this is less, zero if equal, positive if greater.
*/
@Override
public int compareTo(final MutableLong other) {
@@ -151,7 +151,7 @@ public void decrement() {
* 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.
*
- * @return the value associated with the instance after it is decremented
+ * @return the value associated with the instance after it is decremented.
* @since 3.5
*/
public long decrementAndGet() {
@@ -174,7 +174,7 @@ public double doubleValue() {
* is not {@code null} and is a {@link MutableLong} object that contains
the same {@code long}
* value as this object.
*
- * @param obj the object to compare with, null returns false
+ * @param obj the object to compare with, null returns false.
* @return {@code true} if the objects are the same; {@code false}
otherwise.
*/
@Override
@@ -199,8 +199,8 @@ public float floatValue() {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public long getAndAdd(final long operand) {
@@ -213,9 +213,9 @@ public long getAndAdd(final long operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public long getAndAdd(final Number operand) {
@@ -228,7 +228,7 @@ public long getAndAdd(final Number operand) {
* 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.
*
- * @return the value associated with the instance before it was decremented
+ * @return the value associated with the instance before it was
decremented.
* @since 3.5
*/
public long getAndDecrement() {
@@ -241,7 +241,7 @@ public long getAndDecrement() {
* 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.
*
- * @return the value associated with the instance before it was incremented
+ * @return the value associated with the instance before it was
incremented.
* @since 3.5
*/
public long getAndIncrement() {
@@ -265,7 +265,7 @@ public Long getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return a suitable hash code
+ * @return a suitable hash code.
*/
@Override
public int hashCode() {
@@ -285,7 +285,7 @@ public void increment() {
* 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.
*
- * @return the value associated with the instance after it is incremented
+ * @return the value associated with the instance after it is incremented.
* @since 3.5
*/
public long incrementAndGet() {
@@ -317,7 +317,7 @@ public long longValue() {
/**
* Sets the value.
*
- * @param value the value to set
+ * @param value the value to set.
*/
public void setValue(final long value) {
this.value = value;
@@ -326,8 +326,8 @@ public void setValue(final long value) {
/**
* Sets the value from any Number instance.
*
- * @param value the value to set, not null
- * @throws NullPointerException if the object is null
+ * @param value the value to set, not null.
+ * @throws NullPointerException if the object is null.
*/
@Override
public void setValue(final Number value) {
@@ -337,7 +337,7 @@ public void setValue(final Number value) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
+ * @param operand the value to subtract, not null.
* @since 2.2
*/
public void subtract(final long operand) {
@@ -347,8 +347,8 @@ public void subtract(final long operand) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to subtract, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void subtract(final Number operand) {
@@ -358,7 +358,7 @@ public void subtract(final Number operand) {
/**
* Gets this mutable as an instance of Long.
*
- * @return a Long instance containing the value from this mutable, never
null
+ * @return a Long instance containing the value from this mutable, never
null.
*/
public Long toLong() {
return Long.valueOf(longValue());
@@ -367,7 +367,7 @@ public Long toLong() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return the mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
b/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
index 8f8e091db..07ca7bbb6 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
@@ -52,8 +52,8 @@ public MutableShort() {
/**
* Constructs a new MutableShort with the specified value.
*
- * @param value the initial value to store, not null
- * @throws NullPointerException if the object is null
+ * @param value the initial value to store, not null.
+ * @throws NullPointerException if the object is null.
*/
public MutableShort(final Number value) {
this.value = value.shortValue();
@@ -62,7 +62,7 @@ public MutableShort(final Number value) {
/**
* Constructs a new MutableShort with the specified value.
*
- * @param value the initial value to store
+ * @param value the initial value to store.
*/
public MutableShort(final short value) {
this.value = value;
@@ -71,7 +71,7 @@ public MutableShort(final short value) {
/**
* Constructs a new MutableShort parsing the given string.
*
- * @param value the string to parse, not null
+ * @param value the string to parse, not null.
* @throws NumberFormatException if the string cannot be parsed into a
short, see {@link Short#parseShort(String)}.
* @since 2.5
*/
@@ -82,8 +82,8 @@ public MutableShort(final String value) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to add, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void add(final Number operand) {
@@ -93,7 +93,7 @@ public void add(final Number operand) {
/**
* Adds a value to the value of this instance.
*
- * @param operand the value to add, not null
+ * @param operand the value to add, not null.
* @since 2.2
*/
public void add(final short operand) {
@@ -104,9 +104,9 @@ public void add(final short operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public short addAndGet(final Number operand) {
@@ -118,8 +118,8 @@ public short addAndGet(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately after the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance after adding the operand
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance after adding the
operand.
* @since 3.5
*/
public short addAndGet(final short operand) {
@@ -130,8 +130,8 @@ public short addAndGet(final short operand) {
/**
* Compares this mutable to another in ascending order.
*
- * @param other the other mutable to compare to, not null
- * @return negative if this is less, zero if equal, positive if greater
+ * @param other the other mutable to compare to, not null.
+ * @return negative if this is less, zero if equal, positive if greater.
*/
@Override
public int compareTo(final MutableShort other) {
@@ -151,7 +151,7 @@ public void decrement() {
* 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.
*
- * @return the value associated with the instance after it is decremented
+ * @return the value associated with the instance after it is decremented.
* @since 3.5
*/
public short decrementAndGet() {
@@ -174,7 +174,7 @@ public double doubleValue() {
* is not {@code null} and is a {@link MutableShort} object that contains
the same {@code short}
* value as this object.
*
- * @param obj the object to compare with, null returns false
+ * @param obj the object to compare with, null returns false.
* @return {@code true} if the objects are the same; {@code false}
otherwise.
*/
@Override
@@ -199,9 +199,9 @@ public float floatValue() {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @throws NullPointerException if {@code operand} is null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @throws NullPointerException if {@code operand} is null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public short getAndAdd(final Number operand) {
@@ -214,8 +214,8 @@ public short getAndAdd(final Number operand) {
* Increments this instance's value by {@code operand}; this method
returns the value associated with the instance
* immediately prior to the addition operation. This method is not thread
safe.
*
- * @param operand the quantity to add, not null
- * @return the value associated with this instance immediately before the
operand was added
+ * @param operand the quantity to add, not null.
+ * @return the value associated with this instance immediately before the
operand was added.
* @since 3.5
*/
public short getAndAdd(final short operand) {
@@ -228,7 +228,7 @@ public short getAndAdd(final short operand) {
* 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.
*
- * @return the value associated with the instance before it was decremented
+ * @return the value associated with the instance before it was
decremented.
* @since 3.5
*/
public short getAndDecrement() {
@@ -241,7 +241,7 @@ public short getAndDecrement() {
* 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.
*
- * @return the value associated with the instance before it was incremented
+ * @return the value associated with the instance before it was
incremented.
* @since 3.5
*/
public short getAndIncrement() {
@@ -265,7 +265,7 @@ public Short getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return a suitable hash code
+ * @return a suitable hash code.
*/
@Override
public int hashCode() {
@@ -285,7 +285,7 @@ public void increment() {
* 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.
*
- * @return the value associated with the instance after it is incremented
+ * @return the value associated with the instance after it is incremented.
* @since 3.5
*/
public short incrementAndGet() {
@@ -316,8 +316,8 @@ public long longValue() {
/**
* Sets the value from any Number instance.
*
- * @param value the value to set, not null
- * @throws NullPointerException if the object is null
+ * @param value the value to set, not null.
+ * @throws NullPointerException if the object is null.
*/
@Override
public void setValue(final Number value) {
@@ -347,8 +347,8 @@ public short shortValue() {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
- * @throws NullPointerException if the object is null
+ * @param operand the value to subtract, not null.
+ * @throws NullPointerException if the object is null.
* @since 2.2
*/
public void subtract(final Number operand) {
@@ -358,7 +358,7 @@ public void subtract(final Number operand) {
/**
* Subtracts a value from the value of this instance.
*
- * @param operand the value to subtract, not null
+ * @param operand the value to subtract, not null.
* @since 2.2
*/
public void subtract(final short operand) {
@@ -368,7 +368,7 @@ public void subtract(final short operand) {
/**
* Gets this mutable as an instance of Short.
*
- * @return a Short instance containing the value from this mutable, never
null
+ * @return a Short instance containing the value from this mutable, never
null.
*/
public Short toShort() {
return Short.valueOf(shortValue());
@@ -377,7 +377,7 @@ public Short toShort() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return the mutable value as a string.
*/
@Override
public String toString() {
