[LANG-1768] MutableLong and friends should provide better parsing

exceptions Javadocs

Author: garydgregory

src/changes/changes.xml

@@ -83,6 +83,7 @@ The <action> type attribute can be add,update,fix,remove.
     <action                   type="fix" dev="ggregory" due-to="Gary Gregory">Instead of throwing a NullPointerException, ArrayUtils.toStringArray(Object[]) should return "null" for null elements like ArrayUtils.toStringArray(Object[], String) returns its valueForNullElements.</action>
     <action issue="LANG-1764" type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate NumericEntityUnescaper.OPTION in favor of Apache Commons Text.</action>
     <action                   type="fix" dev="ggregory" due-to="Gary Gregory">Several hash collisions in Fraction class.</action>
+    <action issue="LANG-1768" type="fix" dev="ggregory" due-to="Wang Hailong, Gary Gregory">MutableLong and friends should provide better parsing exceptions Javadocs.</action>
     <!-- ADD -->
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add Strings and refactor StringUtils.</action>
     <action issue="LANG-1747" type="add" dev="ggregory" due-to="Oliver B. Fischer, Gary Gregory">Add StopWatch.run([Failable]Runnable) and get([Failable]Supplier).</action>

src/main/java/org/apache/commons/lang3/mutable/MutableByte.java

@@ -68,7 +68,7 @@ public MutableByte(final Number value) {
      * Constructs a new MutableByte parsing the given string.
      *
      * @param value  the string to parse, not null
-     * @throws NumberFormatException if the string cannot be parsed into a byte
+     * @throws NumberFormatException if the string cannot be parsed into a byte, see {@link Byte#parseByte(String)}.
      * @since 2.5
      */
     public MutableByte(final String value) {

src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java

@@ -66,7 +66,7 @@ public MutableDouble(final Number value) {
      * Constructs a new MutableDouble parsing the given string.
      *
      * @param value  the string to parse, not null
-     * @throws NumberFormatException if the string cannot be parsed into a double
+     * @throws NumberFormatException if the string cannot be parsed into a double, see {@link Double#parseDouble(String)}.
      * @since 2.5
      */
     public MutableDouble(final String value) {

src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java

@@ -66,7 +66,7 @@ public MutableFloat(final Number value) {
      * Constructs a new MutableFloat parsing the given string.
      *
      * @param value  the string to parse, not null
-     * @throws NumberFormatException if the string cannot be parsed into a float
+     * @throws NumberFormatException if the string cannot be parsed into a float, see {@link Float#parseFloat(String)}.
      * @since 2.5
      */
     public MutableFloat(final String value) {

src/main/java/org/apache/commons/lang3/mutable/MutableInt.java

@@ -68,7 +68,7 @@ public MutableInt(final Number value) {
      * Constructs a new MutableInt parsing the given string.
      *
      * @param value  the string to parse, not null
-     * @throws NumberFormatException if the string cannot be parsed into an int
+     * @throws NumberFormatException if the string cannot be parsed into an int, see {@link Integer#parseInt(String)}.
      * @since 2.5
      */
     public MutableInt(final String value) {

src/main/java/org/apache/commons/lang3/mutable/MutableLong.java

@@ -68,7 +68,7 @@ public MutableLong(final Number value) {
      * Constructs a new MutableLong parsing the given string.
      *
      * @param value  the string to parse, not null
-     * @throws NumberFormatException if the string cannot be parsed into a long
+     * @throws NumberFormatException if the string cannot be parsed into a long, see {@link Long#parseLong(String)}.
      * @since 2.5
      */
     public MutableLong(final String value) {

src/main/java/org/apache/commons/lang3/mutable/MutableShort.java

@@ -68,7 +68,7 @@ public MutableShort(final short value) {
      * Constructs a new MutableShort parsing the given string.
      *
      * @param value  the string to parse, not null
-     * @throws NumberFormatException if the string cannot be parsed into a short
+     * @throws NumberFormatException if the string cannot be parsed into a short, see {@link Short#parseShort(String)}.
      * @since 2.5
      */
     public MutableShort(final String value) {