Skip to content

Commit 377fb06

Browse files
committed
Javadoc
1 parent 0cf3dbc commit 377fb06

File tree

4 files changed

+26
-4
lines changed

4 files changed

+26
-4
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,21 @@
1818
package org.apache.commons.lang3.mutable;
1919

2020
import java.io.Serializable;
21+
import java.util.concurrent.atomic.AtomicBoolean;
2122

2223
import org.apache.commons.lang3.BooleanUtils;
2324

2425
/**
2526
* A mutable {@code boolean} wrapper.
2627
* <p>
27-
* Note that as MutableBoolean does not extend Boolean, it is not treated by String.format as a Boolean parameter.
28+
* This class was created before the introduction of {@link AtomicBoolean}.
29+
* </p>
30+
* <p>
31+
* Note that as MutableBoolean does not extend {@link Boolean}, it is not treated by {@link String#format(String, Object...)} as a Boolean parameter.
2832
* </p>
2933
*
3034
* @see Boolean
35+
* @see AtomicBoolean
3136
* @since 2.2
3237
*/
3338
public class MutableBoolean implements Mutable<Boolean>, Serializable, Comparable<MutableBoolean> {

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,21 @@
1616
*/
1717
package org.apache.commons.lang3.mutable;
1818

19+
import java.util.concurrent.atomic.AtomicInteger;
20+
1921
import org.apache.commons.lang3.math.NumberUtils;
2022

2123
/**
2224
* A mutable {@code int} wrapper.
2325
* <p>
24-
* Note that as MutableInt does not extend Integer, it is not treated by String.format as an Integer parameter.
26+
* This class was created before the introduction of {@link AtomicInteger}.
27+
* </p>
28+
* <p>
29+
* Note that as MutableInt does not extend {@link Integer}, it is not treated by {@link String#format(String, Object...)} as an Integer parameter.
2530
* </p>
2631
*
2732
* @see Integer
33+
* @see AtomicInteger
2834
* @since 2.1
2935
*/
3036
public class MutableInt extends Number implements Comparable<MutableInt>, Mutable<Number> {

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,21 @@
1616
*/
1717
package org.apache.commons.lang3.mutable;
1818

19+
import java.util.concurrent.atomic.AtomicLong;
20+
1921
import org.apache.commons.lang3.math.NumberUtils;
2022

2123
/**
2224
* A mutable {@code long} wrapper.
2325
* <p>
24-
* Note that as MutableLong does not extend Long, it is not treated by String.format as a Long parameter.
26+
* This class was created before the introduction of {@link AtomicLong}.
27+
* </p>
28+
* <p>
29+
* Note that as MutableLong does not extend {@link Long}, it is not treated by {@link String#format(String, Object...)} as a Long parameter.
2530
* </p>
2631
*
2732
* @see Long
33+
* @see AtomicLong
2834
* @since 2.1
2935
*/
3036
public class MutableLong extends Number implements Comparable<MutableLong>, Mutable<Number> {

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,16 @@
1919

2020
import java.io.Serializable;
2121
import java.util.Objects;
22+
import java.util.concurrent.atomic.AtomicReference;
2223

2324
/**
2425
* A mutable {@link Object} wrapper.
26+
* <p>
27+
* This class was created before the introduction of {@link AtomicReference}.
28+
* </p>
2529
*
26-
* @param <T> the type to set and get
30+
* @param <T> the type to set and get.
31+
* @see AtomicReference
2732
* @since 2.1
2833
*/
2934
public class MutableObject<T> implements Mutable<T>, Serializable {

0 commit comments

Comments
 (0)