Javadoc

Author: garydgregory

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.
      */

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() {