You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/12/10 21:27:08 UTC
[commons-lang] branch master updated: Javadoc: Replace
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 7bbbdd2 Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
7bbbdd2 is described below
commit 7bbbdd2477305992e4d809db5288d6f62718124b
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Dec 10 16:27:02 2019 -0500
Javadoc: Replace <code></code> HTML tags with Javadoc {@code} notation.
---
.../java/org/apache/commons/lang3/ArchUtils.java | 4 +-
.../java/org/apache/commons/lang3/ArrayUtils.java | 28 +-
.../apache/commons/lang3/CharSequenceUtils.java | 44 +-
.../java/org/apache/commons/lang3/Functions.java | 18 +-
.../java/org/apache/commons/lang3/JavaVersion.java | 2 +-
.../commons/lang3/NotImplementedException.java | 4 +-
.../java/org/apache/commons/lang3/RegExUtils.java | 8 +-
.../apache/commons/lang3/SerializationUtils.java | 16 +-
.../apache/commons/lang3/StringEscapeUtils.java | 4 +-
.../java/org/apache/commons/lang3/StringUtils.java | 108 ++--
.../java/org/apache/commons/lang3/SystemUtils.java | 4 +-
.../org/apache/commons/lang3/arch/Processor.java | 10 +-
.../commons/lang3/builder/CompareToBuilder.java | 308 +++++-----
.../commons/lang3/builder/EqualsBuilder.java | 258 ++++----
.../commons/lang3/builder/EqualsExclude.java | 2 +-
.../commons/lang3/builder/HashCodeBuilder.java | 178 +++---
.../commons/lang3/builder/HashCodeExclude.java | 2 +-
.../builder/MultilineRecursiveToStringStyle.java | 2 +-
.../lang3/builder/RecursiveToStringStyle.java | 8 +-
.../lang3/builder/ReflectionToStringBuilder.java | 152 ++---
.../lang3/builder/StandardToStringStyle.java | 58 +-
.../commons/lang3/builder/ToStringBuilder.java | 352 +++++------
.../commons/lang3/builder/ToStringStyle.java | 678 ++++++++++-----------
.../commons/lang3/concurrent/ConcurrentUtils.java | 2 +-
.../commons/lang3/concurrent/package-info.java | 126 ++--
.../commons/lang3/event/EventListenerSupport.java | 36 +-
.../commons/lang3/exception/ExceptionUtils.java | 176 +++---
.../commons/lang3/exception/package-info.java | 2 +-
.../org/apache/commons/lang3/math/Fraction.java | 144 ++---
.../apache/commons/lang3/math/IEEE754rUtils.java | 32 +-
.../org/apache/commons/lang3/math/NumberUtils.java | 390 ++++++------
.../apache/commons/lang3/math/package-info.java | 2 +-
.../org/apache/commons/lang3/mutable/Mutable.java | 2 +-
.../commons/lang3/mutable/MutableBoolean.java | 20 +-
.../apache/commons/lang3/mutable/MutableByte.java | 8 +-
.../commons/lang3/mutable/MutableDouble.java | 28 +-
.../apache/commons/lang3/mutable/MutableFloat.java | 28 +-
.../apache/commons/lang3/mutable/MutableInt.java | 8 +-
.../apache/commons/lang3/mutable/MutableLong.java | 8 +-
.../commons/lang3/mutable/MutableObject.java | 20 +-
.../apache/commons/lang3/mutable/MutableShort.java | 8 +-
.../org/apache/commons/lang3/package-info.java | 28 +-
.../commons/lang3/reflect/ConstructorUtils.java | 2 +-
.../apache/commons/lang3/reflect/FieldUtils.java | 2 +-
.../apache/commons/lang3/reflect/MemberUtils.java | 2 +-
.../apache/commons/lang3/text/CompositeFormat.java | 2 +-
.../commons/lang3/text/ExtendedMessageFormat.java | 32 +-
.../apache/commons/lang3/text/FormatFactory.java | 4 +-
.../org/apache/commons/lang3/text/StrBuilder.java | 48 +-
.../org/apache/commons/lang3/text/StrMatcher.java | 22 +-
.../apache/commons/lang3/text/StrSubstitutor.java | 24 +-
.../apache/commons/lang3/text/StrTokenizer.java | 16 +-
.../org/apache/commons/lang3/text/WordUtils.java | 60 +-
.../apache/commons/lang3/text/package-info.java | 2 +-
.../text/translate/CharSequenceTranslator.java | 4 +-
.../lang3/text/translate/JavaUnicodeEscaper.java | 14 +-
.../lang3/text/translate/NumericEntityEscaper.java | 18 +-
.../lang3/text/translate/UnicodeEscaper.java | 18 +-
.../apache/commons/lang3/time/DateFormatUtils.java | 28 +-
.../org/apache/commons/lang3/time/DateParser.java | 18 +-
.../org/apache/commons/lang3/time/DateUtils.java | 120 ++--
.../commons/lang3/time/DurationFormatUtils.java | 6 +-
.../apache/commons/lang3/time/FastDateParser.java | 6 +-
.../org/apache/commons/lang3/time/FormatCache.java | 6 +-
.../org/apache/commons/lang3/time/StopWatch.java | 2 +-
.../lang3/builder/CompareToBuilderTest.java | 2 +-
.../HashCodeBuilderAndEqualsBuilderTest.java | 2 +-
.../commons/lang3/builder/ToStringBuilderTest.java | 18 +-
.../lang3/exception/ExceptionUtilsTest.java | 4 +-
.../commons/lang3/reflect/FieldUtilsTest.java | 2 +-
.../lang3/text/ExtendedMessageFormatTest.java | 4 +-
.../commons/lang3/text/StrTokenizerTest.java | 2 +-
72 files changed, 1903 insertions(+), 1903 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/ArchUtils.java b/src/main/java/org/apache/commons/lang3/ArchUtils.java
index 7f36b28..e0b2aae 100644
--- a/src/main/java/org/apache/commons/lang3/ArchUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArchUtils.java
@@ -112,7 +112,7 @@ public class ArchUtils {
* not of the operating system.
* </p>
*
- * @return A {@link Processor} when supported, else <code>null</code>.
+ * @return A {@link Processor} when supported, else {@code null}.
*/
public static Processor getProcessor() {
return getProcessor(SystemUtils.OS_ARCH);
@@ -123,7 +123,7 @@ public class ArchUtils {
* like a value returned by the os.arch System Property.
*
* @param value A {@link String} like a value returned by the os.arch System Property.
- * @return A {@link Processor} when it exists, else <code>null</code>.
+ * @return A {@link Processor} when it exists, else {@code null}.
*/
public static Processor getProcessor(final String value) {
return ARCH_TO_PROCESSOR.get(value);
diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index a35dde9..2aa8510 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -5267,7 +5267,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5286,7 +5286,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5305,7 +5305,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5324,7 +5324,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5343,7 +5343,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5362,7 +5362,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5381,7 +5381,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5400,7 +5400,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param element the element to remove
@@ -5419,7 +5419,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>
* All subsequent elements are shifted to the left (subtracts one from their indices).
* If the array doesn't contains such an element, no elements are removed from the array.
- * <code>null</code> will be returned if the input array is <code>null</code>.
+ * {@code null} will be returned if the input array is {@code null}.
* </p>
*
* @param <T> the type of object in the array
@@ -8637,9 +8637,9 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>Note, this method makes only sense to provide arguments of the same type so that the
* compiler can deduce the type of the array itself. While it is possible to select the
* type explicitly like in
- * <code>Number[] array = ArrayUtils.<Number>toArray(Integer.valueOf(42), Double.valueOf(Math.PI))</code>,
+ * {@code Number[] array = ArrayUtils.<Number>toArray(Integer.valueOf(42), Double.valueOf(Math.PI))},
* there is no real advantage when compared to
- * <code>new Number[] {Integer.valueOf(42), Double.valueOf(Math.PI)}</code>.
+ * {@code new Number[] {Integer.valueOf(42), Double.valueOf(Math.PI)}}.
*
* @param <T> the array's element type
* @param items the varargs array items, null allowed
@@ -9289,7 +9289,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>Multi-dimensional arrays are handled correctly, including
* multi-dimensional primitive arrays.
*
- * <p>The format is that of Java source code, for example <code>{a,b}</code>.
+ * <p>The format is that of Java source code, for example {@code {a,b}}.
*
* @param array the array to get a toString for, may be {@code null}
* @return a String representation of the array, '{}' if null array input
@@ -9304,7 +9304,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* <p>Multi-dimensional arrays are handled correctly, including
* multi-dimensional primitive arrays.
*
- * <p>The format is that of Java source code, for example <code>{a,b}</code>.
+ * <p>The format is that of Java source code, for example {@code {a,b}}.
*
* @param array the array to get a toString for, may be {@code null}
* @param stringIfNull the String to return if the array is {@code null}
@@ -9372,7 +9372,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
/**
* <p>ArrayUtils instances should NOT be constructed in standard programming.
- * Instead, the class should be used as <code>ArrayUtils.clone(new int[] {2})</code>.
+ * Instead, the class should be used as {@code ArrayUtils.clone(new int[] {2})}.
*
* <p>This constructor is public to permit tools that require a JavaBean instance
* to operate.
diff --git a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
index a74f65b..58c0453 100644
--- a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
@@ -59,42 +59,42 @@ public class CharSequenceUtils {
//-----------------------------------------------------------------------
/**
- * Returns the index within <code>cs</code> of the first occurrence of the
+ * Returns the index within {@code cs} of the first occurrence of the
* specified character, starting the search at the specified index.
* <p>
- * If a character with value <code>searchChar</code> occurs in the
- * character sequence represented by the <code>cs</code>
- * object at an index no smaller than <code>start</code>, then
+ * If a character with value {@code searchChar} occurs in the
+ * character sequence represented by the {@code cs}
+ * object at an index no smaller than {@code start}, then
* the index of the first such occurrence is returned. For values
- * of <code>searchChar</code> in the range from 0 to 0xFFFF (inclusive),
+ * of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
* this is the smallest value <i>k</i> such that:
* <blockquote><pre>
* (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> >= start)
* </pre></blockquote>
- * is true. For other values of <code>searchChar</code>, it is the
+ * is true. For other values of {@code searchChar}, it is the
* smallest value <i>k</i> such that:
* <blockquote><pre>
* (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> >= start)
* </pre></blockquote>
- * is true. In either case, if no such character occurs inm <code>cs</code>
- * at or after position <code>start</code>, then
- * <code>-1</code> is returned.
+ * is true. In either case, if no such character occurs inm {@code cs}
+ * at or after position {@code start}, then
+ * {@code -1} is returned.
*
* <p>
- * There is no restriction on the value of <code>start</code>. If it
+ * There is no restriction on the value of {@code start}. If it
* is negative, it has the same effect as if it were zero: the entire
- * <code>CharSequence</code> may be searched. If it is greater than
- * the length of <code>cs</code>, it has the same effect as if it were
- * equal to the length of <code>cs</code>: <code>-1</code> is returned.
+ * {@code CharSequence} may be searched. If it is greater than
+ * the length of {@code cs}, it has the same effect as if it were
+ * equal to the length of {@code cs}: {@code -1} is returned.
*
- * <p>All indices are specified in <code>char</code> values
+ * <p>All indices are specified in {@code char} values
* (Unicode code units).
*
* @param cs the {@code CharSequence} to be processed, not null
* @param searchChar the char to be searched for
* @param start the start index, negative starts at the string start
* @return the index where the search char was found, -1 if not found
- * @since 3.6 updated to behave more like <code>String</code>
+ * @since 3.6 updated to behave more like {@code String}
*/
static int indexOf(final CharSequence cs, final int searchChar, int start) {
if (cs instanceof String) {
@@ -147,30 +147,30 @@ public class CharSequenceUtils {
}
/**
- * Returns the index within <code>cs</code> of the last occurrence of
+ * Returns the index within {@code cs} of the last occurrence of
* the specified character, searching backward starting at the
- * specified index. For values of <code>searchChar</code> in the range
+ * specified index. For values of {@code searchChar} in the range
* from 0 to 0xFFFF (inclusive), the index returned is the largest
* value <i>k</i> such that:
* <blockquote><pre>
* (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> <= start)
* </pre></blockquote>
- * is true. For other values of <code>searchChar</code>, it is the
+ * is true. For other values of {@code searchChar}, it is the
* largest value <i>k</i> such that:
* <blockquote><pre>
* (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> <= start)
* </pre></blockquote>
- * is true. In either case, if no such character occurs in <code>cs</code>
- * at or before position <code>start</code>, then <code>-1</code> is returned.
+ * is true. In either case, if no such character occurs in {@code cs}
+ * at or before position {@code start}, then {@code -1} is returned.
*
- * <p>All indices are specified in <code>char</code> values
+ * <p>All indices are specified in {@code char} values
* (Unicode code units).
*
* @param cs the {@code CharSequence} to be processed
* @param searchChar the char to be searched for
* @param start the start index, negative returns -1, beyond length starts at end
* @return the index where the search char was found, -1 if not found
- * @since 3.6 updated to behave more like <code>String</code>
+ * @since 3.6 updated to behave more like {@code String}
*/
static int lastIndexOf(final CharSequence cs, final int searchChar, int start) {
if (cs instanceof String) {
diff --git a/src/main/java/org/apache/commons/lang3/Functions.java b/src/main/java/org/apache/commons/lang3/Functions.java
index 74efd9b..eeed548 100644
--- a/src/main/java/org/apache/commons/lang3/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/Functions.java
@@ -285,7 +285,7 @@ public class Functions {
/**
* Consumes a consumer and rethrows any exception as a {@link RuntimeException}.
* @param pConsumer the consumer to consume
- * @param pObject the object to consume by <code>pConsumer</code>
+ * @param pObject the object to consume by {@code pConsumer}
* @param <O> the type the consumer accepts
* @param <T> the type of checked exception the consumer may throw
*/
@@ -300,8 +300,8 @@ public class Functions {
/**
* Consumes a consumer and rethrows any exception as a {@link RuntimeException}.
* @param pConsumer the consumer to consume
- * @param pObject1 the first object to consume by <code>pConsumer</code>
- * @param pObject2 the second object to consume by <code>pConsumer</code>
+ * @param pObject1 the first object to consume by {@code pConsumer}
+ * @param pObject2 the second object to consume by {@code pConsumer}
* @param <O1> the type of the first argument the consumer accepts
* @param <O2> the type of the second argument the consumer accepts
* @param <T> the type of checked exception the consumer may throw
@@ -317,7 +317,7 @@ public class Functions {
/**
* Applies a function and rethrows any exception as a {@link RuntimeException}.
* @param pFunction the function to apply
- * @param pInput the input to apply <code>pFunction</code> on
+ * @param pInput the input to apply {@code pFunction} on
* @param <I> the type of the argument the function accepts
* @param <O> the return type of the function
* @param <T> the type of checked exception the function may throw
@@ -334,8 +334,8 @@ public class Functions {
/**
* Applies a function and rethrows any exception as a {@link RuntimeException}.
* @param pFunction the function to apply
- * @param pInput1 the first input to apply <code>pFunction</code> on
- * @param pInput2 the second input to apply <code>pFunction</code> on
+ * @param pInput1 the first input to apply {@code pFunction} on
+ * @param pInput2 the second input to apply {@code pFunction} on
* @param <I1> the type of the first argument the function accepts
* @param <I2> the type of the second argument the function accepts
* @param <O> the return type of the function
@@ -353,7 +353,7 @@ public class Functions {
/**
* Tests a predicate and rethrows any exception as a {@link RuntimeException}.
* @param pPredicate the predicate to test
- * @param pObject the input to test by <code>pPredicate</code>
+ * @param pObject the input to test by {@code pPredicate}
* @param <O> the type of argument the predicate tests
* @param <T> the type of checked exception the predicate may throw
* @return the boolean value returned by the predicate
@@ -369,8 +369,8 @@ public class Functions {
/**
* Tests a predicate and rethrows any exception as a {@link RuntimeException}.
* @param pPredicate the predicate to test
- * @param pObject1 the first input to test by <code>pPredicate</code>
- * @param pObject2 the second input to test by <code>pPredicate</code>
+ * @param pObject1 the first input to test by {@code pPredicate}
+ * @param pObject2 the second input to test by {@code pPredicate}
* @param <O1> the type of the first argument the predicate tests
* @param <O2> the type of the second argument the predicate tests
* @param <T> the type of checked exception the predicate may throw
diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java b/src/main/java/org/apache/commons/lang3/JavaVersion.java
index 143e997..e287c9f 100644
--- a/src/main/java/org/apache/commons/lang3/JavaVersion.java
+++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java
@@ -242,7 +242,7 @@ public enum JavaVersion {
/**
* <p>The string value is overridden to return the standard name.</p>
*
- * <p>For example, <code>"1.5"</code>.</p>
+ * <p>For example, {@code "1.5"}.</p>
*
* @return the name, not null
*/
diff --git a/src/main/java/org/apache/commons/lang3/NotImplementedException.java b/src/main/java/org/apache/commons/lang3/NotImplementedException.java
index 5facdb2..2ad7463 100644
--- a/src/main/java/org/apache/commons/lang3/NotImplementedException.java
+++ b/src/main/java/org/apache/commons/lang3/NotImplementedException.java
@@ -18,10 +18,10 @@ package org.apache.commons.lang3;
/**
* <p>Thrown to indicate that a block of code has not been implemented.
- * This exception supplements <code>UnsupportedOperationException</code>
+ * This exception supplements {@code UnsupportedOperationException}
* by providing a more semantically rich description of the problem.</p>
*
- * <p><code>NotImplementedException</code> represents the case where the
+ * <p>{@code NotImplementedException} represents the case where the
* author has yet to implement the logic at this point in the program.
* This can act as an exception based TODO tag. </p>
*
diff --git a/src/main/java/org/apache/commons/lang3/RegExUtils.java b/src/main/java/org/apache/commons/lang3/RegExUtils.java
index d148150..c658501 100644
--- a/src/main/java/org/apache/commons/lang3/RegExUtils.java
+++ b/src/main/java/org/apache/commons/lang3/RegExUtils.java
@@ -74,7 +74,7 @@ public class RegExUtils {
*
* <p>Unlike in the {@link #removePattern(String, String)} method, the {@link Pattern#DOTALL} option
* is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -155,7 +155,7 @@ public class RegExUtils {
* <p>A {@code null} reference passed to this method is a no-op.</p>
*
* <p>The {@link Pattern#DOTALL} option is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -276,7 +276,7 @@ public class RegExUtils {
*
* <p>Unlike in the {@link #replacePattern(String, String, String)} method, the {@link Pattern#DOTALL} option
* is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -372,7 +372,7 @@ public class RegExUtils {
* <p>A {@code null} reference passed to this method is a no-op.</p>
*
* <p>The {@link Pattern#DOTALL} option is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
index 8446f58..28f8d76 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
@@ -225,12 +225,12 @@ public class SerializationUtils {
/**
* <p>Custom specialization of the standard JDK {@link java.io.ObjectInputStream}
- * that uses a custom <code>ClassLoader</code> to resolve a class.
- * If the specified <code>ClassLoader</code> is not able to resolve the class,
+ * that uses a custom {@code ClassLoader} to resolve a class.
+ * If the specified {@code ClassLoader} is not able to resolve the class,
* the context classloader of the current thread will be used.
* This way, the standard deserialization work also in web-application
* containers and application servers, no matter in which of the
- * <code>ClassLoader</code> the particular class that encapsulates
+ * {@code ClassLoader} the particular class that encapsulates
* serialization/deserialization lives. </p>
*
* <p>For more in-depth information about the problem for which this
@@ -256,7 +256,7 @@ public class SerializationUtils {
/**
* Constructor.
- * @param in The <code>InputStream</code>.
+ * @param in The {@code InputStream}.
* @param classLoader classloader to use
* @throws IOException if an I/O error occurs while reading stream header.
* @see java.io.ObjectInputStream
@@ -267,10 +267,10 @@ public class SerializationUtils {
}
/**
- * Overridden version that uses the parameterized <code>ClassLoader</code> or the <code>ClassLoader</code>
- * of the current <code>Thread</code> to resolve the class.
- * @param desc An instance of class <code>ObjectStreamClass</code>.
- * @return A <code>Class</code> object corresponding to <code>desc</code>.
+ * Overridden version that uses the parameterized {@code ClassLoader} or the {@code ClassLoader}
+ * of the current {@code Thread} to resolve the class.
+ * @param desc An instance of class {@code ObjectStreamClass}.
+ * @return A {@code Class} object corresponding to {@code desc}.
* @throws IOException Any of the usual Input/Output exceptions.
* @throws ClassNotFoundException If class of a serialized object cannot be found.
*/
diff --git a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
index 64f1d5d..e437b355 100644
--- a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
@@ -568,10 +568,10 @@ public class StringEscapeUtils {
* <p>
* For example:
* </p>
- * <p><code>"bread" & "butter"</code></p>
+ * <p>{@code "bread" & "butter"}</p>
* becomes:
* <p>
- * <code>&quot;bread&quot; &amp; &quot;butter&quot;</code>.
+ * {@code &quot;bread&quot; &amp; &quot;butter&quot;}.
* </p>
*
* <p>Supports all known HTML 4.0 entities, including funky accents.
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java
index 9eb7fce..abde7ec 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -1781,8 +1781,8 @@ public class StringUtils {
}
/**
- * <p>Compares given <code>string</code> to a CharSequences vararg of <code>searchStrings</code>,
- * returning {@code true} if the <code>string</code> is equal to any of the <code>searchStrings</code>.</p>
+ * <p>Compares given {@code string} to a CharSequences vararg of {@code searchStrings},
+ * returning {@code true} if the {@code string} is equal to any of the {@code searchStrings}.</p>
*
* <pre>
* StringUtils.equalsAny(null, (CharSequence[]) null) = false
@@ -1795,8 +1795,8 @@ public class StringUtils {
*
* @param string to compare, may be {@code null}.
* @param searchStrings a vararg of strings, may be {@code null}.
- * @return {@code true} if the string is equal (case-sensitive) to any other element of <code>searchStrings</code>;
- * {@code false} if <code>searchStrings</code> is null or contains no matches.
+ * @return {@code true} if the string is equal (case-sensitive) to any other element of {@code searchStrings};
+ * {@code false} if {@code searchStrings} is null or contains no matches.
* @since 3.5
*/
public static boolean equalsAny(final CharSequence string, final CharSequence... searchStrings) {
@@ -1811,8 +1811,8 @@ public class StringUtils {
}
/**
- * <p>Compares given <code>string</code> to a CharSequences vararg of <code>searchStrings</code>,
- * returning {@code true} if the <code>string</code> is equal to any of the <code>searchStrings</code>, ignoring case.</p>
+ * <p>Compares given {@code string} to a CharSequences vararg of {@code searchStrings},
+ * returning {@code true} if the {@code string} is equal to any of the {@code searchStrings}, ignoring case.</p>
*
* <pre>
* StringUtils.equalsAnyIgnoreCase(null, (CharSequence[]) null) = false
@@ -1825,8 +1825,8 @@ public class StringUtils {
*
* @param string to compare, may be {@code null}.
* @param searchStrings a vararg of strings, may be {@code null}.
- * @return {@code true} if the string is equal (case-insensitive) to any other element of <code>searchStrings</code>;
- * {@code false} if <code>searchStrings</code> is null or contains no matches.
+ * @return {@code true} if the string is equal (case-insensitive) to any other element of {@code searchStrings};
+ * {@code false} if {@code searchStrings} is null or contains no matches.
* @since 3.5
*/
public static boolean equalsAnyIgnoreCase(final CharSequence string, final CharSequence...searchStrings) {
@@ -1978,7 +1978,7 @@ public class StringUtils {
* characters that is common to all of them.</p>
*
* <p>For example,
- * <code>getCommonPrefix(new String[] {"i am a machine", "i am a robot"}) -> "i am a "</code></p>
+ * {@code getCommonPrefix(new String[] {"i am a machine", "i am a robot"}) -> "i am a "}</p>
*
* <pre>
* StringUtils.getCommonPrefix(null) = ""
@@ -2590,22 +2590,22 @@ public class StringUtils {
// IndexOf
//-----------------------------------------------------------------------
/**
- * Returns the index within <code>seq</code> of the first occurrence of
+ * Returns the index within {@code seq} of the first occurrence of
* the specified character. If a character with value
- * <code>searchChar</code> occurs in the character sequence represented by
- * <code>seq</code> <code>CharSequence</code> object, then the index (in Unicode
+ * {@code searchChar} occurs in the character sequence represented by
+ * {@code seq} {@code CharSequence} object, then the index (in Unicode
* code units) of the first such occurrence is returned. For
- * values of <code>searchChar</code> in the range from 0 to 0xFFFF
+ * values of {@code searchChar} in the range from 0 to 0xFFFF
* (inclusive), this is the smallest value <i>k</i> such that:
* <blockquote><pre>
* this.charAt(<i>k</i>) == searchChar
* </pre></blockquote>
- * is true. For other values of <code>searchChar</code>, it is the
+ * is true. For other values of {@code searchChar}, it is the
* smallest value <i>k</i> such that:
* <blockquote><pre>
* this.codePointAt(<i>k</i>) == searchChar
* </pre></blockquote>
- * is true. In either case, if no such character occurs in <code>seq</code>,
+ * is true. In either case, if no such character occurs in {@code seq},
* then {@code INDEX_NOT_FOUND (-1)} is returned.
*
* <p>Furthermore, a {@code null} or empty ("") CharSequence will
@@ -2624,7 +2624,7 @@ public class StringUtils {
* -1 if no match or {@code null} string input
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, int) to indexOf(CharSequence, int)
- * @since 3.6 Updated {@link CharSequenceUtils} call to behave more like <code>String</code>
+ * @since 3.6 Updated {@link CharSequenceUtils} call to behave more like {@code String}
*/
public static int indexOf(final CharSequence seq, final int searchChar) {
if (isEmpty(seq)) {
@@ -2635,29 +2635,29 @@ public class StringUtils {
/**
*
- * Returns the index within <code>seq</code> of the first occurrence of the
+ * Returns the index within {@code seq} of the first occurrence of the
* specified character, starting the search at the specified index.
* <p>
- * If a character with value <code>searchChar</code> occurs in the
- * character sequence represented by the <code>seq</code> <code>CharSequence</code>
- * object at an index no smaller than <code>startPos</code>, then
+ * If a character with value {@code searchChar} occurs in the
+ * character sequence represented by the {@code seq} {@code CharSequence}
+ * object at an index no smaller than {@code startPos}, then
* the index of the first such occurrence is returned. For values
- * of <code>searchChar</code> in the range from 0 to 0xFFFF (inclusive),
+ * of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
* this is the smallest value <i>k</i> such that:
* <blockquote><pre>
* (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> >= startPos)
* </pre></blockquote>
- * is true. For other values of <code>searchChar</code>, it is the
+ * is true. For other values of {@code searchChar}, it is the
* smallest value <i>k</i> such that:
* <blockquote><pre>
* (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> >= startPos)
* </pre></blockquote>
- * is true. In either case, if no such character occurs in <code>seq</code>
- * at or after position <code>startPos</code>, then
- * <code>-1</code> is returned.
+ * is true. In either case, if no such character occurs in {@code seq}
+ * at or after position {@code startPos}, then
+ * {@code -1} is returned.
*
* <p>
- * There is no restriction on the value of <code>startPos</code>. If it
+ * There is no restriction on the value of {@code startPos}. If it
* is negative, it has the same effect as if it were zero: this entire
* string may be searched. If it is greater than the length of this
* string, it has the same effect as if it were equal to the length of
@@ -2665,7 +2665,7 @@ public class StringUtils {
* {@code null} or empty ("") CharSequence will
* return {@code (INDEX_NOT_FOUND) -1}.
*
- * <p>All indices are specified in <code>char</code> values
+ * <p>All indices are specified in {@code char} values
* (Unicode code units).
*
* <pre>
@@ -2684,7 +2684,7 @@ public class StringUtils {
* -1 if no match or {@code null} string input
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, int, int) to indexOf(CharSequence, int, int)
- * @since 3.6 Updated {@link CharSequenceUtils} call to behave more like <code>String</code>
+ * @since 3.6 Updated {@link CharSequenceUtils} call to behave more like {@code String}
*/
public static int indexOf(final CharSequence seq, final int searchChar, final int startPos) {
if (isEmpty(seq)) {
@@ -4923,22 +4923,22 @@ public class StringUtils {
// LastIndexOf
//-----------------------------------------------------------------------
/**
- * Returns the index within <code>seq</code> of the last occurrence of
- * the specified character. For values of <code>searchChar</code> in the
+ * Returns the index within {@code seq} of the last occurrence of
+ * the specified character. For values of {@code searchChar} in the
* range from 0 to 0xFFFF (inclusive), the index (in Unicode code
* units) returned is the largest value <i>k</i> such that:
* <blockquote><pre>
* this.charAt(<i>k</i>) == searchChar
* </pre></blockquote>
- * is true. For other values of <code>searchChar</code>, it is the
+ * is true. For other values of {@code searchChar}, it is the
* largest value <i>k</i> such that:
* <blockquote><pre>
* this.codePointAt(<i>k</i>) == searchChar
* </pre></blockquote>
* is true. In either case, if no such character occurs in this
- * string, then <code>-1</code> is returned. Furthermore, a {@code null} or empty ("")
- * <code>CharSequence</code> will return {@code -1}. The
- * <code>seq</code> <code>CharSequence</code> object is searched backwards
+ * string, then {@code -1} is returned. Furthermore, a {@code null} or empty ("")
+ * {@code CharSequence} will return {@code -1}. The
+ * {@code seq} {@code CharSequence} object is searched backwards
* starting at the last character.
*
* <pre>
@@ -4948,13 +4948,13 @@ public class StringUtils {
* StringUtils.lastIndexOf("aabaabaa", 'b') = 5
* </pre>
*
- * @param seq the <code>CharSequence</code> to check, may be null
+ * @param seq the {@code CharSequence} to check, may be null
* @param searchChar the character to find
* @return the last index of the search character,
* -1 if no match or {@code null} string input
* @since 2.0
* @since 3.0 Changed signature from lastIndexOf(String, int) to lastIndexOf(CharSequence, int)
- * @since 3.6 Updated {@link CharSequenceUtils} call to behave more like <code>String</code>
+ * @since 3.6 Updated {@link CharSequenceUtils} call to behave more like {@code String}
*/
public static int lastIndexOf(final CharSequence seq, final int searchChar) {
if (isEmpty(seq)) {
@@ -4964,28 +4964,28 @@ public class StringUtils {
}
/**
- * Returns the index within <code>seq</code> of the last occurrence of
+ * Returns the index within {@code seq} of the last occurrence of
* the specified character, searching backward starting at the
- * specified index. For values of <code>searchChar</code> in the range
+ * specified index. For values of {@code searchChar} in the range
* from 0 to 0xFFFF (inclusive), the index returned is the largest
* value <i>k</i> such that:
* <blockquote><pre>
* (this.charAt(<i>k</i>) == searchChar) && (<i>k</i> <= startPos)
* </pre></blockquote>
- * is true. For other values of <code>searchChar</code>, it is the
+ * is true. For other values of {@code searchChar}, it is the
* largest value <i>k</i> such that:
* <blockquote><pre>
* (this.codePointAt(<i>k</i>) == searchChar) && (<i>k</i> <= startPos)
* </pre></blockquote>
- * is true. In either case, if no such character occurs in <code>seq</code>
- * at or before position <code>startPos</code>, then
- * <code>-1</code> is returned. Furthermore, a {@code null} or empty ("")
- * <code>CharSequence</code> will return {@code -1}. A start position greater
+ * is true. In either case, if no such character occurs in {@code seq}
+ * at or before position {@code startPos}, then
+ * {@code -1} is returned. Furthermore, a {@code null} or empty ("")
+ * {@code CharSequence} will return {@code -1}. A start position greater
* than the string length searches the whole string.
- * The search starts at the <code>startPos</code> and works backwards;
+ * The search starts at the {@code startPos} and works backwards;
* matches starting after the start position are ignored.
*
- * <p>All indices are specified in <code>char</code> values
+ * <p>All indices are specified in {@code char} values
* (Unicode code units).
*
* <pre>
@@ -5500,7 +5500,7 @@ public class StringUtils {
* </p>
* <p>
* The function returns the argument string with whitespace normalized by using
- * <code>{@link #trim(String)}</code> to remove leading and trailing whitespace
+ * {@code {@link #trim(String)}} to remove leading and trailing whitespace
* and then replacing sequences of whitespace characters by a single space.
* </p>
* In XML Whitespace characters are the same as those allowed by the <a
@@ -5520,7 +5520,7 @@ public class StringUtils {
*
* <p>
* The difference is that Java's whitespace includes vertical tab and form feed, which this functional will also
- * normalize. Additionally <code>{@link #trim(String)}</code> removes control characters (char <= 32) from both
+ * normalize. Additionally {@code {@link #trim(String)}} removes control characters (char <= 32) from both
* ends of this String.
* </p>
*
@@ -5896,7 +5896,7 @@ public class StringUtils {
*
* <p>Unlike in the {@link #removePattern(String, String)} method, the {@link Pattern#DOTALL} option
* is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -6015,7 +6015,7 @@ public class StringUtils {
* <p>A {@code null} reference passed to this method is a no-op.</p>
*
* <p>The {@link Pattern#DOTALL} option is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -6457,7 +6457,7 @@ public class StringUtils {
*
* <p>Unlike in the {@link #replacePattern(String, String, String)} method, the {@link Pattern#DOTALL} option
* is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -6532,7 +6532,7 @@ public class StringUtils {
* This method can also be used to delete characters.</p>
*
* <p>For example:<br>
- * <code>replaceChars("hello", "ho", "jy") = jelly</code>.</p>
+ * {@code replaceChars("hello", "ho", "jy") = jelly}.</p>
*
* <p>A {@code null} string input returns {@code null}.
* An empty ("") string input returns an empty string.
@@ -6874,7 +6874,7 @@ public class StringUtils {
* <p>A {@code null} reference passed to this method is a no-op.</p>
*
* <p>The {@link Pattern#DOTALL} option is NOT automatically added.
- * To use the DOTALL option prepend <code>"(?s)"</code> to the regex.
+ * To use the DOTALL option prepend {@code "(?s)"} to the regex.
* DOTALL is also known as single-line mode in Perl.</p>
*
* <pre>
@@ -8926,7 +8926,7 @@ public class StringUtils {
}
/**
- * Converts a <code>byte[]</code> to a String using the specified character encoding.
+ * Converts a {@code byte[]} to a String using the specified character encoding.
*
* @param bytes
* the byte array to read from
@@ -8965,7 +8965,7 @@ public class StringUtils {
}
/**
- * Converts a <code>byte[]</code> to a String using the specified character encoding.
+ * Converts a {@code byte[]} to a String using the specified character encoding.
*
* @param bytes
* the byte array to read from
diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java
index 0300e16..a954223 100644
--- a/src/main/java/org/apache/commons/lang3/SystemUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java
@@ -652,7 +652,7 @@ public class SystemUtils {
/**
* <p>
- * The {@code line.separator} System Property. Line separator (<code>"\n"</code> on UNIX).
+ * The {@code line.separator} System Property. Line separator ({@code "\n"} on UNIX).
* </p>
* <p>
* Defaults to {@code null} if the runtime does not have security access to read this property or the property does
@@ -726,7 +726,7 @@ public class SystemUtils {
/**
* <p>
- * The {@code path.separator} System Property. Path separator (<code>":"</code> on UNIX).
+ * The {@code path.separator} System Property. Path separator ({@code ":"} on UNIX).
* </p>
* <p>
* Defaults to {@code null} if the runtime does not have security access to read this property or the property does
diff --git a/src/main/java/org/apache/commons/lang3/arch/Processor.java b/src/main/java/org/apache/commons/lang3/arch/Processor.java
index 7bb9942..194e0cb 100644
--- a/src/main/java/org/apache/commons/lang3/arch/Processor.java
+++ b/src/main/java/org/apache/commons/lang3/arch/Processor.java
@@ -125,7 +125,7 @@ public class Processor {
/**
* Checks if {@link Processor} is 32 bit.
*
- * @return <code>true</code>, if {@link Processor} is {@link Arch#BIT_32}, else <code>false</code>.
+ * @return {@code true}, if {@link Processor} is {@link Arch#BIT_32}, else {@code false}.
*/
public boolean is32Bit() {
return Arch.BIT_32.equals(arch);
@@ -134,7 +134,7 @@ public class Processor {
/**
* Checks if {@link Processor} is 64 bit.
*
- * @return <code>true</code>, if {@link Processor} is {@link Arch#BIT_64}, else <code>false</code>.
+ * @return {@code true}, if {@link Processor} is {@link Arch#BIT_64}, else {@code false}.
*/
public boolean is64Bit() {
return Arch.BIT_64.equals(arch);
@@ -143,7 +143,7 @@ public class Processor {
/**
* Checks if {@link Processor} is type of x86.
*
- * @return <code>true</code>, if {@link Processor} is {@link Type#X86}, else <code>false</code>.
+ * @return {@code true}, if {@link Processor} is {@link Type#X86}, else {@code false}.
*/
public boolean isX86() {
return Type.X86.equals(type);
@@ -152,7 +152,7 @@ public class Processor {
/**
* Checks if {@link Processor} is type of Intel Itanium.
*
- * @return <code>true</code>. if {@link Processor} is {@link Type#IA_64}, else <code>false</code>.
+ * @return {@code true}. if {@link Processor} is {@link Type#IA_64}, else {@code false}.
*/
public boolean isIA64() {
return Type.IA_64.equals(type);
@@ -161,7 +161,7 @@ public class Processor {
/**
* Checks if {@link Processor} is type of Power PC.
*
- * @return <code>true</code>. if {@link Processor} is {@link Type#PPC}, else <code>false</code>.
+ * @return {@code true}. if {@link Processor} is {@link Type#PPC}, else {@code false}.
*/
public boolean isPPC() {
return Type.PPC.equals(type);
diff --git a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
index 7d3b392..553b291 100644
--- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
@@ -27,17 +27,17 @@ import org.apache.commons.lang3.ArrayUtils;
/**
* Assists in implementing {@link java.lang.Comparable#compareTo(Object)} methods.
*
- * <p>It is consistent with <code>equals(Object)</code> and
- * <code>hashcode()</code> built with {@link EqualsBuilder} and
+ * <p>It is consistent with {@code equals(Object)} and
+ * {@code hashcode()} built with {@link EqualsBuilder} and
* {@link HashCodeBuilder}.</p>
*
- * <p>Two Objects that compare equal using <code>equals(Object)</code> should normally
- * also compare equal using <code>compareTo(Object)</code>.</p>
+ * <p>Two Objects that compare equal using {@code equals(Object)} should normally
+ * also compare equal using {@code compareTo(Object)}.</p>
*
* <p>All relevant fields should be included in the calculation of the
* comparison. Derived fields may be ignored. The same fields, in the same
- * order, should be used in both <code>compareTo(Object)</code> and
- * <code>equals(Object)</code>.</p>
+ * order, should be used in both {@code compareTo(Object)} and
+ * {@code equals(Object)}.</p>
*
* <p>To use this class write code as follows:</p>
*
@@ -67,13 +67,13 @@ import org.apache.commons.lang3.ArrayUtils;
*
* <p>Alternatively, there are {@link #reflectionCompare(Object, Object) reflectionCompare} methods that use
* reflection to determine the fields to append. Because fields can be private,
- * <code>reflectionCompare</code> uses {@link java.lang.reflect.AccessibleObject#setAccessible(boolean)} to
+ * {@code reflectionCompare} uses {@link java.lang.reflect.AccessibleObject#setAccessible(boolean)} to
* bypass normal access control checks. This will fail under a security manager,
* unless the appropriate permissions are set up correctly. It is also
* slower than appending explicitly.</p>
*
- * <p>A typical implementation of <code>compareTo(Object)</code> using
- * <code>reflectionCompare</code> looks like:</p>
+ * <p>A typical implementation of {@code compareTo(Object)} using
+ * {@code reflectionCompare} looks like:</p>
* <pre>
* public int compareTo(Object o) {
@@ -113,9 +113,9 @@ public class CompareToBuilder implements Builder<Integer> {
//-----------------------------------------------------------------------
/**
- * <p>Compares two <code>Object</code>s via reflection.</p>
+ * <p>Compares two {@code Object}s via reflection.</p>
*
- * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code>
+ * <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
* security manager unless the appropriate permissions are set.</p>
*
@@ -126,81 +126,81 @@ public class CompareToBuilder implements Builder<Integer> {
* <li>Superclass fields will be compared</li>
* </ul>
*
- * <p>If both <code>lhs</code> and <code>rhs</code> are <code>null</code>,
+ * <p>If both {@code lhs} and {@code rhs} are {@code null},
* they are considered equal.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
- * @return a negative integer, zero, or a positive integer as <code>lhs</code>
- * is less than, equal to, or greater than <code>rhs</code>
+ * @return a negative integer, zero, or a positive integer as {@code lhs}
+ * is less than, equal to, or greater than {@code rhs}
* @throws NullPointerException if either (but not both) parameters are
- * <code>null</code>
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * {@code null}
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
*/
public static int reflectionCompare(final Object lhs, final Object rhs) {
return reflectionCompare(lhs, rhs, false, null);
}
/**
- * <p>Compares two <code>Object</code>s via reflection.</p>
+ * <p>Compares two {@code Object}s via reflection.</p>
*
- * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code>
+ * <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
* security manager unless the appropriate permissions are set.</p>
*
* <ul>
* <li>Static fields will not be compared</li>
- * <li>If <code>compareTransients</code> is <code>true</code>,
+ * <li>If {@code compareTransients} is {@code true},
* compares transient members. Otherwise ignores them, as they
* are likely derived fields.</li>
* <li>Superclass fields will be compared</li>
* </ul>
*
- * <p>If both <code>lhs</code> and <code>rhs</code> are <code>null</code>,
+ * <p>If both {@code lhs} and {@code rhs} are {@code null},
* they are considered equal.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
* @param compareTransients whether to compare transient fields
- * @return a negative integer, zero, or a positive integer as <code>lhs</code>
- * is less than, equal to, or greater than <code>rhs</code>
- * @throws NullPointerException if either <code>lhs</code> or <code>rhs</code>
- * (but not both) is <code>null</code>
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @return a negative integer, zero, or a positive integer as {@code lhs}
+ * is less than, equal to, or greater than {@code rhs}
+ * @throws NullPointerException if either {@code lhs} or {@code rhs}
+ * (but not both) is {@code null}
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
*/
public static int reflectionCompare(final Object lhs, final Object rhs, final boolean compareTransients) {
return reflectionCompare(lhs, rhs, compareTransients, null);
}
/**
- * <p>Compares two <code>Object</code>s via reflection.</p>
+ * <p>Compares two {@code Object}s via reflection.</p>
*
- * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code>
+ * <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
* security manager unless the appropriate permissions are set.</p>
*
* <ul>
* <li>Static fields will not be compared</li>
- * <li>If <code>compareTransients</code> is <code>true</code>,
+ * <li>If {@code compareTransients} is {@code true},
* compares transient members. Otherwise ignores them, as they
* are likely derived fields.</li>
* <li>Superclass fields will be compared</li>
* </ul>
*
- * <p>If both <code>lhs</code> and <code>rhs</code> are <code>null</code>,
+ * <p>If both {@code lhs} and {@code rhs} are {@code null},
* they are considered equal.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
* @param excludeFields Collection of String fields to exclude
- * @return a negative integer, zero, or a positive integer as <code>lhs</code>
- * is less than, equal to, or greater than <code>rhs</code>
- * @throws NullPointerException if either <code>lhs</code> or <code>rhs</code>
- * (but not both) is <code>null</code>
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @return a negative integer, zero, or a positive integer as {@code lhs}
+ * is less than, equal to, or greater than {@code rhs}
+ * @throws NullPointerException if either {@code lhs} or {@code rhs}
+ * (but not both) is {@code null}
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
* @since 2.2
*/
public static int reflectionCompare(final Object lhs, final Object rhs, final Collection<String> excludeFields) {
@@ -208,32 +208,32 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two <code>Object</code>s via reflection.</p>
+ * <p>Compares two {@code Object}s via reflection.</p>
*
- * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code>
+ * <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
* security manager unless the appropriate permissions are set.</p>
*
* <ul>
* <li>Static fields will not be compared</li>
- * <li>If <code>compareTransients</code> is <code>true</code>,
+ * <li>If {@code compareTransients} is {@code true},
* compares transient members. Otherwise ignores them, as they
* are likely derived fields.</li>
* <li>Superclass fields will be compared</li>
* </ul>
*
- * <p>If both <code>lhs</code> and <code>rhs</code> are <code>null</code>,
+ * <p>If both {@code lhs} and {@code rhs} are {@code null},
* they are considered equal.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
* @param excludeFields array of fields to exclude
- * @return a negative integer, zero, or a positive integer as <code>lhs</code>
- * is less than, equal to, or greater than <code>rhs</code>
- * @throws NullPointerException if either <code>lhs</code> or <code>rhs</code>
- * (but not both) is <code>null</code>
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @return a negative integer, zero, or a positive integer as {@code lhs}
+ * is less than, equal to, or greater than {@code rhs}
+ * @throws NullPointerException if either {@code lhs} or {@code rhs}
+ * (but not both) is {@code null}
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
* @since 2.2
*/
public static int reflectionCompare(final Object lhs, final Object rhs, final String... excludeFields) {
@@ -241,22 +241,22 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two <code>Object</code>s via reflection.</p>
+ * <p>Compares two {@code Object}s via reflection.</p>
*
- * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code>
+ * <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
* security manager unless the appropriate permissions are set.</p>
*
* <ul>
* <li>Static fields will not be compared</li>
- * <li>If the <code>compareTransients</code> is <code>true</code>,
+ * <li>If the {@code compareTransients} is {@code true},
* compares transient members. Otherwise ignores them, as they
* are likely derived fields.</li>
- * <li>Compares superclass fields up to and including <code>reflectUpToClass</code>.
- * If <code>reflectUpToClass</code> is <code>null</code>, compares all superclass fields.</li>
+ * <li>Compares superclass fields up to and including {@code reflectUpToClass}.
+ * If {@code reflectUpToClass} is {@code null}, compares all superclass fields.</li>
* </ul>
*
- * <p>If both <code>lhs</code> and <code>rhs</code> are <code>null</code>,
+ * <p>If both {@code lhs} and {@code rhs} are {@code null},
* they are considered equal.</p>
*
* @param lhs left-hand object
@@ -264,13 +264,13 @@ public class CompareToBuilder implements Builder<Integer> {
* @param compareTransients whether to compare transient fields
* @param reflectUpToClass last superclass for which fields are compared
* @param excludeFields fields to exclude
- * @return a negative integer, zero, or a positive integer as <code>lhs</code>
- * is less than, equal to, or greater than <code>rhs</code>
- * @throws NullPointerException if either <code>lhs</code> or <code>rhs</code>
- * (but not both) is <code>null</code>
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
- * @since 2.2 (2.0 as <code>reflectionCompare(Object, Object, boolean, Class)</code>)
+ * @return a negative integer, zero, or a positive integer as {@code lhs}
+ * is less than, equal to, or greater than {@code rhs}
+ * @throws NullPointerException if either {@code lhs} or {@code rhs}
+ * (but not both) is {@code null}
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
+ * @since 2.2 (2.0 as {@code reflectionCompare(Object, Object, boolean, Class)})
*/
public static int reflectionCompare(
final Object lhs,
@@ -299,13 +299,13 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to <code>builder</code> the comparison of <code>lhs</code>
- * to <code>rhs</code> using the fields defined in <code>clazz</code>.</p>
+ * <p>Appends to {@code builder} the comparison of {@code lhs}
+ * to {@code rhs} using the fields defined in {@code clazz}.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
- * @param clazz <code>Class</code> that defines fields to be compared
- * @param builder <code>CompareToBuilder</code> to append to
+ * @param clazz {@code Class} that defines fields to be compared
+ * @param builder {@code CompareToBuilder} to append to
* @param useTransients whether to compare transient fields
* @param excludeFields fields to exclude
*/
@@ -338,10 +338,10 @@ public class CompareToBuilder implements Builder<Integer> {
//-----------------------------------------------------------------------
/**
- * <p>Appends to the <code>builder</code> the <code>compareTo(Object)</code>
+ * <p>Appends to the {@code builder} the {@code compareTo(Object)}
* result of the superclass.</p>
*
- * @param superCompareTo result of calling <code>super.compareTo(Object)</code>
+ * @param superCompareTo result of calling {@code super.compareTo(Object)}
* @return this - used to chain append calls
* @since 2.0
*/
@@ -355,51 +355,51 @@ public class CompareToBuilder implements Builder<Integer> {
//-----------------------------------------------------------------------
/**
- * <p>Appends to the <code>builder</code> the comparison of
- * two <code>Object</code>s.</p>
+ * <p>Appends to the {@code builder} the comparison of
+ * two {@code Object}s.</p>
*
* <ol>
- * <li>Check if <code>lhs == rhs</code></li>
- * <li>Check if either <code>lhs</code> or <code>rhs</code> is <code>null</code>,
- * a <code>null</code> object is less than a non-<code>null</code> object</li>
+ * <li>Check if {@code lhs == rhs}</li>
+ * <li>Check if either {@code lhs} or {@code rhs} is {@code null},
+ * a {@code null} object is less than a non-{@code null} object</li>
* <li>Check the object contents</li>
* </ol>
*
- * <p><code>lhs</code> must either be an array or implement {@link Comparable}.</p>
+ * <p>{@code lhs} must either be an array or implement {@link Comparable}.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
* @return this - used to chain append calls
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
*/
public CompareToBuilder append(final Object lhs, final Object rhs) {
return append(lhs, rhs, null);
}
/**
- * <p>Appends to the <code>builder</code> the comparison of
- * two <code>Object</code>s.</p>
+ * <p>Appends to the {@code builder} the comparison of
+ * two {@code Object}s.</p>
*
* <ol>
- * <li>Check if <code>lhs == rhs</code></li>
- * <li>Check if either <code>lhs</code> or <code>rhs</code> is <code>null</code>,
- * a <code>null</code> object is less than a non-<code>null</code> object</li>
+ * <li>Check if {@code lhs == rhs}</li>
+ * <li>Check if either {@code lhs} or {@code rhs} is {@code null},
+ * a {@code null} object is less than a non-{@code null} object</li>
* <li>Check the object contents</li>
* </ol>
*
- * <p>If <code>lhs</code> is an array, array comparison methods will be used.
- * Otherwise <code>comparator</code> will be used to compare the objects.
- * If <code>comparator</code> is <code>null</code>, <code>lhs</code> must
+ * <p>If {@code lhs} is an array, array comparison methods will be used.
+ * Otherwise {@code comparator} will be used to compare the objects.
+ * If {@code comparator} is {@code null}, {@code lhs} must
* implement {@link Comparable} instead.</p>
*
* @param lhs left-hand object
* @param rhs right-hand object
- * @param comparator <code>Comparator</code> used to compare the objects,
- * <code>null</code> means treat lhs as <code>Comparable</code>
+ * @param comparator {@code Comparator} used to compare the objects,
+ * {@code null} means treat lhs as {@code Comparable}
* @return this - used to chain append calls
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
* @since 2.0
*/
public CompareToBuilder append(final Object lhs, final Object rhs, final Comparator<?> comparator) {
@@ -464,8 +464,8 @@ public class CompareToBuilder implements Builder<Integer> {
//-------------------------------------------------------------------------
/**
- * Appends to the <code>builder</code> the comparison of
- * two <code>long</code>s.
+ * Appends to the {@code builder} the comparison of
+ * two {@code long}s.
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -480,8 +480,8 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * Appends to the <code>builder</code> the comparison of
- * two <code>int</code>s.
+ * Appends to the {@code builder} the comparison of
+ * two {@code int}s.
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -496,8 +496,8 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * Appends to the <code>builder</code> the comparison of
- * two <code>short</code>s.
+ * Appends to the {@code builder} the comparison of
+ * two {@code short}s.
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -512,8 +512,8 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * Appends to the <code>builder</code> the comparison of
- * two <code>char</code>s.
+ * Appends to the {@code builder} the comparison of
+ * two {@code char}s.
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -528,8 +528,8 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * Appends to the <code>builder</code> the comparison of
- * two <code>byte</code>s.
+ * Appends to the {@code builder} the comparison of
+ * two {@code byte}s.
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -544,13 +544,13 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the comparison of
- * two <code>double</code>s.</p>
+ * <p>Appends to the {@code builder} the comparison of
+ * two {@code double}s.</p>
*
- * <p>This handles NaNs, Infinities, and <code>-0.0</code>.</p>
+ * <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * <code>HashCodeBuilder</code>.</p>
+ * {@code HashCodeBuilder}.</p>
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -565,13 +565,13 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the comparison of
- * two <code>float</code>s.</p>
+ * <p>Appends to the {@code builder} the comparison of
+ * two {@code float}s.</p>
*
- * <p>This handles NaNs, Infinities, and <code>-0.0</code>.</p>
+ * <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * <code>HashCodeBuilder</code>.</p>
+ * {@code HashCodeBuilder}.</p>
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -586,8 +586,8 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * Appends to the <code>builder</code> the comparison of
- * two <code>booleans</code>s.
+ * Appends to the {@code builder} the comparison of
+ * two {@code booleans}s.
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -610,12 +610,12 @@ public class CompareToBuilder implements Builder<Integer> {
//-----------------------------------------------------------------------
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>Object</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code Object} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a short length array is less than a long length array</li>
* <li>Check array contents element by element using {@link #append(Object, Object, Comparator)}</li>
* </ol>
@@ -626,20 +626,20 @@ public class CompareToBuilder implements Builder<Integer> {
* @param lhs left-hand array
* @param rhs right-hand array
* @return this - used to chain append calls
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
*/
public CompareToBuilder append(final Object[] lhs, final Object[] rhs) {
return append(lhs, rhs, null);
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>Object</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code Object} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a short length array is less than a long length array</li>
* <li>Check array contents element by element using {@link #append(Object, Object, Comparator)}</li>
* </ol>
@@ -649,11 +649,11 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand array
* @param rhs right-hand array
- * @param comparator <code>Comparator</code> to use to compare the array elements,
- * <code>null</code> means to treat <code>lhs</code> elements as <code>Comparable</code>.
+ * @param comparator {@code Comparator} to use to compare the array elements,
+ * {@code null} means to treat {@code lhs} elements as {@code Comparable}.
* @return this - used to chain append calls
- * @throws ClassCastException if <code>rhs</code> is not assignment-compatible
- * with <code>lhs</code>
+ * @throws ClassCastException if {@code rhs} is not assignment-compatible
+ * with {@code lhs}
* @since 2.0
*/
public CompareToBuilder append(final Object[] lhs, final Object[] rhs, final Comparator<?> comparator) {
@@ -682,12 +682,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>long</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code long} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(long, long)}</li>
* </ol>
@@ -722,12 +722,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>int</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code int} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(int, int)}</li>
* </ol>
@@ -762,12 +762,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>short</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code short} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(short, short)}</li>
* </ol>
@@ -802,12 +802,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>char</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code char} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(char, char)}</li>
* </ol>
@@ -842,12 +842,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>byte</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code byte} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(byte, byte)}</li>
* </ol>
@@ -882,12 +882,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>double</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code double} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(double, double)}</li>
* </ol>
@@ -922,12 +922,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>float</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code float} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(float, float)}</li>
* </ol>
@@ -962,12 +962,12 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Appends to the <code>builder</code> the deep comparison of
- * two <code>boolean</code> arrays.</p>
+ * <p>Appends to the {@code builder} the deep comparison of
+ * two {@code boolean} arrays.</p>
*
* <ol>
- * <li>Check if arrays are the same using <code>==</code></li>
- * <li>Check if for <code>null</code>, <code>null</code> is less than non-<code>null</code></li>
+ * <li>Check if arrays are the same using {@code ==}</li>
+ * <li>Check if for {@code null}, {@code null} is less than non-{@code null}</li>
* <li>Check array length, a shorter length array is less than a longer length array</li>
* <li>Check array contents element by element using {@link #append(boolean, boolean)}</li>
* </ol>
@@ -1004,7 +1004,7 @@ public class CompareToBuilder implements Builder<Integer> {
//-----------------------------------------------------------------------
/**
* Returns a negative integer, a positive integer, or zero as
- * the <code>builder</code> has judged the "left-hand" side
+ * the {@code builder} has judged the "left-hand" side
* as less than, greater than, or equal to the "right-hand"
* side.
*
@@ -1017,7 +1017,7 @@ public class CompareToBuilder implements Builder<Integer> {
/**
* Returns a negative Integer, a positive Integer, or zero as
- * the <code>builder</code> has judged the "left-hand" side
+ * the {@code builder} has judged the "left-hand" side
* as less than, greater than, or equal to the "right-hand"
* side.
*
diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
index f37e0e8..30c8a1a 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -35,9 +35,9 @@ import org.apache.commons.lang3.tuple.Pair;
* <p> This class provides methods to build a good equals method for any
* class. It follows rules laid out in
* <a href="http://www.oracle.com/technetwork/java/effectivejava-136174.html">Effective Java</a>
- * , by Joshua Bloch. In particular the rule for comparing <code>doubles</code>,
- * <code>floats</code>, and arrays can be tricky. Also, making sure that
- * <code>equals()</code> and <code>hashCode()</code> are consistent can be
+ * , by Joshua Bloch. In particular the rule for comparing {@code doubles},
+ * {@code floats}, and arrays can be tricky. Also, making sure that
+ * {@code equals()} and {@code hashCode()} are consistent can be
* difficult.</p>
*
* <p>Two Objects that compare as equals must generate the same hash code,
@@ -68,11 +68,11 @@ import org.apache.commons.lang3.tuple.Pair;
*
* <p> Alternatively, there is a method that uses reflection to determine
* the fields to test. Because these fields are usually private, the method,
- * <code>reflectionEquals</code>, uses <code>AccessibleObject.setAccessible</code> to
+ * {@code reflectionEquals}, uses {@code AccessibleObject.setAccessible} to
* change the visibility of the fields. This will fail under a security
* manager, unless the appropriate permissions are set up correctly. It is
* also slower than testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
* <p> A typical invocation for this method would look like:</p>
* <pre>
@@ -82,7 +82,7 @@ import org.apache.commons.lang3.tuple.Pair;
* </pre>
*
* <p>The {@link EqualsExclude} annotation can be used to exclude fields from being
- * used by the <code>reflectionEquals</code> methods.</p>
+ * used by the {@code reflectionEquals} methods.</p>
*
* @since 1.0
*/
@@ -132,7 +132,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* Converters value pair into a register pair.
* </p>
*
- * @param lhs <code>this</code> object
+ * @param lhs {@code this} object
* @param rhs the other object
*
* @return the pair
@@ -145,15 +145,15 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
* <p>
- * Returns <code>true</code> if the registry contains the given object pair.
+ * Returns {@code true} if the registry contains the given object pair.
* Used by the reflection methods to avoid infinite loops.
* Objects might be swapped therefore a check is needed if the object pair
* is registered in given or swapped order.
* </p>
*
- * @param lhs <code>this</code> object to lookup in registry
+ * @param lhs {@code this} object to lookup in registry
* @param rhs the other object to lookup on registry
- * @return boolean <code>true</code> if the registry contains the given object.
+ * @return boolean {@code true} if the registry contains the given object.
* @since 3.0
*/
static boolean isRegistered(final Object lhs, final Object rhs) {
@@ -171,7 +171,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* Used by the reflection methods to avoid infinite loops.
* </p>
*
- * @param lhs <code>this</code> object to register
+ * @param lhs {@code this} object to register
* @param rhs the other object to register
*/
private static void register(final Object lhs, final Object rhs) {
@@ -192,7 +192,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* <p>
* Used by the reflection methods to avoid infinite loops.
*
- * @param lhs <code>this</code> object to unregister
+ * @param lhs {@code this} object to unregister
* @param rhs the other object to unregister
* @since 3.0
*/
@@ -209,7 +209,7 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
* If the fields tested are equals.
- * The default value is <code>true</code>.
+ * The default value is {@code true}.
*/
private boolean isEquals = true;
@@ -222,7 +222,7 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
* <p>Constructor for EqualsBuilder.</p>
*
- * <p>Starts off assuming that equals is <code>true</code>.</p>
+ * <p>Starts off assuming that equals is {@code true}.</p>
* @see Object#equals(Object)
*/
public EqualsBuilder() {
@@ -256,13 +256,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Set <code>Class</code>es whose instances should be compared by calling their <code>equals</code>
+ * <p>Set {@code Class}es whose instances should be compared by calling their {@code equals}
* although being in recursive mode. So the fields of theses classes will not be compared recursively by reflection.</p>
*
* <p>Here you should name classes having non-transient fields which are cache fields being set lazily.<br>
* Prominent example being {@link String} class with its hash code cache field. Due to the importance
- * of the <code>String</code> class, it is included in the default bypasses classes. Usually, if you use
- * your own set of classes here, remember to include <code>String</code> class, too.</p>
+ * of the {@code String} class, it is included in the default bypasses classes. Usually, if you use
+ * your own set of classes here, remember to include {@code String} class, too.</p>
* @param bypassReflectionClasses classes to bypass reflection test
* @return EqualsBuilder - used to chain calls.
* @since 3.8
@@ -296,24 +296,24 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
- * <p>This method uses reflection to determine if the two <code>Object</code>s
+ * <p>This method uses reflection to determine if the two {@code Object}s
* are equal.</p>
*
- * <p>It uses <code>AccessibleObject.setAccessible</code> to gain access to private
+ * <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
* fields. This means that it will throw a security exception if run under
* a security manager, if the permissions are not set up correctly. It is also
* not as efficient as testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
* <p>Transient members will be not be tested, as they are likely derived
* fields, and not part of the value of the Object.</p>
*
* <p>Static fields will not be tested. Superclass fields will be included.</p>
*
- * @param lhs <code>this</code> object
+ * @param lhs {@code this} object
* @param rhs the other object
* @param excludeFields Collection of String field names to exclude from testing
- * @return <code>true</code> if the two Objects have tested equals.
+ * @return {@code true} if the two Objects have tested equals.
*
* @see EqualsExclude
*/
@@ -322,24 +322,24 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two <code>Object</code>s
+ * <p>This method uses reflection to determine if the two {@code Object}s
* are equal.</p>
*
- * <p>It uses <code>AccessibleObject.setAccessible</code> to gain access to private
+ * <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
* fields. This means that it will throw a security exception if run under
* a security manager, if the permissions are not set up correctly. It is also
* not as efficient as testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
* <p>Transient members will be not be tested, as they are likely derived
* fields, and not part of the value of the Object.</p>
*
* <p>Static fields will not be tested. Superclass fields will be included.</p>
*
- * @param lhs <code>this</code> object
+ * @param lhs {@code this} object
* @param rhs the other object
* @param excludeFields array of field names to exclude from testing
- * @return <code>true</code> if the two Objects have tested equals.
+ * @return {@code true} if the two Objects have tested equals.
*
* @see EqualsExclude
*/
@@ -348,25 +348,25 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two <code>Object</code>s
+ * <p>This method uses reflection to determine if the two {@code Object}s
* are equal.</p>
*
- * <p>It uses <code>AccessibleObject.setAccessible</code> to gain access to private
+ * <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
* fields. This means that it will throw a security exception if run under
* a security manager, if the permissions are not set up correctly. It is also
* not as efficient as testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
- * <p>If the TestTransients parameter is set to <code>true</code>, transient
+ * <p>If the TestTransients parameter is set to {@code true}, transient
* members will be tested, otherwise they are ignored, as they are likely
- * derived fields, and not part of the value of the <code>Object</code>.</p>
+ * derived fields, and not part of the value of the {@code Object}.</p>
*
* <p>Static fields will not be tested. Superclass fields will be included.</p>
*
- * @param lhs <code>this</code> object
+ * @param lhs {@code this} object
* @param rhs the other object
* @param testTransients whether to include transient fields
- * @return <code>true</code> if the two Objects have tested equals.
+ * @return {@code true} if the two Objects have tested equals.
*
* @see EqualsExclude
*/
@@ -375,30 +375,30 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two <code>Object</code>s
+ * <p>This method uses reflection to determine if the two {@code Object}s
* are equal.</p>
*
- * <p>It uses <code>AccessibleObject.setAccessible</code> to gain access to private
+ * <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
* fields. This means that it will throw a security exception if run under
* a security manager, if the permissions are not set up correctly. It is also
* not as efficient as testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
- * <p>If the testTransients parameter is set to <code>true</code>, transient
+ * <p>If the testTransients parameter is set to {@code true}, transient
* members will be tested, otherwise they are ignored, as they are likely
- * derived fields, and not part of the value of the <code>Object</code>.</p>
+ * derived fields, and not part of the value of the {@code Object}.</p>
*
* <p>Static fields will not be included. Superclass fields will be appended
* up to and including the specified superclass. A null superclass is treated
* as java.lang.Object.</p>
*
- * @param lhs <code>this</code> object
+ * @param lhs {@code this} object
* @param rhs the other object
* @param testTransients whether to include transient fields
* @param reflectUpToClass the superclass to reflect up to (inclusive),
- * may be <code>null</code>
+ * may be {@code null}
* @param excludeFields array of field names to exclude from testing
- * @return <code>true</code> if the two Objects have tested equals.
+ * @return {@code true} if the two Objects have tested equals.
*
* @see EqualsExclude
* @since 2.0
@@ -409,37 +409,37 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two <code>Object</code>s
+ * <p>This method uses reflection to determine if the two {@code Object}s
* are equal.</p>
*
- * <p>It uses <code>AccessibleObject.setAccessible</code> to gain access to private
+ * <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
* fields. This means that it will throw a security exception if run under
* a security manager, if the permissions are not set up correctly. It is also
* not as efficient as testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
- * <p>If the testTransients parameter is set to <code>true</code>, transient
+ * <p>If the testTransients parameter is set to {@code true}, transient
* members will be tested, otherwise they are ignored, as they are likely
- * derived fields, and not part of the value of the <code>Object</code>.</p>
+ * derived fields, and not part of the value of the {@code Object}.</p>
*
* <p>Static fields will not be included. Superclass fields will be appended
* up to and including the specified superclass. A null superclass is treated
* as java.lang.Object.</p>
*
- * <p>If the testRecursive parameter is set to <code>true</code>, non primitive
+ * <p>If the testRecursive parameter is set to {@code true}, non primitive
* (and non primitive wrapper) field types will be compared by
- * <code>EqualsBuilder</code> recursively instead of invoking their
- * <code>equals()</code> method. Leading to a deep reflection equals test.
+ * {@code EqualsBuilder} recursively instead of invoking their
+ * {@code equals()} method. Leading to a deep reflection equals test.
*
- * @param lhs <code>this</code> object
+ * @param lhs {@code this} object
* @param rhs the other object
* @param testTransients whether to include transient fields
* @param reflectUpToClass the superclass to reflect up to (inclusive),
- * may be <code>null</code>
+ * may be {@code null}
* @param testRecursive whether to call reflection equals on non primitive
* fields recursively.
* @param excludeFields array of field names to exclude from testing
- * @return <code>true</code> if the two Objects have tested equals.
+ * @return {@code true} if the two Objects have tested equals.
*
* @see EqualsExclude
* @since 3.6
@@ -462,26 +462,26 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Tests if two <code>objects</code> by using reflection.</p>
+ * <p>Tests if two {@code objects} by using reflection.</p>
*
- * <p>It uses <code>AccessibleObject.setAccessible</code> to gain access to private
+ * <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
* fields. This means that it will throw a security exception if run under
* a security manager, if the permissions are not set up correctly. It is also
* not as efficient as testing explicitly. Non-primitive fields are compared using
- * <code>equals()</code>.</p>
+ * {@code equals()}.</p>
*
- * <p>If the testTransients field is set to <code>true</code>, transient
+ * <p>If the testTransients field is set to {@code true}, transient
* members will be tested, otherwise they are ignored, as they are likely
- * derived fields, and not part of the value of the <code>Object</code>.</p>
+ * derived fields, and not part of the value of the {@code Object}.</p>
*
* <p>Static fields will not be included. Superclass fields will be appended
- * up to and including the specified superclass in field <code>reflectUpToClass</code>.
+ * up to and including the specified superclass in field {@code reflectUpToClass}.
* A null superclass is treated as java.lang.Object.</p>
*
- * <p>Field names listed in field <code>excludeFields</code> will be ignored.</p>
+ * <p>Field names listed in field {@code excludeFields} will be ignored.</p>
*
* <p>If either class of the compared objects is contained in
- * <code>bypassReflectionClasses</code>, both objects are compared by calling
+ * {@code bypassReflectionClasses}, both objects are compared by calling
* the equals method of the left hand object with the right hand object as an argument.</p>
*
* @param lhs the left hand object
@@ -598,9 +598,9 @@ public class EqualsBuilder implements Builder<Boolean> {
//-------------------------------------------------------------------------
/**
- * <p>Adds the result of <code>super.equals()</code> to this builder.</p>
+ * <p>Adds the result of {@code super.equals()} to this builder.</p>
*
- * @param superEquals the result of calling <code>super.equals()</code>
+ * @param superEquals the result of calling {@code super.equals()}
* @return EqualsBuilder - used to chain calls.
* @since 2.0
*/
@@ -615,11 +615,11 @@ public class EqualsBuilder implements Builder<Boolean> {
//-------------------------------------------------------------------------
/**
- * <p>Test if two <code>Object</code>s are equal using either
+ * <p>Test if two {@code Object}s are equal using either
* #{@link #reflectionAppend(Object, Object)}, if object are non
- * primitives (or wrapper of primitives) or if field <code>testRecursive</code>
- * is set to <code>false</code>. Otherwise, using their
- * <code>equals</code> method.</p>
+ * primitives (or wrapper of primitives) or if field {@code testRecursive}
+ * is set to {@code false}. Otherwise, using their
+ * {@code equals} method.</p>
*
* @param lhs the left hand object
* @param rhs the right hand object
@@ -653,7 +653,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if an <code>Object</code> is equal to an array.</p>
+ * <p>Test if an {@code Object} is equal to an array.</p>
*
* @param lhs the left hand object, an array
* @param rhs the right hand object
@@ -688,13 +688,13 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
* <p>
- * Test if two <code>long</code> s are equal.
+ * Test if two {@code long} s are equal.
* </p>
*
* @param lhs
- * the left hand <code>long</code>
+ * the left hand {@code long}
* @param rhs
- * the right hand <code>long</code>
+ * the right hand {@code long}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final long lhs, final long rhs) {
@@ -706,10 +706,10 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>int</code>s are equal.</p>
+ * <p>Test if two {@code int}s are equal.</p>
*
- * @param lhs the left hand <code>int</code>
- * @param rhs the right hand <code>int</code>
+ * @param lhs the left hand {@code int}
+ * @param rhs the right hand {@code int}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final int lhs, final int rhs) {
@@ -721,10 +721,10 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>short</code>s are equal.</p>
+ * <p>Test if two {@code short}s are equal.</p>
*
- * @param lhs the left hand <code>short</code>
- * @param rhs the right hand <code>short</code>
+ * @param lhs the left hand {@code short}
+ * @param rhs the right hand {@code short}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final short lhs, final short rhs) {
@@ -736,10 +736,10 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>char</code>s are equal.</p>
+ * <p>Test if two {@code char}s are equal.</p>
*
- * @param lhs the left hand <code>char</code>
- * @param rhs the right hand <code>char</code>
+ * @param lhs the left hand {@code char}
+ * @param rhs the right hand {@code char}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final char lhs, final char rhs) {
@@ -751,10 +751,10 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>byte</code>s are equal.</p>
+ * <p>Test if two {@code byte}s are equal.</p>
*
- * @param lhs the left hand <code>byte</code>
- * @param rhs the right hand <code>byte</code>
+ * @param lhs the left hand {@code byte}
+ * @param rhs the right hand {@code byte}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final byte lhs, final byte rhs) {
@@ -766,16 +766,16 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>double</code>s are equal by testing that the
- * pattern of bits returned by <code>doubleToLong</code> are equal.</p>
+ * <p>Test if two {@code double}s are equal by testing that the
+ * pattern of bits returned by {@code doubleToLong} are equal.</p>
*
- * <p>This handles NaNs, Infinities, and <code>-0.0</code>.</p>
+ * <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * <code>HashCodeBuilder</code>.</p>
+ * {@code HashCodeBuilder}.</p>
*
- * @param lhs the left hand <code>double</code>
- * @param rhs the right hand <code>double</code>
+ * @param lhs the left hand {@code double}
+ * @param rhs the right hand {@code double}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final double lhs, final double rhs) {
@@ -786,16 +786,16 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>float</code>s are equal by testing that the
+ * <p>Test if two {@code float}s are equal by testing that the
* pattern of bits returned by doubleToLong are equal.</p>
*
- * <p>This handles NaNs, Infinities, and <code>-0.0</code>.</p>
+ * <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * <code>HashCodeBuilder</code>.</p>
+ * {@code HashCodeBuilder}.</p>
*
- * @param lhs the left hand <code>float</code>
- * @param rhs the right hand <code>float</code>
+ * @param lhs the left hand {@code float}
+ * @param rhs the right hand {@code float}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final float lhs, final float rhs) {
@@ -806,10 +806,10 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two <code>booleans</code>s are equal.</p>
+ * <p>Test if two {@code booleans}s are equal.</p>
*
- * @param lhs the left hand <code>boolean</code>
- * @param rhs the right hand <code>boolean</code>
+ * @param lhs the left hand {@code boolean}
+ * @param rhs the right hand {@code boolean}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final boolean lhs, final boolean rhs) {
@@ -821,7 +821,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Performs a deep comparison of two <code>Object</code> arrays.</p>
+ * <p>Performs a deep comparison of two {@code Object} arrays.</p>
*
* <p>This also will be called for the top level of
* multi-dimensional, ragged, and multi-typed arrays.</p>
@@ -829,8 +829,8 @@ public class EqualsBuilder implements Builder<Boolean> {
* <p>Note that this method does not compare the type of the arrays; it only
* compares the contents.</p>
*
- * @param lhs the left hand <code>Object[]</code>
- * @param rhs the right hand <code>Object[]</code>
+ * @param lhs the left hand {@code Object[]}
+ * @param rhs the right hand {@code Object[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final Object[] lhs, final Object[] rhs) {
@@ -855,13 +855,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>long</code>. Length and all
+ * <p>Deep comparison of array of {@code long}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(long, long)} is used.</p>
*
- * @param lhs the left hand <code>long[]</code>
- * @param rhs the right hand <code>long[]</code>
+ * @param lhs the left hand {@code long[]}
+ * @param rhs the right hand {@code long[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final long[] lhs, final long[] rhs) {
@@ -886,13 +886,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>int</code>. Length and all
+ * <p>Deep comparison of array of {@code int}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(int, int)} is used.</p>
*
- * @param lhs the left hand <code>int[]</code>
- * @param rhs the right hand <code>int[]</code>
+ * @param lhs the left hand {@code int[]}
+ * @param rhs the right hand {@code int[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final int[] lhs, final int[] rhs) {
@@ -917,13 +917,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>short</code>. Length and all
+ * <p>Deep comparison of array of {@code short}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(short, short)} is used.</p>
*
- * @param lhs the left hand <code>short[]</code>
- * @param rhs the right hand <code>short[]</code>
+ * @param lhs the left hand {@code short[]}
+ * @param rhs the right hand {@code short[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final short[] lhs, final short[] rhs) {
@@ -948,13 +948,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>char</code>. Length and all
+ * <p>Deep comparison of array of {@code char}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(char, char)} is used.</p>
*
- * @param lhs the left hand <code>char[]</code>
- * @param rhs the right hand <code>char[]</code>
+ * @param lhs the left hand {@code char[]}
+ * @param rhs the right hand {@code char[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final char[] lhs, final char[] rhs) {
@@ -979,13 +979,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>byte</code>. Length and all
+ * <p>Deep comparison of array of {@code byte}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(byte, byte)} is used.</p>
*
- * @param lhs the left hand <code>byte[]</code>
- * @param rhs the right hand <code>byte[]</code>
+ * @param lhs the left hand {@code byte[]}
+ * @param rhs the right hand {@code byte[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final byte[] lhs, final byte[] rhs) {
@@ -1010,13 +1010,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>double</code>. Length and all
+ * <p>Deep comparison of array of {@code double}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(double, double)} is used.</p>
*
- * @param lhs the left hand <code>double[]</code>
- * @param rhs the right hand <code>double[]</code>
+ * @param lhs the left hand {@code double[]}
+ * @param rhs the right hand {@code double[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final double[] lhs, final double[] rhs) {
@@ -1041,13 +1041,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>float</code>. Length and all
+ * <p>Deep comparison of array of {@code float}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(float, float)} is used.</p>
*
- * @param lhs the left hand <code>float[]</code>
- * @param rhs the right hand <code>float[]</code>
+ * @param lhs the left hand {@code float[]}
+ * @param rhs the right hand {@code float[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final float[] lhs, final float[] rhs) {
@@ -1072,13 +1072,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Deep comparison of array of <code>boolean</code>. Length and all
+ * <p>Deep comparison of array of {@code boolean}. Length and all
* values are compared.</p>
*
* <p>The method {@link #append(boolean, boolean)} is used.</p>
*
- * @param lhs the left hand <code>boolean[]</code>
- * @param rhs the right hand <code>boolean[]</code>
+ * @param lhs the left hand {@code boolean[]}
+ * @param rhs the right hand {@code boolean[]}
* @return EqualsBuilder - used to chain calls.
*/
public EqualsBuilder append(final boolean[] lhs, final boolean[] rhs) {
@@ -1103,7 +1103,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Returns <code>true</code> if the fields that have been checked
+ * <p>Returns {@code true} if the fields that have been checked
* are all equal.</p>
*
* @return boolean
@@ -1113,11 +1113,11 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Returns <code>true</code> if the fields that have been checked
+ * <p>Returns {@code true} if the fields that have been checked
* are all equal.</p>
*
- * @return <code>true</code> if all of the fields that have been checked
- * are equal, <code>false</code> otherwise.
+ * @return {@code true} if all of the fields that have been checked
+ * are equal, {@code false} otherwise.
*
* @since 3.0
*/
@@ -1127,7 +1127,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * Sets the <code>isEquals</code> value.
+ * Sets the {@code isEquals} value.
*
* @param isEquals The value to set.
* @since 2.1
diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
index 21ec4bb..f6b4d3e 100755
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java
@@ -24,7 +24,7 @@ import java.lang.annotation.Target;
/**
* Use this annotation to exclude a field from being used by
- * the various <code>reflectionEquals</code> methods defined on
+ * the various {@code reflectionEquals} methods defined on
* {@link EqualsBuilder}.
*
* @since 3.5
diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
index 666d72e..90d4fab 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -35,9 +35,9 @@ import org.apache.commons.lang3.Validate;
* </p>
*
* <p>
- * This class enables a good <code>hashCode</code> method to be built for any class. It follows the rules laid out in
+ * This class enables a good {@code hashCode} method to be built for any class. It follows the rules laid out in
* the book <a href="http://www.oracle.com/technetwork/java/effectivejava-136174.html">Effective Java</a> by Joshua Bloch. Writing a
- * good <code>hashCode</code> method is actually quite difficult. This class aims to simplify the process.
+ * good {@code hashCode} method is actually quite difficult. This class aims to simplify the process.
* </p>
*
* <p>
@@ -48,8 +48,8 @@ import org.apache.commons.lang3.Validate;
* </p>
*
* <p>
- * All relevant fields from the object should be included in the <code>hashCode</code> method. Derived fields may be
- * excluded. In general, any field used in the <code>equals</code> method must be used in the <code>hashCode</code>
+ * All relevant fields from the object should be included in the {@code hashCode} method. Derived fields may be
+ * excluded. In general, any field used in the {@code equals} method must be used in the {@code hashCode}
* method.
* </p>
*
@@ -77,12 +77,12 @@ import org.apache.commons.lang3.Validate;
* </pre>
*
* <p>
- * If required, the superclass <code>hashCode()</code> can be added using {@link #appendSuper}.
+ * If required, the superclass {@code hashCode()} can be added using {@link #appendSuper}.
* </p>
*
* <p>
* Alternatively, there is a method that uses reflection to determine the fields to test. Because these fields are
- * usually private, the method, <code>reflectionHashCode</code>, uses <code>AccessibleObject.setAccessible</code>
+ * usually private, the method, {@code reflectionHashCode}, uses {@code AccessibleObject.setAccessible}
* to change the visibility of the fields. This will fail under a security manager, unless the appropriate permissions
* are set up correctly. It is also slower than testing explicitly.
* </p>
@@ -98,7 +98,7 @@ import org.apache.commons.lang3.Validate;
* </pre>
*
* <p>The {@link HashCodeExclude} annotation can be used to exclude fields from being
- * used by the <code>reflectionHashCode</code> methods.</p>
+ * used by the {@code reflectionHashCode} methods.</p>
*
* @since 1.0
*/
@@ -153,13 +153,13 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Returns <code>true</code> if the registry contains the given object. Used by the reflection methods to avoid
+ * Returns {@code true} if the registry contains the given object. Used by the reflection methods to avoid
* infinite loops.
* </p>
*
* @param value
* The object to lookup in the registry.
- * @return boolean <code>true</code> if the registry contains the given object.
+ * @return boolean {@code true} if the registry contains the given object.
* @since 2.3
*/
static boolean isRegistered(final Object value) {
@@ -169,7 +169,7 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Appends the fields and values defined by the given object of the given <code>Class</code>.
+ * Appends the fields and values defined by the given object of the given {@code Class}.
* </p>
*
* @param object
@@ -221,14 +221,14 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
* Transient members will be not be used, as they are likely derived fields, and not part of the value of the
- * <code>Object</code>.
+ * {@code Object}.
* </p>
*
* <p>
@@ -246,10 +246,10 @@ public class HashCodeBuilder implements Builder<Integer> {
* @param multiplierNonZeroOddNumber
* a non-zero, odd number used as the multiplier
* @param object
- * the Object to create a <code>hashCode</code> for
+ * the Object to create a {@code hashCode} for
* @return int hash code
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
* @throws IllegalArgumentException
* if the number is zero or even
*
@@ -265,14 +265,14 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
- * If the TestTransients parameter is set to <code>true</code>, transient members will be tested, otherwise they
- * are ignored, as they are likely derived fields, and not part of the value of the <code>Object</code>.
+ * If the TestTransients parameter is set to {@code true}, transient members will be tested, otherwise they
+ * are ignored, as they are likely derived fields, and not part of the value of the {@code Object}.
* </p>
*
* <p>
@@ -290,12 +290,12 @@ public class HashCodeBuilder implements Builder<Integer> {
* @param multiplierNonZeroOddNumber
* a non-zero, odd number used as the multiplier
* @param object
- * the Object to create a <code>hashCode</code> for
+ * the Object to create a {@code hashCode} for
* @param testTransients
* whether to include transient fields
* @return int hash code
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
* @throws IllegalArgumentException
* if the number is zero or even
*
@@ -312,14 +312,14 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
- * If the TestTransients parameter is set to <code>true</code>, transient members will be tested, otherwise they
- * are ignored, as they are likely derived fields, and not part of the value of the <code>Object</code>.
+ * If the TestTransients parameter is set to {@code true}, transient members will be tested, otherwise they
+ * are ignored, as they are likely derived fields, and not part of the value of the {@code Object}.
* </p>
*
* <p>
@@ -340,16 +340,16 @@ public class HashCodeBuilder implements Builder<Integer> {
* @param multiplierNonZeroOddNumber
* a non-zero, odd number used as the multiplier
* @param object
- * the Object to create a <code>hashCode</code> for
+ * the Object to create a {@code hashCode} for
* @param testTransients
* whether to include transient fields
* @param reflectUpToClass
- * the superclass to reflect up to (inclusive), may be <code>null</code>
+ * the superclass to reflect up to (inclusive), may be {@code null}
* @param excludeFields
* array of field names to exclude from use in calculation of hash code
* @return int hash code
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
* @throws IllegalArgumentException
* if the number is zero or even
*
@@ -379,14 +379,14 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <P>
- * If the TestTransients parameter is set to <code>true</code>, transient members will be tested, otherwise they
- * are ignored, as they are likely derived fields, and not part of the value of the <code>Object</code>.
+ * If the TestTransients parameter is set to {@code true}, transient members will be tested, otherwise they
+ * are ignored, as they are likely derived fields, and not part of the value of the {@code Object}.
* </p>
*
* <p>
@@ -395,12 +395,12 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* @param object
- * the Object to create a <code>hashCode</code> for
+ * the Object to create a {@code hashCode} for
* @param testTransients
* whether to include transient fields
* @return int hash code
* @throws IllegalArgumentException
- * if the object is <code>null</code>
+ * if the object is {@code null}
*
* @see HashCodeExclude
*/
@@ -419,14 +419,14 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
* Transient members will be not be used, as they are likely derived fields, and not part of the value of the
- * <code>Object</code>.
+ * {@code Object}.
* </p>
*
* <p>
@@ -435,12 +435,12 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* @param object
- * the Object to create a <code>hashCode</code> for
+ * the Object to create a {@code hashCode} for
* @param excludeFields
* Collection of String field names to exclude from use in calculation of hash code
* @return int hash code
* @throws IllegalArgumentException
- * if the object is <code>null</code>
+ * if the object is {@code null}
*
* @see HashCodeExclude
*/
@@ -460,14 +460,14 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
* Transient members will be not be used, as they are likely derived fields, and not part of the value of the
- * <code>Object</code>.
+ * {@code Object}.
* </p>
*
* <p>
@@ -476,12 +476,12 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* @param object
- * the Object to create a <code>hashCode</code> for
+ * the Object to create a {@code hashCode} for
* @param excludeFields
* array of field names to exclude from use in calculation of hash code
* @return int hash code
* @throws IllegalArgumentException
- * if the object is <code>null</code>
+ * if the object is {@code null}
*
* @see HashCodeExclude
*/
@@ -541,7 +541,7 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Uses two hard coded choices for the constants needed to build a <code>hashCode</code>.
+ * Uses two hard coded choices for the constants needed to build a {@code hashCode}.
* </p>
*/
public HashCodeBuilder() {
@@ -575,23 +575,23 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>boolean</code>.
+ * Append a {@code hashCode} for a {@code boolean}.
* </p>
* <p>
- * This adds <code>1</code> when true, and <code>0</code> when false to the <code>hashCode</code>.
+ * This adds {@code 1} when true, and {@code 0} when false to the {@code hashCode}.
* </p>
* <p>
- * This is in contrast to the standard <code>java.lang.Boolean.hashCode</code> handling, which computes
- * a <code>hashCode</code> value of <code>1231</code> for <code>java.lang.Boolean</code> instances
- * that represent <code>true</code> or <code>1237</code> for <code>java.lang.Boolean</code> instances
- * that represent <code>false</code>.
+ * This is in contrast to the standard {@code java.lang.Boolean.hashCode} handling, which computes
+ * a {@code hashCode} value of {@code 1231} for {@code java.lang.Boolean} instances
+ * that represent {@code true} or {@code 1237} for {@code java.lang.Boolean} instances
+ * that represent {@code false}.
* </p>
* <p>
* This is in accordance with the <i>Effective Java</i> design.
* </p>
*
* @param value
- * the boolean to add to the <code>hashCode</code>
+ * the boolean to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final boolean value) {
@@ -601,11 +601,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>boolean</code> array.
+ * Append a {@code hashCode} for a {@code boolean} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final boolean[] array) {
@@ -623,11 +623,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>byte</code>.
+ * Append a {@code hashCode} for a {@code byte}.
* </p>
*
* @param value
- * the byte to add to the <code>hashCode</code>
+ * the byte to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final byte value) {
@@ -639,11 +639,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>byte</code> array.
+ * Append a {@code hashCode} for a {@code byte} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final byte[] array) {
@@ -659,11 +659,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>char</code>.
+ * Append a {@code hashCode} for a {@code char}.
* </p>
*
* @param value
- * the char to add to the <code>hashCode</code>
+ * the char to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final char value) {
@@ -673,11 +673,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>char</code> array.
+ * Append a {@code hashCode} for a {@code char} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final char[] array) {
@@ -693,11 +693,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>double</code>.
+ * Append a {@code hashCode} for a {@code double}.
* </p>
*
* @param value
- * the double to add to the <code>hashCode</code>
+ * the double to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final double value) {
@@ -706,11 +706,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>double</code> array.
+ * Append a {@code hashCode} for a {@code double} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final double[] array) {
@@ -726,11 +726,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>float</code>.
+ * Append a {@code hashCode} for a {@code float}.
* </p>
*
* @param value
- * the float to add to the <code>hashCode</code>
+ * the float to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final float value) {
@@ -740,11 +740,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>float</code> array.
+ * Append a {@code hashCode} for a {@code float} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final float[] array) {
@@ -760,11 +760,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for an <code>int</code>.
+ * Append a {@code hashCode} for an {@code int}.
* </p>
*
* @param value
- * the int to add to the <code>hashCode</code>
+ * the int to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final int value) {
@@ -774,11 +774,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for an <code>int</code> array.
+ * Append a {@code hashCode} for an {@code int} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final int[] array) {
@@ -794,11 +794,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>long</code>.
+ * Append a {@code hashCode} for a {@code long}.
* </p>
*
* @param value
- * the long to add to the <code>hashCode</code>
+ * the long to add to the {@code hashCode}
* @return this
*/
// NOTE: This method uses >> and not >>> as Effective Java and
@@ -812,11 +812,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>long</code> array.
+ * Append a {@code hashCode} for a {@code long} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final long[] array) {
@@ -832,11 +832,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for an <code>Object</code>.
+ * Append a {@code hashCode} for an {@code Object}.
* </p>
*
* @param object
- * the Object to add to the <code>hashCode</code>
+ * the Object to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final Object object) {
@@ -857,11 +857,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for an array.
+ * Append a {@code hashCode} for an array.
* </p>
*
* @param object
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
*/
private void appendArray(final Object object) {
// 'Switch' on type of array, to dispatch to the correct handler
@@ -890,11 +890,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for an <code>Object</code> array.
+ * Append a {@code hashCode} for an {@code Object} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final Object[] array) {
@@ -910,11 +910,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>short</code>.
+ * Append a {@code hashCode} for a {@code short}.
* </p>
*
* @param value
- * the short to add to the <code>hashCode</code>
+ * the short to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final short value) {
@@ -924,11 +924,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a <code>hashCode</code> for a <code>short</code> array.
+ * Append a {@code hashCode} for a {@code short} array.
* </p>
*
* @param array
- * the array to add to the <code>hashCode</code>
+ * the array to add to the {@code hashCode}
* @return this
*/
public HashCodeBuilder append(final short[] array) {
@@ -948,7 +948,7 @@ public class HashCodeBuilder implements Builder<Integer> {
* </p>
*
* @param superHashCode
- * the result of calling <code>super.hashCode()</code>
+ * the result of calling {@code super.hashCode()}
* @return this HashCodeBuilder, used to chain calls.
* @since 2.0
*/
@@ -959,19 +959,19 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Return the computed <code>hashCode</code>.
+ * Return the computed {@code hashCode}.
* </p>
*
- * @return <code>hashCode</code> based on the fields appended
+ * @return {@code hashCode} based on the fields appended
*/
public int toHashCode() {
return iTotal;
}
/**
- * Returns the computed <code>hashCode</code>.
+ * Returns the computed {@code hashCode}.
*
- * @return <code>hashCode</code> based on the fields appended
+ * @return {@code hashCode} based on the fields appended
*
* @since 3.0
*/
@@ -982,11 +982,11 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * The computed <code>hashCode</code> from toHashCode() is returned due to the likelihood
+ * The computed {@code hashCode} from toHashCode() is returned due to the likelihood
* of bugs in mis-calling toHashCode() and the unlikeliness of it mattering what the hashCode for
* HashCodeBuilder itself is.</p>
*
- * @return <code>hashCode</code> based on the fields appended
+ * @return {@code hashCode} based on the fields appended
* @since 2.5
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
index c552919..e25a168 100755
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java
@@ -24,7 +24,7 @@ import java.lang.annotation.Target;
/**
* Use this annotation to exclude a field from being used by
- * the various <code>reflectionHashcode</code> methods defined on
+ * the various {@code reflectionHashcode} methods defined on
* {@link HashCodeBuilder}.
*
* @since 3.5
diff --git a/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
index cf89675..71af861 100644
--- a/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
@@ -20,7 +20,7 @@ package org.apache.commons.lang3.builder;
import org.apache.commons.lang3.ClassUtils;
/**
- * <p>Works with {@link ToStringBuilder} to create a "deep" <code>toString</code>.
+ * <p>Works with {@link ToStringBuilder} to create a "deep" {@code toString}.
* But instead a single line like the {@link RecursiveToStringStyle} this creates a multiline String
* similar to the {@link ToStringStyle#MULTI_LINE_STYLE}.</p>
*
diff --git a/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java
index aa5dd71..3634914 100644
--- a/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java
@@ -21,7 +21,7 @@ import java.util.Collection;
import org.apache.commons.lang3.ClassUtils;
/**
- * <p>Works with {@link ToStringBuilder} to create a "deep" <code>toString</code>.</p>
+ * <p>Works with {@link ToStringBuilder} to create a "deep" {@code toString}.</p>
*
* <p>To use this class write code as follows:</p>
*
@@ -46,7 +46,7 @@ import org.apache.commons.lang3.ClassUtils;
* </pre>
*
* <p>This will produce a toString of the format:
- * <code>Person@7f54[name=Stephen,age=29,smoker=false,job=Job@43cd2[title=Manager]]</code></p>
+ * {@code Person@7f54[name=Stephen,age=29,smoker=false,job=Job@43cd2[title=Manager]]}</p>
*
* @since 3.2
*/
@@ -85,13 +85,13 @@ public class RecursiveToStringStyle extends ToStringStyle {
}
/**
- * Returns whether or not to recursively format the given <code>Class</code>.
+ * Returns whether or not to recursively format the given {@code Class}.
* By default, this method always returns {@code true}, but may be overwritten by
* sub-classes to filter specific classes.
*
* @param clazz
* The class to test.
- * @return Whether or not to recursively format the given <code>Class</code>.
+ * @return Whether or not to recursively format the given {@code Class}.
*/
protected boolean accept(final Class<?> clazz) {
return true;
diff --git a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
index aeed52e..3996a59 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -69,7 +69,7 @@ import org.apache.commons.lang3.Validate;
* <li>{@link #getValue(java.lang.reflect.Field)}</li>
* </ul>
* <p>
- * For example, this method does <i>not</i> include the <code>password</code> field in the returned <code>String</code>:
+ * For example, this method does <i>not</i> include the {@code password} field in the returned {@code String}:
* </p>
* <pre>
* public String toString() {
@@ -89,7 +89,7 @@ import org.apache.commons.lang3.Validate;
* detailed information of a field.
* </p>
* <p>
- * The exact format of the <code>toString</code> is determined by the {@link ToStringStyle} passed into the constructor.
+ * The exact format of the {@code toString} is determined by the {@link ToStringStyle} passed into the constructor.
* </p>
*
* <p>
@@ -103,11 +103,11 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a <code>toString</code> value using the default <code>ToStringStyle</code> through reflection.
+ * Builds a {@code toString} value using the default {@code ToStringStyle} through reflection.
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
@@ -121,7 +121,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* the Object to be output
* @return the String result
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -132,11 +132,11 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a <code>toString</code> value through reflection.
+ * Builds a {@code toString} value through reflection.
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
@@ -147,16 +147,16 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is <code>null</code>, the default <code>ToStringStyle</code> is used.
+ * If the style is {@code null}, the default {@code ToStringStyle} is used.
* </p>
*
* @param object
* the Object to be output
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @return the String result
* @throws IllegalArgumentException
- * if the Object or <code>ToStringStyle</code> is <code>null</code>
+ * if the Object or {@code ToStringStyle} is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -167,17 +167,17 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a <code>toString</code> value through reflection.
+ * Builds a {@code toString} value through reflection.
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
- * If the <code>outputTransients</code> is <code>true</code>, transient members will be output, otherwise they
+ * If the {@code outputTransients} is {@code true}, transient members will be output, otherwise they
* are ignored, as they are likely derived fields, and not part of the value of the Object.
* </p>
*
@@ -186,18 +186,18 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is <code>null</code>, the default <code>ToStringStyle</code> is used.
+ * If the style is {@code null}, the default {@code ToStringStyle} is used.
* </p>
*
* @param object
* the Object to be output
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param outputTransients
* whether to include transient fields
* @return the String result
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -208,22 +208,22 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a <code>toString</code> value through reflection.
+ * Builds a {@code toString} value through reflection.
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
- * If the <code>outputTransients</code> is <code>true</code>, transient fields will be output, otherwise they
+ * If the {@code outputTransients} is {@code true}, transient fields will be output, otherwise they
* are ignored, as they are likely derived fields, and not part of the value of the Object.
* </p>
*
* <p>
- * If the <code>outputStatics</code> is <code>true</code>, static fields will be output, otherwise they are
+ * If the {@code outputStatics} is {@code true}, static fields will be output, otherwise they are
* ignored.
* </p>
*
@@ -232,20 +232,20 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is <code>null</code>, the default <code>ToStringStyle</code> is used.
+ * If the style is {@code null}, the default {@code ToStringStyle} is used.
* </p>
*
* @param object
* the Object to be output
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param outputTransients
* whether to include transient fields
* @param outputStatics
* whether to include static fields
* @return the String result
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -257,32 +257,32 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a <code>toString</code> value through reflection.
+ * Builds a {@code toString} value through reflection.
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
- * If the <code>outputTransients</code> is <code>true</code>, transient fields will be output, otherwise they
+ * If the {@code outputTransients} is {@code true}, transient fields will be output, otherwise they
* are ignored, as they are likely derived fields, and not part of the value of the Object.
* </p>
*
* <p>
- * If the <code>outputStatics</code> is <code>true</code>, static fields will be output, otherwise they are
+ * If the {@code outputStatics} is {@code true}, static fields will be output, otherwise they are
* ignored.
* </p>
*
* <p>
* Superclass fields will be appended up to and including the specified superclass. A null superclass is treated as
- * <code>java.lang.Object</code>.
+ * {@code java.lang.Object}.
* </p>
*
* <p>
- * If the style is <code>null</code>, the default <code>ToStringStyle</code> is used.
+ * If the style is {@code null}, the default {@code ToStringStyle} is used.
* </p>
*
* @param <T>
@@ -290,16 +290,16 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param object
* the Object to be output
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param outputTransients
* whether to include transient fields
* @param outputStatics
* whether to include static fields
* @param reflectUpToClass
- * the superclass to reflect up to (inclusive), may be <code>null</code>
+ * the superclass to reflect up to (inclusive), may be {@code null}
* @return the String result
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -314,32 +314,32 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a <code>toString</code> value through reflection.
+ * Builds a {@code toString} value through reflection.
* </p>
*
* <p>
- * It uses <code>AccessibleObject.setAccessible</code> to gain access to private fields. This means that it will
+ * It uses {@code AccessibleObject.setAccessible} to gain access to private fields. This means that it will
* throw a security exception if run under a security manager, if the permissions are not set up correctly. It is
* also not as efficient as testing explicitly.
* </p>
*
* <p>
- * If the <code>outputTransients</code> is <code>true</code>, transient fields will be output, otherwise they
+ * If the {@code outputTransients} is {@code true}, transient fields will be output, otherwise they
* are ignored, as they are likely derived fields, and not part of the value of the Object.
* </p>
*
* <p>
- * If the <code>outputStatics</code> is <code>true</code>, static fields will be output, otherwise they are
+ * If the {@code outputStatics} is {@code true}, static fields will be output, otherwise they are
* ignored.
* </p>
*
* <p>
* Superclass fields will be appended up to and including the specified superclass. A null superclass is treated as
- * <code>java.lang.Object</code>.
+ * {@code java.lang.Object}.
* </p>
*
* <p>
- * If the style is <code>null</code>, the default <code>ToStringStyle</code> is used.
+ * If the style is {@code null}, the default {@code ToStringStyle} is used.
* </p>
*
* @param <T>
@@ -347,7 +347,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param object
* the Object to be output
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param outputTransients
* whether to include transient fields
* @param outputStatics
@@ -355,10 +355,10 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param excludeNullValues
* whether to exclude fields whose values are null
* @param reflectUpToClass
- * the superclass to reflect up to (inclusive), may be <code>null</code>
+ * the superclass to reflect up to (inclusive), may be {@code null}
* @return the String result
* @throws IllegalArgumentException
- * if the Object is <code>null</code>
+ * if the Object is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -385,9 +385,9 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
}
/**
- * Converts the given Collection into an array of Strings. The returned array does not contain <code>null</code>
+ * Converts the given Collection into an array of Strings. The returned array does not contain {@code null}
* entries. Note that {@link Arrays#sort(Object[])} will throw an {@link NullPointerException} if an array element
- * is <code>null</code>.
+ * is {@code null}.
*
* @param collection
* The collection to convert
@@ -403,7 +403,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* Returns a new array of Strings without null elements. Internal method used to normalize exclude lists
* (arrays and collections). Note that {@link Arrays#sort(Object[])} will throw an {@link NullPointerException}
- * if an array element is <code>null</code>.
+ * if an array element is {@code null}.
*
* @param array
* The array to check
@@ -454,7 +454,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
private boolean excludeNullValues;
/**
- * Which field names to exclude from output. Intended for fields like <code>"password"</code>.
+ * Which field names to exclude from output. Intended for fields like {@code "password"}.
*
* @since 3.0 this is protected instead of private
*/
@@ -471,13 +471,13 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * This constructor outputs using the default style set with <code>setDefaultStyle</code>.
+ * This constructor outputs using the default style set with {@code setDefaultStyle}.
* </p>
*
* @param object
- * the Object to build a <code>toString</code> for, must not be <code>null</code>
+ * the Object to build a {@code toString} for, must not be {@code null}
* @throws IllegalArgumentException
- * if the Object passed in is <code>null</code>
+ * if the Object passed in is {@code null}
*/
public ReflectionToStringBuilder(final Object object) {
super(checkNotNull(object));
@@ -489,15 +489,15 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is <code>null</code>, the default style is used.
+ * If the style is {@code null}, the default style is used.
* </p>
*
* @param object
- * the Object to build a <code>toString</code> for, must not be <code>null</code>
+ * the Object to build a {@code toString} for, must not be {@code null}
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @throws IllegalArgumentException
- * if the Object passed in is <code>null</code>
+ * if the Object passed in is {@code null}
*/
public ReflectionToStringBuilder(final Object object, final ToStringStyle style) {
super(checkNotNull(object), style);
@@ -509,21 +509,21 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is <code>null</code>, the default style is used.
+ * If the style is {@code null}, the default style is used.
* </p>
*
* <p>
- * If the buffer is <code>null</code>, a new one is created.
+ * If the buffer is {@code null}, a new one is created.
* </p>
*
* @param object
- * the Object to build a <code>toString</code> for
+ * the Object to build a {@code toString} for
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param buffer
- * the <code>StringBuffer</code> to populate, may be <code>null</code>
+ * the {@code StringBuffer} to populate, may be {@code null}
* @throws IllegalArgumentException
- * if the Object passed in is <code>null</code>
+ * if the Object passed in is {@code null}
*/
public ReflectionToStringBuilder(final Object object, final ToStringStyle style, final StringBuffer buffer) {
super(checkNotNull(object), style, buffer);
@@ -535,13 +535,13 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param <T>
* the type of the object
* @param object
- * the Object to build a <code>toString</code> for
+ * the Object to build a {@code toString} for
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param buffer
- * the <code>StringBuffer</code> to populate, may be <code>null</code>
+ * the {@code StringBuffer} to populate, may be {@code null}
* @param reflectUpToClass
- * the superclass to reflect up to (inclusive), may be <code>null</code>
+ * the superclass to reflect up to (inclusive), may be {@code null}
* @param outputTransients
* whether to include transient fields
* @param outputStatics
@@ -563,13 +563,13 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param <T>
* the type of the object
* @param object
- * the Object to build a <code>toString</code> for
+ * the Object to build a {@code toString} for
* @param style
- * the style of the <code>toString</code> to create, may be <code>null</code>
+ * the style of the {@code toString} to create, may be {@code null}
* @param buffer
- * the <code>StringBuffer</code> to populate, may be <code>null</code>
+ * the {@code StringBuffer} to populate, may be {@code null}
* @param reflectUpToClass
- * the superclass to reflect up to (inclusive), may be <code>null</code>
+ * the superclass to reflect up to (inclusive), may be {@code null}
* @param outputTransients
* whether to include transient fields
* @param outputStatics
@@ -590,16 +590,16 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
}
/**
- * Returns whether or not to append the given <code>Field</code>.
+ * Returns whether or not to append the given {@code Field}.
* <ul>
- * <li>Transient fields are appended only if {@link #isAppendTransients()} returns <code>true</code>.
- * <li>Static fields are appended only if {@link #isAppendStatics()} returns <code>true</code>.
+ * <li>Transient fields are appended only if {@link #isAppendTransients()} returns {@code true}.
+ * <li>Static fields are appended only if {@link #isAppendStatics()} returns {@code true}.
* <li>Inner class fields are not appended.</li>
* </ul>
*
* @param field
* The Field to test.
- * @return Whether or not to append the given <code>Field</code>.
+ * @return Whether or not to append the given {@code Field}.
*/
protected boolean accept(final Field field) {
if (field.getName().indexOf(ClassUtils.INNER_CLASS_SEPARATOR_CHAR) != -1) {
@@ -629,7 +629,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
*
* <p>
* If a cycle is detected as an object is "toString()'ed", such an object is rendered as if
- * <code>Object.toString()</code> had been called and not implemented by the object.
+ * {@code Object.toString()} had been called and not implemented by the object.
* </p>
*
* @param clazz
@@ -685,7 +685,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Calls <code>java.lang.reflect.Field.get(Object)</code>.
+ * Calls {@code java.lang.reflect.Field.get(Object)}.
* </p>
*
* @param field
@@ -740,11 +740,11 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Append to the <code>toString</code> an <code>Object</code> array.
+ * Append to the {@code toString} an {@code Object} array.
* </p>
*
* @param array
- * the array to add to the <code>toString</code>
+ * the array to add to the {@code toString}
* @return this
*/
public ReflectionToStringBuilder reflectionAppendArray(final Object array) {
@@ -794,8 +794,8 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* Sets the field names to exclude.
*
* @param excludeFieldNamesParam
- * The excludeFieldNames to excluding from toString or <code>null</code>.
- * @return <code>this</code>
+ * The excludeFieldNames to excluding from toString or {@code null}.
+ * @return {@code this}
*/
public ReflectionToStringBuilder setExcludeFieldNames(final String... excludeFieldNamesParam) {
if (excludeFieldNamesParam == null) {
diff --git a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
index f87d5b5..8d6d6f3 100644
--- a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
@@ -17,7 +17,7 @@
package org.apache.commons.lang3.builder;
/**
- * <p>Works with {@link ToStringBuilder} to create a <code>toString</code>.</p>
+ * <p>Works with {@link ToStringBuilder} to create a {@code toString}.</p>
*
* <p>This class is intended to be used as a singleton.
* There is no need to instantiate a new style each time.
@@ -193,7 +193,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the array start text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param arrayStart the new array start text
@@ -218,7 +218,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the array end text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param arrayEnd the new array end text
@@ -243,7 +243,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the array separator text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param arraySeparator the new array separator text
@@ -268,7 +268,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the content start text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param contentStart the new content start text
@@ -293,7 +293,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the content end text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param contentEnd the new content end text
@@ -318,7 +318,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the field name value separator text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param fieldNameValueSeparator the new field name value separator text
@@ -343,7 +343,7 @@ public class StandardToStringStyle extends ToStringStyle {
/**
* <p>Sets the field separator text.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param fieldSeparator the new field separator text
@@ -408,9 +408,9 @@ public class StandardToStringStyle extends ToStringStyle {
//---------------------------------------------------------------------
/**
- * <p>Gets the text to output when <code>null</code> found.</p>
+ * <p>Gets the text to output when {@code null} found.</p>
*
- * @return the current text to output when <code>null</code> found
+ * @return the current text to output when {@code null} found
*/
@Override
public String getNullText() { // NOPMD as this is implementing the abstract class
@@ -418,12 +418,12 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the text to output when <code>null</code> found.</p>
+ * <p>Sets the text to output when {@code null} found.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
- * @param nullText the new text to output when <code>null</code> found
+ * @param nullText the new text to output when {@code null} found
*/
@Override
public void setNullText(final String nullText) { // NOPMD as this is implementing the abstract class
@@ -433,8 +433,8 @@ public class StandardToStringStyle extends ToStringStyle {
//---------------------------------------------------------------------
/**
- * <p>Gets the text to output when a <code>Collection</code>,
- * <code>Map</code> or <code>Array</code> size is output.</p>
+ * <p>Gets the text to output when a {@code Collection},
+ * {@code Map} or {@code Array} size is output.</p>
*
* <p>This is output before the size value.</p>
*
@@ -446,12 +446,12 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the start text to output when a <code>Collection</code>,
- * <code>Map</code> or <code>Array</code> size is output.</p>
+ * <p>Sets the start text to output when a {@code Collection},
+ * {@code Map} or {@code Array} size is output.</p>
*
* <p>This is output before the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param sizeStartText the new start of size text
@@ -464,8 +464,8 @@ public class StandardToStringStyle extends ToStringStyle {
//---------------------------------------------------------------------
/**
- * <p>Gets the end text to output when a <code>Collection</code>,
- * <code>Map</code> or <code>Array</code> size is output.</p>
+ * <p>Gets the end text to output when a {@code Collection},
+ * {@code Map} or {@code Array} size is output.</p>
*
* <p>This is output after the size value.</p>
*
@@ -477,12 +477,12 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the end text to output when a <code>Collection</code>,
- * <code>Map</code> or <code>Array</code> size is output.</p>
+ * <p>Sets the end text to output when a {@code Collection},
+ * {@code Map} or {@code Array} size is output.</p>
*
* <p>This is output after the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted
+ * <p>{@code null} is accepted, but will be converted
* to an empty String.</p>
*
* @param sizeEndText the new end of size text
@@ -495,7 +495,7 @@ public class StandardToStringStyle extends ToStringStyle {
//---------------------------------------------------------------------
/**
- * <p>Gets the start text to output when an <code>Object</code> is
+ * <p>Gets the start text to output when an {@code Object} is
* output in summary mode.</p>
*
* <P>This is output before the size value.</p>
@@ -508,12 +508,12 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the start text to output when an <code>Object</code> is
+ * <p>Sets the start text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output before the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param summaryObjectStartText the new start of summary text
@@ -526,7 +526,7 @@ public class StandardToStringStyle extends ToStringStyle {
//---------------------------------------------------------------------
/**
- * <p>Gets the end text to output when an <code>Object</code> is
+ * <p>Gets the end text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
@@ -539,12 +539,12 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the end text to output when an <code>Object</code> is
+ * <p>Sets the end text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param summaryObjectEndText the new end of summary text
diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
index 63117b0..ace1f83 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
@@ -22,7 +22,7 @@ import org.apache.commons.lang3.Validate;
/**
* <p>Assists in implementing {@link Object#toString()} methods.</p>
*
- * <p>This class enables a good and consistent <code>toString()</code> to be built for any
+ * <p>This class enables a good and consistent {@code toString()} to be built for any
* class or object. This class aims to simplify the process by:</p>
* <ul>
* <li>allowing field names</li>
@@ -54,15 +54,15 @@ import org.apache.commons.lang3.Validate;
* </pre>
*
* <p>This will produce a toString of the format:
- * <code>Person@7f54[name=Stephen,age=29,smoker=false]</code></p>
+ * {@code Person@7f54[name=Stephen,age=29,smoker=false]}</p>
*
- * <p>To add the superclass <code>toString</code>, use {@link #appendSuper}.
- * To append the <code>toString</code> from an object that is delegated
+ * <p>To add the superclass {@code toString}, use {@link #appendSuper}.
+ * To append the {@code toString} from an object that is delegated
* to (or any other object), use {@link #appendToString}.</p>
*
* <p>Alternatively, there is a method that uses reflection to determine
* the fields to test. Because these fields are usually private, the method,
- * <code>reflectionToString</code>, uses <code>AccessibleObject.setAccessible</code> to
+ * {@code reflectionToString}, uses {@code AccessibleObject.setAccessible} to
* change the visibility of the fields. This will fail under a security manager,
* unless the appropriate permissions are set up correctly. It is also
* slower than testing explicitly.</p>
@@ -81,7 +81,7 @@ import org.apache.commons.lang3.Validate;
* System.out.println("An object: " + ToStringBuilder.reflectionToString(anObject));
* </pre>
*
- * <p>The exact format of the <code>toString</code> is determined by
+ * <p>The exact format of the {@code toString} is determined by
* the {@link ToStringStyle} passed into the constructor.</p>
*
* @since 1.0
@@ -96,41 +96,41 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Gets the default <code>ToStringStyle</code> to use.</p>
+ * <p>Gets the default {@code ToStringStyle} to use.</p>
*
* <p>This method gets a singleton default value, typically for the whole JVM.
* Changing this default should generally only be done during application startup.
- * It is recommended to pass a <code>ToStringStyle</code> to the constructor instead
+ * It is recommended to pass a {@code ToStringStyle} to the constructor instead
* of using this global default.</p>
*
* <p>This method can be used from multiple threads.
- * Internally, a <code>volatile</code> variable is used to provide the guarantee
+ * Internally, a {@code volatile} variable is used to provide the guarantee
* that the latest value set using {@link #setDefaultStyle} is the value returned.
* It is strongly recommended that the default style is only changed during application startup.</p>
*
* <p>One reason for changing the default could be to have a verbose style during
* development and a compact style in production.</p>
*
- * @return the default <code>ToStringStyle</code>, never null
+ * @return the default {@code ToStringStyle}, never null
*/
public static ToStringStyle getDefaultStyle() {
return defaultStyle;
}
/**
- * <p>Sets the default <code>ToStringStyle</code> to use.</p>
+ * <p>Sets the default {@code ToStringStyle} to use.</p>
*
* <p>This method sets a singleton default value, typically for the whole JVM.
* Changing this default should generally only be done during application startup.
- * It is recommended to pass a <code>ToStringStyle</code> to the constructor instead
+ * It is recommended to pass a {@code ToStringStyle} to the constructor instead
* of changing this global default.</p>
*
* <p>This method is not intended for use from multiple threads.
- * Internally, a <code>volatile</code> variable is used to provide the guarantee
+ * Internally, a {@code volatile} variable is used to provide the guarantee
* that the latest value set is the value returned from {@link #getDefaultStyle}.</p>
*
- * @param style the default <code>ToStringStyle</code>
- * @throws IllegalArgumentException if the style is <code>null</code>
+ * @param style the default {@code ToStringStyle}
+ * @throws IllegalArgumentException if the style is {@code null}
*/
public static void setDefaultStyle(final ToStringStyle style) {
Validate.isTrue(style != null, "The style must not be null");
@@ -139,8 +139,8 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Uses <code>ReflectionToStringBuilder</code> to generate a
- * <code>toString</code> for the specified object.</p>
+ * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * {@code toString} for the specified object.</p>
*
* @param object the Object to be output
* @return the String result
@@ -151,11 +151,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses <code>ReflectionToStringBuilder</code> to generate a
- * <code>toString</code> for the specified object.</p>
+ * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * {@code toString} for the specified object.</p>
*
* @param object the Object to be output
- * @param style the style of the <code>toString</code> to create, may be <code>null</code>
+ * @param style the style of the {@code toString} to create, may be {@code null}
* @return the String result
* @see ReflectionToStringBuilder#toString(Object,ToStringStyle)
*/
@@ -164,11 +164,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses <code>ReflectionToStringBuilder</code> to generate a
- * <code>toString</code> for the specified object.</p>
+ * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * {@code toString} for the specified object.</p>
*
* @param object the Object to be output
- * @param style the style of the <code>toString</code> to create, may be <code>null</code>
+ * @param style the style of the {@code toString} to create, may be {@code null}
* @param outputTransients whether to include transient fields
* @return the String result
* @see ReflectionToStringBuilder#toString(Object,ToStringStyle,boolean)
@@ -178,14 +178,14 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses <code>ReflectionToStringBuilder</code> to generate a
- * <code>toString</code> for the specified object.</p>
+ * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * {@code toString} for the specified object.</p>
*
* @param <T> the type of the object
* @param object the Object to be output
- * @param style the style of the <code>toString</code> to create, may be <code>null</code>
+ * @param style the style of the {@code toString} to create, may be {@code null}
* @param outputTransients whether to include transient fields
- * @param reflectUpToClass the superclass to reflect up to (inclusive), may be <code>null</code>
+ * @param reflectUpToClass the superclass to reflect up to (inclusive), may be {@code null}
* @return the String result
* @see ReflectionToStringBuilder#toString(Object,ToStringStyle,boolean,boolean,Class)
* @since 2.0
@@ -218,7 +218,7 @@ public class ToStringBuilder implements Builder<String> {
*
* <p>This default style is obtained from {@link #getDefaultStyle()}.</p>
*
- * @param object the Object to build a <code>toString</code> for, not recommended to be null
+ * @param object the Object to build a {@code toString} for, not recommended to be null
*/
public ToStringBuilder(final Object object) {
this(object, null, null);
@@ -227,10 +227,10 @@ public class ToStringBuilder implements Builder<String> {
/**
* <p>Constructs a builder for the specified object using the defined output style.</p>
*
- * <p>If the style is <code>null</code>, the default style is used.</p>
+ * <p>If the style is {@code null}, the default style is used.</p>
*
- * @param object the Object to build a <code>toString</code> for, not recommended to be null
- * @param style the style of the <code>toString</code> to create, null uses the default style
+ * @param object the Object to build a {@code toString} for, not recommended to be null
+ * @param style the style of the {@code toString} to create, null uses the default style
*/
public ToStringBuilder(final Object object, final ToStringStyle style) {
this(object, style, null);
@@ -239,13 +239,13 @@ public class ToStringBuilder implements Builder<String> {
/**
* <p>Constructs a builder for the specified object.</p>
*
- * <p>If the style is <code>null</code>, the default style is used.</p>
+ * <p>If the style is {@code null}, the default style is used.</p>
*
- * <p>If the buffer is <code>null</code>, a new one is created.</p>
+ * <p>If the buffer is {@code null}, a new one is created.</p>
*
- * @param object the Object to build a <code>toString</code> for, not recommended to be null
- * @param style the style of the <code>toString</code> to create, null uses the default style
- * @param buffer the <code>StringBuffer</code> to populate, may be null
+ * @param object the Object to build a {@code toString} for, not recommended to be null
+ * @param style the style of the {@code toString} to create, null uses the default style
+ * @param buffer the {@code StringBuffer} to populate, may be null
*/
public ToStringBuilder(final Object object, ToStringStyle style, StringBuffer buffer) {
if (style == null) {
@@ -264,10 +264,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final boolean value) {
@@ -278,10 +278,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final boolean[] array) {
@@ -292,10 +292,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>byte</code>
+ * <p>Append to the {@code toString} a {@code byte}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final byte value) {
@@ -306,10 +306,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>byte</code>
+ * <p>Append to the {@code toString} a {@code byte}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final byte[] array) {
@@ -320,10 +320,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final char value) {
@@ -334,10 +334,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final char[] array) {
@@ -348,10 +348,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final double value) {
@@ -362,10 +362,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final double[] array) {
@@ -376,10 +376,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final float value) {
@@ -390,10 +390,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final float[] array) {
@@ -404,10 +404,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final int value) {
@@ -418,10 +418,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final int[] array) {
@@ -432,10 +432,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final long value) {
@@ -446,10 +446,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final long[] array) {
@@ -460,10 +460,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* value.</p>
*
- * @param obj the value to add to the <code>toString</code>
+ * @param obj the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final Object obj) {
@@ -474,10 +474,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final Object[] array) {
@@ -488,10 +488,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* value.</p>
*
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final short value) {
@@ -502,10 +502,10 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* array.</p>
*
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final short[] array) {
@@ -514,11 +514,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final boolean value) {
@@ -527,11 +527,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>hashCode</code>
+ * @param array the array to add to the {@code hashCode}
* @return this
*/
public ToStringBuilder append(final String fieldName, final boolean[] array) {
@@ -540,17 +540,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -560,11 +560,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>byte</code>
+ * <p>Append to the {@code toString} an {@code byte}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final byte value) {
@@ -573,10 +573,10 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>byte</code> array.</p>
+ * <p>Append to the {@code toString} a {@code byte} array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final byte[] array) {
@@ -585,17 +585,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>byte</code>
+ * <p>Append to the {@code toString} a {@code byte}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -605,11 +605,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final char value) {
@@ -618,11 +618,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final char[] array) {
@@ -631,17 +631,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -651,11 +651,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final double value) {
@@ -664,11 +664,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final double[] array) {
@@ -677,17 +677,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -697,11 +697,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>float</code>
+ * <p>Append to the {@code toString} an {@code float}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final float value) {
@@ -710,11 +710,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final float[] array) {
@@ -723,17 +723,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -743,11 +743,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final int value) {
@@ -756,11 +756,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final int[] array) {
@@ -769,17 +769,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -789,11 +789,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final long value) {
@@ -802,11 +802,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final long[] array) {
@@ -815,17 +815,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -835,11 +835,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* value.</p>
*
* @param fieldName the field name
- * @param obj the value to add to the <code>toString</code>
+ * @param obj the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final Object obj) {
@@ -848,13 +848,13 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* value.</p>
*
* @param fieldName the field name
- * @param obj the value to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail,
- * <code>false</code> for summary info
+ * @param obj the value to add to the {@code toString}
+ * @param fullDetail {@code true} for detail,
+ * {@code false} for summary info
* @return this
*/
public ToStringBuilder append(final String fieldName, final Object obj, final boolean fullDetail) {
@@ -863,11 +863,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final Object[] array) {
@@ -876,17 +876,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -896,11 +896,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> an <code>short</code>
+ * <p>Append to the {@code toString} an {@code short}
* value.</p>
*
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final short value) {
@@ -909,11 +909,11 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* array.</p>
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
+ * @param array the array to add to the {@code toString}
* @return this
*/
public ToStringBuilder append(final String fieldName, final short[] array) {
@@ -922,17 +922,17 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
- * Setting <code>true</code> will output the array in full. Setting
- * <code>false</code> will output a summary, typically the size of
+ * Setting {@code true} will output the array in full. Setting
+ * {@code false} will output a summary, typically the size of
* the array.
*
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
* for summary info
* @return this
*/
@@ -946,7 +946,7 @@ public class ToStringBuilder implements Builder<String> {
* </code> method. Appends the class name followed by
* {@link System#identityHashCode(java.lang.Object)}.</p>
*
- * @param srcObject the <code>Object</code> whose class name and id to output
+ * @param srcObject the {@code Object} whose class name and id to output
* @return this
* @since 2.0
*/
@@ -958,14 +958,14 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Append the <code>toString</code> from the superclass.</p>
+ * <p>Append the {@code toString} from the superclass.</p>
*
- * <p>This method assumes that the superclass uses the same <code>ToStringStyle</code>
+ * <p>This method assumes that the superclass uses the same {@code ToStringStyle}
* as this one.</p>
*
- * <p>If <code>superToString</code> is <code>null</code>, no change is made.</p>
+ * <p>If {@code superToString} is {@code null}, no change is made.</p>
*
- * @param superToString the result of <code>super.toString()</code>
+ * @param superToString the result of {@code super.toString()}
* @return this
* @since 2.0
*/
@@ -977,10 +977,10 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append the <code>toString</code> from another object.</p>
+ * <p>Append the {@code toString} from another object.</p>
*
* <p>This method is useful where a class delegates most of the implementation of
- * its properties to another class. You can then call <code>toString()</code> on
+ * its properties to another class. You can then call {@code toString()} on
* the other class and pass the result into this method.</p>
*
* <pre>
@@ -994,12 +994,12 @@ public class ToStringBuilder implements Builder<String> {
* toString();
* }</pre>
*
- * <p>This method assumes that the other object uses the same <code>ToStringStyle</code>
+ * <p>This method assumes that the other object uses the same {@code ToStringStyle}
* as this one.</p>
*
- * <p>If the <code>toString</code> is <code>null</code>, no change is made.</p>
+ * <p>If the {@code toString} is {@code null}, no change is made.</p>
*
- * @param toString the result of <code>toString()</code> on another object
+ * @param toString the result of {@code toString()} on another object
* @return this
* @since 2.0
*/
@@ -1011,7 +1011,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Returns the <code>Object</code> being output.</p>
+ * <p>Returns the {@code Object} being output.</p>
*
* @return The object being output.
* @since 2.0
@@ -1021,9 +1021,9 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Gets the <code>StringBuffer</code> being populated.</p>
+ * <p>Gets the {@code StringBuffer} being populated.</p>
*
- * @return the <code>StringBuffer</code> being populated
+ * @return the {@code StringBuffer} being populated
*/
public StringBuffer getStringBuffer() {
return buffer;
@@ -1032,9 +1032,9 @@ public class ToStringBuilder implements Builder<String> {
//----------------------------------------------------------------------------
/**
- * <p>Gets the <code>ToStringStyle</code> being used.</p>
+ * <p>Gets the {@code ToStringStyle} being used.</p>
*
- * @return the <code>ToStringStyle</code> being used
+ * @return the {@code ToStringStyle} being used
* @since 2.0
*/
public ToStringStyle getStyle() {
@@ -1042,14 +1042,14 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Returns the built <code>toString</code>.</p>
+ * <p>Returns the built {@code toString}.</p>
*
* <p>This method appends the end of data indicator, and can only be called once.
* Use {@link #getStringBuffer} to get the current string state.</p>
*
- * <p>If the object is <code>null</code>, return the style's <code>nullText</code></p>
+ * <p>If the object is {@code null}, return the style's {@code nullText}</p>
*
- * @return the String <code>toString</code>
+ * @return the String {@code toString}
*/
@Override
public String toString() {
@@ -1065,7 +1065,7 @@ public class ToStringBuilder implements Builder<String> {
* Returns the String that was build as an object representation. The
* default implementation utilizes the {@link #toString()} implementation.
*
- * @return the String <code>toString</code>
+ * @return the String {@code toString}
*
* @see #toString()
*
diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
index cf8e79a..83d0b5f 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
@@ -28,10 +28,10 @@ import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.commons.lang3.StringUtils;
/**
- * <p>Controls <code>String</code> formatting for {@link ToStringBuilder}.
- * The main public interface is always via <code>ToStringBuilder</code>.</p>
+ * <p>Controls {@code String} formatting for {@link ToStringBuilder}.
+ * The main public interface is always via {@code ToStringBuilder}.</p>
*
- * <p>These classes are intended to be used as <code>Singletons</code>.
+ * <p>These classes are intended to be used as {@code Singletons}.
* There is no need to instantiate a new style each time. A program
* will generally use one of the predefined constants on this class.
* Alternatively, the {@link StandardToStringStyle} class can be used
@@ -39,8 +39,8 @@ import org.apache.commons.lang3.StringUtils;
* without subclassing.</p>
*
* <p>If required, a subclass can override as many or as few of the
- * methods as it requires. Each object type (from <code>boolean</code>
- * to <code>long</code> to <code>Object</code> to <code>int[]</code>) has
+ * methods as it requires. Each object type (from {@code boolean}
+ * to {@code long} to {@code Object} to {@code int[]}) has
* its own methods to output it. Most have two versions, detail and summary.
*
* <p>For example, the detail version of the array based methods will
@@ -72,7 +72,7 @@ public abstract class ToStringStyle implements Serializable {
private static final long serialVersionUID = -2587890625525655916L;
/**
- * The default toString style. Using the <code>Person</code>
+ * The default toString style. Using the {@code Person}
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
@@ -82,7 +82,7 @@ public abstract class ToStringStyle implements Serializable {
public static final ToStringStyle DEFAULT_STYLE = new DefaultToStringStyle();
/**
- * The multi line toString style. Using the <code>Person</code>
+ * The multi line toString style. Using the {@code Person}
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
@@ -97,7 +97,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* The no field names toString style. Using the
- * <code>Person</code> example from {@link ToStringBuilder}, the output
+ * {@code Person} example from {@link ToStringBuilder}, the output
* would look like this:
*
* <pre>
@@ -107,7 +107,7 @@ public abstract class ToStringStyle implements Serializable {
public static final ToStringStyle NO_FIELD_NAMES_STYLE = new NoFieldNameToStringStyle();
/**
- * The short prefix toString style. Using the <code>Person</code> example
+ * The short prefix toString style. Using the {@code Person} example
* from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
@@ -119,7 +119,7 @@ public abstract class ToStringStyle implements Serializable {
public static final ToStringStyle SHORT_PREFIX_STYLE = new ShortPrefixToStringStyle();
/**
- * The simple toString style. Using the <code>Person</code>
+ * The simple toString style. Using the {@code Person}
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
@@ -129,7 +129,7 @@ public abstract class ToStringStyle implements Serializable {
public static final ToStringStyle SIMPLE_STYLE = new SimpleToStringStyle();
/**
- * The no class name toString style. Using the <code>Person</code>
+ * The no class name toString style. Using the {@code Person}
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
@@ -141,7 +141,7 @@ public abstract class ToStringStyle implements Serializable {
public static final ToStringStyle NO_CLASS_NAME_STYLE = new NoClassNameToStringStyle();
/**
- * The JSON toString style. Using the <code>Person</code> example from
+ * The JSON toString style. Using the {@code Person} example from
* {@link ToStringBuilder}, the output would look like this:
*
* <pre>
@@ -161,7 +161,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * A registry of objects used by <code>reflectionToString</code> methods
+ * A registry of objects used by {@code reflectionToString} methods
* to detect cyclical object references and avoid infinite loops.
* </p>
*/
@@ -179,7 +179,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * Returns the registry of objects being traversed by the <code>reflectionToString</code>
+ * Returns the registry of objects being traversed by the {@code reflectionToString}
* methods in the current thread.
* </p>
*
@@ -191,13 +191,13 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * Returns <code>true</code> if the registry contains the given object.
+ * Returns {@code true} if the registry contains the given object.
* Used by the reflection methods to avoid infinite loops.
* </p>
*
* @param value
* The object to lookup in the registry.
- * @return boolean <code>true</code> if the registry contains the given
+ * @return boolean {@code true} if the registry contains the given
* object.
*/
static boolean isRegistered(final Object value) {
@@ -249,37 +249,37 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * Whether to use the field names, the default is <code>true</code>.
+ * Whether to use the field names, the default is {@code true}.
*/
private boolean useFieldNames = true;
/**
- * Whether to use the class name, the default is <code>true</code>.
+ * Whether to use the class name, the default is {@code true}.
*/
private boolean useClassName = true;
/**
- * Whether to use short class names, the default is <code>false</code>.
+ * Whether to use short class names, the default is {@code false}.
*/
private boolean useShortClassName = false;
/**
- * Whether to use the identity hash code, the default is <code>true</code>.
+ * Whether to use the identity hash code, the default is {@code true}.
*/
private boolean useIdentityHashCode = true;
/**
- * The content start <code>'['</code>.
+ * The content start {@code '['}.
*/
private String contentStart = "[";
/**
- * The content end <code>']'</code>.
+ * The content end {@code ']'}.
*/
private String contentEnd = "]";
/**
- * The field name value separator <code>'='</code>.
+ * The field name value separator {@code '='}.
*/
private String fieldNameValueSeparator = "=";
@@ -294,7 +294,7 @@ public abstract class ToStringStyle implements Serializable {
private boolean fieldSeparatorAtEnd = false;
/**
- * The field separator <code>','</code>.
+ * The field separator {@code ','}.
*/
private String fieldSeparator = ",";
@@ -304,7 +304,7 @@ public abstract class ToStringStyle implements Serializable {
private String arrayStart = "{";
/**
- * The array separator <code>','</code>.
+ * The array separator {@code ','}.
*/
private String arraySeparator = ",";
@@ -314,38 +314,38 @@ public abstract class ToStringStyle implements Serializable {
private boolean arrayContentDetail = true;
/**
- * The array end <code>'}'</code>.
+ * The array end {@code '}'}.
*/
private String arrayEnd = "}";
/**
- * The value to use when fullDetail is <code>null</code>,
- * the default value is <code>true</code>.
+ * The value to use when fullDetail is {@code null},
+ * the default value is {@code true}.
*/
private boolean defaultFullDetail = true;
/**
- * The <code>null</code> text <code>'<null>'</code>.
+ * The {@code null} text {@code '<null>'}.
*/
private String nullText = "<null>";
/**
- * The summary size text start <code>'<size'</code>.
+ * The summary size text start {@code '<size'}.
*/
private String sizeStartText = "<size=";
/**
- * The summary size text start <code>'>'</code>.
+ * The summary size text start {@code '>'}.
*/
private String sizeEndText = ">";
/**
- * The summary object text start <code>'<'</code>.
+ * The summary object text start {@code '<'}.
*/
private String summaryObjectStartText = "<";
/**
- * The summary object text start <code>'>'</code>.
+ * The summary object text start {@code '>'}.
*/
private String summaryObjectEndText = ">";
@@ -361,13 +361,13 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> the superclass toString.</p>
+ * <p>Append to the {@code toString} the superclass toString.</p>
* <p>NOTE: It assumes that the toString has been created from the same ToStringStyle. </p>
*
- * <p>A <code>null</code> <code>superToString</code> is ignored.</p>
+ * <p>A {@code null} {@code superToString} is ignored.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
- * @param superToString the <code>super.toString()</code>
+ * @param buffer the {@code StringBuffer} to populate
+ * @param superToString the {@code super.toString()}
* @since 2.0
*/
public void appendSuper(final StringBuffer buffer, final String superToString) {
@@ -375,13 +375,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> another toString.</p>
+ * <p>Append to the {@code toString} another toString.</p>
* <p>NOTE: It assumes that the toString has been created from the same ToStringStyle. </p>
*
- * <p>A <code>null</code> <code>toString</code> is ignored.</p>
+ * <p>A {@code null} {@code toString} is ignored.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
- * @param toString the additional <code>toString</code>
+ * @param buffer the {@code StringBuffer} to populate
+ * @param toString the additional {@code toString}
* @since 2.0
*/
public void appendToString(final StringBuffer buffer, final String toString) {
@@ -399,10 +399,10 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the start of data indicator.</p>
+ * <p>Append to the {@code toString} the start of data indicator.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
- * @param object the <code>Object</code> to build a <code>toString</code> for
+ * @param buffer the {@code StringBuffer} to populate
+ * @param object the {@code Object} to build a {@code toString} for
*/
public void appendStart(final StringBuffer buffer, final Object object) {
if (object != null) {
@@ -416,11 +416,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the end of data indicator.</p>
+ * <p>Append to the {@code toString} the end of data indicator.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
- * @param object the <code>Object</code> to build a
- * <code>toString</code> for.
+ * @param buffer the {@code StringBuffer} to populate
+ * @param object the {@code Object} to build a
+ * {@code toString} for.
*/
public void appendEnd(final StringBuffer buffer, final Object object) {
if (!this.fieldSeparatorAtEnd) {
@@ -433,7 +433,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Remove the last field separator from the buffer.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @since 2.0
*/
protected void removeLastFieldSeparator(final StringBuffer buffer) {
@@ -456,15 +456,15 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
- * value, printing the full <code>toString</code> of the
- * <code>Object</code> passed in.</p>
+ * <p>Append to the {@code toString} an {@code Object}
+ * value, printing the full {@code toString} of the
+ * {@code Object} passed in.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param value the value to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final Object value, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -480,22 +480,22 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>,
+ * <p>Append to the {@code toString} an {@code Object},
* correctly interpreting its type.</p>
*
* <p>This method performs the main lookup by Class type to correctly
- * route arrays, <code>Collections</code>, <code>Maps</code> and
- * <code>Objects</code> to the appropriate method.</p>
+ * route arrays, {@code Collections}, {@code Maps} and
+ * {@code Objects} to the appropriate method.</p>
*
* <p>Either detail or summary views can be specified.</p>
*
* <p>If a cycle is detected, an object will be appended with the
- * <code>Object.toString()</code> format.</p>
+ * {@code Object.toString()} format.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param value the value to add to the {@code toString},
+ * not {@code null}
* @param detail output detail or not
*/
protected void appendInternal(final StringBuffer buffer, final String fieldName, final Object value, final boolean detail) {
@@ -598,14 +598,14 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* value that has been detected to participate in a cycle. This
* implementation will print the standard string value of the value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param value the value to add to the {@code toString},
+ * not {@code null}
*
* @since 2.2
*/
@@ -614,50 +614,50 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
- * value, printing the full detail of the <code>Object</code>.</p>
+ * <p>Append to the {@code toString} an {@code Object}
+ * value, printing the full detail of the {@code Object}.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param value the value to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final Object value) {
buffer.append(value);
}
/**
- * <p>Append to the <code>toString</code> a <code>Collection</code>.</p>
+ * <p>Append to the {@code toString} a {@code Collection}.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param coll the <code>Collection</code> to add to the
- * <code>toString</code>, not <code>null</code>
+ * @param coll the {@code Collection} to add to the
+ * {@code toString}, not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final Collection<?> coll) {
buffer.append(coll);
}
/**
- * <p>Append to the <code>toString</code> a <code>Map</code>.</p>
+ * <p>Append to the {@code toString} a {@code Map}.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param map the <code>Map</code> to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param map the {@code Map} to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final Map<?, ?> map) {
buffer.append(map);
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
- * value, printing a summary of the <code>Object</code>.</P>
+ * <p>Append to the {@code toString} an {@code Object}
+ * value, printing a summary of the {@code Object}.</P>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param value the value to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final Object value) {
buffer.append(summaryObjectStartText);
@@ -668,12 +668,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final long value) {
appendFieldStart(buffer, fieldName);
@@ -682,12 +682,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final long value) {
buffer.append(value);
@@ -696,12 +696,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final int value) {
appendFieldStart(buffer, fieldName);
@@ -710,12 +710,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final int value) {
buffer.append(value);
@@ -724,12 +724,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final short value) {
appendFieldStart(buffer, fieldName);
@@ -738,12 +738,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final short value) {
buffer.append(value);
@@ -752,12 +752,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>byte</code>
+ * <p>Append to the {@code toString} a {@code byte}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final byte value) {
appendFieldStart(buffer, fieldName);
@@ -766,12 +766,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>byte</code>
+ * <p>Append to the {@code toString} a {@code byte}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final byte value) {
buffer.append(value);
@@ -780,12 +780,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final char value) {
appendFieldStart(buffer, fieldName);
@@ -794,12 +794,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final char value) {
buffer.append(value);
@@ -808,12 +808,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final double value) {
appendFieldStart(buffer, fieldName);
@@ -822,12 +822,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final double value) {
buffer.append(value);
@@ -836,12 +836,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final float value) {
appendFieldStart(buffer, fieldName);
@@ -850,12 +850,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final float value) {
buffer.append(value);
@@ -864,12 +864,12 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
public void append(final StringBuffer buffer, final String fieldName, final boolean value) {
appendFieldStart(buffer, fieldName);
@@ -878,26 +878,26 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* value.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param value the value to add to the <code>toString</code>
+ * @param value the value to add to the {@code toString}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final boolean value) {
buffer.append(value);
}
/**
- * <p>Append to the <code>toString</code> an <code>Object</code>
+ * <p>Append to the {@code toString} an {@code Object}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final Object[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -918,13 +918,13 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> the detail of an
- * <code>Object</code> array.</p>
+ * <p>Append to the {@code toString} the detail of an
+ * {@code Object} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final Object[] array) {
buffer.append(arrayStart);
@@ -944,12 +944,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of an array type.</p>
+ * <p>Append to the {@code toString} the detail of an array type.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
* @since 2.0
*/
protected void reflectionAppendArrayDetail(final StringBuffer buffer, final String fieldName, final Object array) {
@@ -971,13 +971,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of an
- * <code>Object</code> array.</p>
+ * <p>Append to the {@code toString} a summary of an
+ * {@code Object} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final Object[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -986,14 +986,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>long</code>
+ * <p>Append to the {@code toString} a {@code long}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final long[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1012,13 +1012,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>long</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code long} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final long[] array) {
buffer.append(arrayStart);
@@ -1032,13 +1032,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>long</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code long} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final long[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1047,14 +1047,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> an <code>int</code>
+ * <p>Append to the {@code toString} an {@code int}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final int[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1073,13 +1073,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of an
- * <code>int</code> array.</p>
+ * <p>Append to the {@code toString} the detail of an
+ * {@code int} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final int[] array) {
buffer.append(arrayStart);
@@ -1093,13 +1093,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of an
- * <code>int</code> array.</p>
+ * <p>Append to the {@code toString} a summary of an
+ * {@code int} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final int[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1108,14 +1108,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>short</code>
+ * <p>Append to the {@code toString} a {@code short}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final short[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1134,13 +1134,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>short</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code short} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final short[] array) {
buffer.append(arrayStart);
@@ -1154,13 +1154,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>short</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code short} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final short[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1169,14 +1169,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>byte</code>
+ * <p>Append to the {@code toString} a {@code byte}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final byte[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1195,13 +1195,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>byte</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code byte} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final byte[] array) {
buffer.append(arrayStart);
@@ -1215,13 +1215,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>byte</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code byte} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final byte[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1230,14 +1230,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>char</code>
+ * <p>Append to the {@code toString} a {@code char}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
- * @param array the array to add to the <code>toString</code>
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param array the array to add to the {@code toString}
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final char[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1256,13 +1256,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>char</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code char} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final char[] array) {
buffer.append(arrayStart);
@@ -1276,13 +1276,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>char</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code char} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final char[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1291,14 +1291,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>double</code>
+ * <p>Append to the {@code toString} a {@code double}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final double[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1317,13 +1317,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>double</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code double} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final double[] array) {
buffer.append(arrayStart);
@@ -1337,13 +1337,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>double</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code double} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final double[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1352,14 +1352,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>float</code>
+ * <p>Append to the {@code toString} a {@code float}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final float[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1378,13 +1378,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>float</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code float} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final float[] array) {
buffer.append(arrayStart);
@@ -1398,13 +1398,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>float</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code float} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final float[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1413,14 +1413,14 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> a <code>boolean</code>
+ * <p>Append to the {@code toString} a {@code boolean}
* array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
- * @param fullDetail <code>true</code> for detail, <code>false</code>
- * for summary info, <code>null</code> for style decides
+ * @param fullDetail {@code true} for detail, {@code false}
+ * for summary info, {@code null} for style decides
*/
public void append(final StringBuffer buffer, final String fieldName, final boolean[] array, final Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
@@ -1439,13 +1439,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the detail of a
- * <code>boolean</code> array.</p>
+ * <p>Append to the {@code toString} the detail of a
+ * {@code boolean} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final boolean[] array) {
buffer.append(arrayStart);
@@ -1459,13 +1459,13 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a summary of a
- * <code>boolean</code> array.</p>
+ * <p>Append to the {@code toString} a summary of a
+ * {@code boolean} array.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param array the array to add to the <code>toString</code>,
- * not <code>null</code>
+ * @param array the array to add to the {@code toString},
+ * not {@code null}
*/
protected void appendSummary(final StringBuffer buffer, final String fieldName, final boolean[] array) {
appendSummarySize(buffer, fieldName, array.length);
@@ -1474,10 +1474,10 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Append to the <code>toString</code> the class name.</p>
+ * <p>Append to the {@code toString} the class name.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
- * @param object the <code>Object</code> whose name to output
+ * @param buffer the {@code StringBuffer} to populate
+ * @param object the {@code Object} whose name to output
*/
protected void appendClassName(final StringBuffer buffer, final Object object) {
if (useClassName && object != null) {
@@ -1493,8 +1493,8 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append the {@link System#identityHashCode(java.lang.Object)}.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
- * @param object the <code>Object</code> whose id to output
+ * @param buffer the {@code StringBuffer} to populate
+ * @param object the {@code Object} whose id to output
*/
protected void appendIdentityHashCode(final StringBuffer buffer, final Object object) {
if (this.isUseIdentityHashCode() && object!=null) {
@@ -1505,29 +1505,29 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the content start.</p>
+ * <p>Append to the {@code toString} the content start.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
*/
protected void appendContentStart(final StringBuffer buffer) {
buffer.append(contentStart);
}
/**
- * <p>Append to the <code>toString</code> the content end.</p>
+ * <p>Append to the {@code toString} the content end.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
*/
protected void appendContentEnd(final StringBuffer buffer) {
buffer.append(contentEnd);
}
/**
- * <p>Append to the <code>toString</code> an indicator for <code>null</code>.</p>
+ * <p>Append to the {@code toString} an indicator for {@code null}.</p>
*
- * <p>The default indicator is <code>'<null>'</code>.</p>
+ * <p>The default indicator is {@code '<null>'}.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
*/
protected void appendNullText(final StringBuffer buffer, final String fieldName) {
@@ -1535,18 +1535,18 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the field separator.</p>
+ * <p>Append to the {@code toString} the field separator.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
*/
protected void appendFieldSeparator(final StringBuffer buffer) {
buffer.append(fieldSeparator);
}
/**
- * <p>Append to the <code>toString</code> the field start.</p>
+ * <p>Append to the {@code toString} the field start.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name
*/
protected void appendFieldStart(final StringBuffer buffer, final String fieldName) {
@@ -1557,9 +1557,9 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> the field end.</p>
+ * <p>Append to the {@code toString} the field end.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
*/
protected void appendFieldEnd(final StringBuffer buffer, final String fieldName) {
@@ -1567,17 +1567,17 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the <code>toString</code> a size summary.</p>
+ * <p>Append to the {@code toString} a size summary.</p>
*
* <p>The size summary is used to summarize the contents of
- * <code>Collections</code>, <code>Maps</code> and arrays.</p>
+ * {@code Collections}, {@code Maps} and arrays.</p>
*
* <p>The output consists of a prefix, the passed in size
* and a suffix.</p>
*
- * <p>The default format is <code>'<size=n>'</code>.</p>
+ * <p>The default format is {@code '<size=n>'}.</p>
*
- * @param buffer the <code>StringBuffer</code> to populate
+ * @param buffer the {@code StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param size the size to append
*/
@@ -1591,10 +1591,10 @@ public abstract class ToStringStyle implements Serializable {
* <p>Is this field to be output in full detail.</p>
*
* <p>This method converts a detail request into a detail level.
- * The calling code may request full detail (<code>true</code>),
+ * The calling code may request full detail ({@code true}),
* but a subclass might ignore that and always return
- * <code>false</code>. The calling code may pass in
- * <code>null</code> indicating that it doesn't care about
+ * {@code false}. The calling code may pass in
+ * {@code null} indicating that it doesn't care about
* the detail level. In this case the default detail level is
* used.</p>
*
@@ -1614,7 +1614,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>The short class name is the classname excluding
* the package name.</p>
*
- * @param cls the <code>Class</code> to get the short name of
+ * @param cls the {@code Class} to get the short name of
* @return the short name
*/
protected String getShortClassName(final Class<?> cls) {
@@ -1762,7 +1762,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the array start text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param arrayStart the new array start text
@@ -1788,7 +1788,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the array end text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param arrayEnd the new array end text
@@ -1814,7 +1814,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the array separator text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param arraySeparator the new array separator text
@@ -1840,7 +1840,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the content start text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param contentStart the new content start text
@@ -1866,7 +1866,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the content end text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param contentEnd the new content end text
@@ -1892,7 +1892,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the field name value separator text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param fieldNameValueSeparator the new field name value separator text
@@ -1918,7 +1918,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Sets the field separator text.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param fieldSeparator the new field separator text
@@ -1981,7 +1981,7 @@ public abstract class ToStringStyle implements Serializable {
//---------------------------------------------------------------------
/**
- * <p>Gets the text to output when <code>null</code> found.</p>
+ * <p>Gets the text to output when {@code null} found.</p>
*
* @return the current text to output when null found
*/
@@ -1990,9 +1990,9 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the text to output when <code>null</code> found.</p>
+ * <p>Sets the text to output when {@code null} found.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param nullText the new text to output when null found
@@ -2007,8 +2007,8 @@ public abstract class ToStringStyle implements Serializable {
//---------------------------------------------------------------------
/**
- * <p>Gets the start text to output when a <code>Collection</code>,
- * <code>Map</code> or array size is output.</p>
+ * <p>Gets the start text to output when a {@code Collection},
+ * {@code Map} or array size is output.</p>
*
* <p>This is output before the size value.</p>
*
@@ -2019,12 +2019,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the start text to output when a <code>Collection</code>,
- * <code>Map</code> or array size is output.</p>
+ * <p>Sets the start text to output when a {@code Collection},
+ * {@code Map} or array size is output.</p>
*
* <p>This is output before the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param sizeStartText the new start of size text
@@ -2039,8 +2039,8 @@ public abstract class ToStringStyle implements Serializable {
//---------------------------------------------------------------------
/**
- * <p>Gets the end text to output when a <code>Collection</code>,
- * <code>Map</code> or array size is output.</p>
+ * <p>Gets the end text to output when a {@code Collection},
+ * {@code Map} or array size is output.</p>
*
* <p>This is output after the size value.</p>
*
@@ -2051,12 +2051,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the end text to output when a <code>Collection</code>,
- * <code>Map</code> or array size is output.</p>
+ * <p>Sets the end text to output when a {@code Collection},
+ * {@code Map} or array size is output.</p>
*
* <p>This is output after the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param sizeEndText the new end of size text
@@ -2071,7 +2071,7 @@ public abstract class ToStringStyle implements Serializable {
//---------------------------------------------------------------------
/**
- * <p>Gets the start text to output when an <code>Object</code> is
+ * <p>Gets the start text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output before the size value.</p>
@@ -2083,12 +2083,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the start text to output when an <code>Object</code> is
+ * <p>Sets the start text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output before the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param summaryObjectStartText the new start of summary text
@@ -2103,7 +2103,7 @@ public abstract class ToStringStyle implements Serializable {
//---------------------------------------------------------------------
/**
- * <p>Gets the end text to output when an <code>Object</code> is
+ * <p>Gets the end text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
@@ -2115,12 +2115,12 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the end text to output when an <code>Object</code> is
+ * <p>Sets the end text to output when an {@code Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
*
- * <p><code>null</code> is accepted, but will be converted to
+ * <p>{@code null} is accepted, but will be converted to
* an empty String.</p>
*
* @param summaryObjectEndText the new end of summary text
@@ -2135,10 +2135,10 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p>Default <code>ToStringStyle</code>.</p>
+ * <p>Default {@code ToStringStyle}.</p>
*
* <p>This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.</p>
+ * {@code StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class DefaultToStringStyle extends ToStringStyle {
@@ -2159,7 +2159,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure <code>Singleton</code> after serialization.</p>
+ * <p>Ensure {@code Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2172,11 +2172,11 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p><code>ToStringStyle</code> that does not print out
+ * <p>{@code ToStringStyle} that does not print out
* the field names.</p>
*
* <p>This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.
+ * {@code StandardToStringStyle} to ensure its immutability.
*/
private static final class NoFieldNameToStringStyle extends ToStringStyle {
@@ -2193,7 +2193,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure <code>Singleton</code> after serialization.</p>
+ * <p>Ensure {@code Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2206,11 +2206,11 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p><code>ToStringStyle</code> that prints out the short
+ * <p>{@code ToStringStyle} that prints out the short
* class name and no identity hashcode.</p>
*
* <p>This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.</p>
+ * {@code StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class ShortPrefixToStringStyle extends ToStringStyle {
@@ -2240,11 +2240,11 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p><code>ToStringStyle</code> that does not print out the
+ * <p>{@code ToStringStyle} that does not print out the
* classname, identity hashcode, content start or field name.</p>
*
* <p>This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.</p>
+ * {@code StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class SimpleToStringStyle extends ToStringStyle {
@@ -2277,10 +2277,10 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p><code>ToStringStyle</code> that outputs on multiple lines.</p>
+ * <p>{@code ToStringStyle} that outputs on multiple lines.</p>
*
* <p>This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.</p>
+ * {@code StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class MultiLineToStringStyle extends ToStringStyle {
@@ -2300,7 +2300,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure <code>Singleton</code> after serialization.</p>
+ * <p>Ensure {@code Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2313,11 +2313,11 @@ public abstract class ToStringStyle implements Serializable {
//----------------------------------------------------------------------------
/**
- * <p><code>ToStringStyle</code> that does not print out the classname
+ * <p>{@code ToStringStyle} that does not print out the classname
* and identity hash code but prints content start and field names.</p>
*
* <p>This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.</p>
+ * {@code StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class NoClassNameToStringStyle extends ToStringStyle {
@@ -2335,7 +2335,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure <code>Singleton</code> after serialization.</p>
+ * <p>Ensure {@code Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2349,12 +2349,12 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * <code>ToStringStyle</code> that outputs with JSON format.
+ * {@code ToStringStyle} that outputs with JSON format.
* </p>
*
* <p>
* This is an inner class rather than using
- * <code>StandardToStringStyle</code> to ensure its immutability.
+ * {@code StandardToStringStyle} to ensure its immutability.
* </p>
*
* @since 3.4
@@ -2625,7 +2625,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * Ensure <code>Singleton</code> after serialization.
+ * Ensure {@code Singleton} after serialization.
* </p>
*
* @return the singleton
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
index dcbea8a..044b7e9 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
@@ -308,7 +308,7 @@ public class ConcurrentUtils {
//-----------------------------------------------------------------------
/**
* <p>
- * Gets an implementation of <code>Future</code> that is immediately done
+ * Gets an implementation of {@code Future} that is immediately done
* and returns the specified constant value.
* </p>
* <p>
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/package-info.java b/src/main/java/org/apache/commons/lang3/concurrent/package-info.java
index 9cfcf96..49f98a8 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/package-info.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/package-info.java
@@ -32,21 +32,21 @@
* </code>
* </pre>
*
- * <p>A <code>ConcurrentInitializer</code> produces an object.
+ * <p>A {@code ConcurrentInitializer} produces an object.
* By calling the {@link org.apache.commons.lang3.concurrent.ConcurrentInitializer#get() get()} method the object managed by the initializer can be obtained.
* There are different implementations of the interface available
* addressing various use cases:
* </p>
*
- * <p> {@link org.apache.commons.lang3.concurrent.ConstantInitializer} is a very straightforward implementation of the <code>ConcurrentInitializer</code> interface:
+ * <p> {@link org.apache.commons.lang3.concurrent.ConstantInitializer} is a very straightforward implementation of the {@code ConcurrentInitializer} interface:
* An instance is passed an object when it is constructed.
- * In its <code>get()</code> method it simply returns this object.
- * This is useful, for instance in unit tests or in cases when you want to pass a specific object to a component which expects a <code>ConcurrentInitializer</code>.
+ * In its {@code get()} method it simply returns this object.
+ * This is useful, for instance in unit tests or in cases when you want to pass a specific object to a component which expects a {@code ConcurrentInitializer}.
* </p>
*
* <p>The {@link org.apache.commons.lang3.concurrent.LazyInitializer} class can be used to defer the creation of an object until it is actually used.
* This makes sense, for instance, if the creation of the object is expensive and would slow down application startup or if the object is needed only for special executions.
- * <code>LazyInitializer</code> implements the <em>double-check idiom for an instance field</em> as discussed in Joshua Bloch's "Effective Java", 2nd edition, item 71.
+ * {@code LazyInitializer} implements the <em>double-check idiom for an instance field</em> as discussed in Joshua Bloch's "Effective Java", 2nd edition, item 71.
* It uses <strong>volatile</strong> fields to reduce the amount of synchronization.
* Note that this idiom is appropriate for instance fields only.
* For <strong>static</strong> fields there are superior alternatives.</p>
@@ -56,9 +56,9 @@
* If such a request causes a fatal error, an administrator is to be notified using a special messaging service.
* We assume that the creation of the messaging service is an expensive operation.
* So it should only be performed if an error actually occurs.
- * Here is where <code>LazyInitializer</code> comes into play.
+ * Here is where {@code LazyInitializer} comes into play.
* We create a specialized subclass for creating and initializing an instance of our messaging service.
- * <code>LazyInitializer</code> declares an abstract {@link org.apache.commons.lang3.concurrent.LazyInitializer#initialize() initialize()} method which we have to implement to create the messaging service object:</p>
+ * {@code LazyInitializer} declares an abstract {@link org.apache.commons.lang3.concurrent.LazyInitializer#initialize() initialize()} method which we have to implement to create the messaging service object:</p>
*
* <pre>
* <code>
@@ -72,7 +72,7 @@
* </code>
* </pre>
*
- * <p> Now each server thread is passed a reference to a shared instance of our new <code>MessagingServiceInitializer</code> class.
+ * <p> Now each server thread is passed a reference to a shared instance of our new {@code MessagingServiceInitializer} class.
* The threads run in a loop processing client requests. If an error is detected, the messaging service is obtained from the initializer, and the administrator is notified:</p>
*
* <pre>
@@ -105,16 +105,16 @@
* </code>
* </pre>
*
- * <p>The {@link org.apache.commons.lang3.concurrent.AtomicInitializer} class is very similar to <code>LazyInitializer</code>.
+ * <p>The {@link org.apache.commons.lang3.concurrent.AtomicInitializer} class is very similar to {@code LazyInitializer}.
* It serves the same purpose: to defer the creation of an object until it is needed.
* The internal structure is also very similar.
* Again there is an abstract {@link org.apache.commons.lang3.concurrent.AtomicInitializer#initialize() initialize()} method which has to be implemented by concrete subclasses in order to create and initialize the managed object.
- * Actually, in our example above we can turn the <code>MessagingServiceInitializer</code> into an atomic initializer by simply changing the <strong>extends</strong> declaration to refer to <code>AtomicInitializer<MessagingService></code> as super class.</p>
+ * Actually, in our example above we can turn the {@code MessagingServiceInitializer} into an atomic initializer by simply changing the <strong>extends</strong> declaration to refer to {@code AtomicInitializer<MessagingService>} as super class.</p>
*
* <p>With {@link org.apache.commons.lang3.concurrent.AtomicSafeInitializer} there is yet another variant implementing the lazy initializing pattern.
- * Its implementation is close to <code>AtomicInitializer</code>; it also uses atomic variables internally and therefore does not need synchronization.
+ * Its implementation is close to {@code AtomicInitializer}; it also uses atomic variables internally and therefore does not need synchronization.
* The name "Safe" is derived from the fact that it implements an additional check which guarantees that the {@link org.apache.commons.lang3.concurrent.AtomicSafeInitializer#initialize() initialize()} method is called only once.
- * So it behaves exactly in the same way as <code>LazyInitializer</code>.</p>
+ * So it behaves exactly in the same way as {@code LazyInitializer}.</p>
*
* <p>Now, which one of the lazy initializer implementations should you use?
* First of all we have to state that is is problematic to give general recommendations regarding the performance of these classes.
@@ -122,24 +122,24 @@
* So developers should make their own benchmarks in scenarios close to their specific use cases.
* The following statements are rules of thumb which have to be verified in practice.</p>
*
- * <p><code>AtomicInitializer</code> is probably the most efficient implementation due to its lack of synchronization and further checks.
- * Its main drawback is that the <code>initialize()</code> method can be called multiple times.
- * In cases where this is not an issue <code>AtomicInitializer</code> is a good choice.
- * <code>AtomicSafeInitializer</code> and <code>LazyInitializer</code> both guarantee that the initialization method is called only once.
- * Because <code>AtomicSafeInitializer</code> does not use synchronization it is probably slightly more efficient than <code>LazyInitializer</code>, but the concrete numbers might depend on the level of concurrency.</p>
+ * <p>{@code AtomicInitializer} is probably the most efficient implementation due to its lack of synchronization and further checks.
+ * Its main drawback is that the {@code initialize()} method can be called multiple times.
+ * In cases where this is not an issue {@code AtomicInitializer} is a good choice.
+ * {@code AtomicSafeInitializer} and {@code LazyInitializer} both guarantee that the initialization method is called only once.
+ * Because {@code AtomicSafeInitializer} does not use synchronization it is probably slightly more efficient than {@code LazyInitializer}, but the concrete numbers might depend on the level of concurrency.</p>
*
- * <p>Another implementation of the <code>ConcurrentInitializer</code> interface is {@link org.apache.commons.lang3.concurrent.BackgroundInitializer}.
+ * <p>Another implementation of the {@code ConcurrentInitializer} interface is {@link org.apache.commons.lang3.concurrent.BackgroundInitializer}.
* It is again an abstract base class with an {@link org.apache.commons.lang3.concurrent.BackgroundInitializer#initialize() initialize()} method that has to be defined by concrete subclasses.
- * The idea of <code>BackgroundInitializer</code> is that it calls the <code>initialize()</code> method in a separate worker thread.
+ * The idea of {@code BackgroundInitializer} is that it calls the {@code initialize()} method in a separate worker thread.
* An application creates a background initializer and starts it.
* Then it can continue with its work while the initializer runs in parallel.
- * When the application needs the results of the initializer it calls its <code>get()</code> method.
- * <code>get()</code> blocks until the initialization is complete.
+ * When the application needs the results of the initializer it calls its {@code get()} method.
+ * {@code get()} blocks until the initialization is complete.
* This is useful for instance at application startup.
* Here initialization steps (e.g. reading configuration files, opening a database connection, etc.) can be run in background threads while the application shows a splash screen and constructs its UI.</p>
*
* <p>As a concrete example consider an application that has to read the content of a URL - maybe a page with news - which is to be displayed to the user after login.
- * Because loading the data over the network can take some time a specialized implementation of <code>BackgroundInitializer</code> can be created for this purpose:</p>
+ * Because loading the data over the network can take some time a specialized implementation of {@code BackgroundInitializer} can be created for this purpose:</p>
*
* <pre>
* <code>
@@ -165,9 +165,9 @@
* </code>
* </pre>
*
- * <p>An application creates an instance of <code>URLLoader</code> and starts it.
+ * <p>An application creates an instance of {@code URLLoader} and starts it.
* Then it can do other things.
- * When it needs the content of the URL it calls the initializer's <code>get()</code> method:</p>
+ * When it needs the content of the URL it calls the initializer's {@code get()} method:</p>
*
* <pre>
* <code>
@@ -188,24 +188,24 @@
* </code>
* </pre>
*
- * <p> Related to <code>BackgroundInitializer</code> is the {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer} class.
+ * <p> Related to {@code BackgroundInitializer} is the {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer} class.
* As the name implies, this class can handle multiple initializations in parallel.
- * The basic usage scenario is that a <code>MultiBackgroundInitializer</code> instance is created.
- * Then an arbitrary number of <code>BackgroundInitializer</code> objects is added using the {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer#addInitializer(String, BackgroundInitializer)} method.
+ * The basic usage scenario is that a {@code MultiBackgroundInitializer} instance is created.
+ * Then an arbitrary number of {@code BackgroundInitializer} objects is added using the {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer#addInitializer(String, BackgroundInitializer)} method.
* When adding an initializer a string has to be provided which is later used to obtain the result for this initializer.
* When all initializers have been added the {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer#start()} method is called.
* This starts processing of all initializers.
- * Later the <code>get()</code> method can be called.
+ * Later the {@code get()} method can be called.
* It waits until all initializers have finished their initialization.
- * <code>get()</code> returns an object of type {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer.MultiBackgroundInitializerResults}.
+ * {@code get()} returns an object of type {@link org.apache.commons.lang3.concurrent.MultiBackgroundInitializer.MultiBackgroundInitializerResults}.
* This object provides information about all initializations that have been performed.
* It can be checked whether a specific initializer was successful or threw an exception.
* Of course, all initialization results can be queried.</p>
*
- * <p>With <code>MultiBackgroundInitializer</code> we can extend our example to perform multiple initialization steps.
+ * <p>With {@code MultiBackgroundInitializer} we can extend our example to perform multiple initialization steps.
* Suppose that in addition to loading a web site we also want to create a JPA entity manager factory and read a configuration file.
- * We assume that corresponding <code>BackgroundInitializer</code> implementations exist.
- * The following example fragment shows the usage of <code>MultiBackgroundInitializer</code> for this purpose:</p>
+ * We assume that corresponding {@code BackgroundInitializer} implementations exist.
+ * The following example fragment shows the usage of {@code MultiBackgroundInitializer} for this purpose:</p>
*
* <pre>
* <code>
@@ -228,37 +228,37 @@
* </pre>
*
* <p>The child initializers are added to the multi initializer and are assigned a unique name.
- * The object returned by the <code>get()</code> method is then queried for the single results using these unique names.</p>
+ * The object returned by the {@code get()} method is then queried for the single results using these unique names.</p>
*
- * <p> If background initializers - including <code>MultiBackgroundInitializer</code> - are created using the standard constructor, they create their own {@link java.util.concurrent.ExecutorService} which is used behind the scenes to execute the worker tasks.
- * It is also possible to pass in an <code>ExecutorService</code> when the initializer is constructed.
- * That way client code can configure the <code>ExecutorService</code> according to its specific needs; for instance, the number of threads available could be limited.</p>
+ * <p> If background initializers - including {@code MultiBackgroundInitializer} - are created using the standard constructor, they create their own {@link java.util.concurrent.ExecutorService} which is used behind the scenes to execute the worker tasks.
+ * It is also possible to pass in an {@code ExecutorService} when the initializer is constructed.
+ * That way client code can configure the {@code ExecutorService} according to its specific needs; for instance, the number of threads available could be limited.</p>
*
* <h2>Utility Classes</h2>
*
- * <p>Another group of classes in the new <code>concurrent</code> package offers some generic functionality related to concurrency.
+ * <p>Another group of classes in the new {@code concurrent} package offers some generic functionality related to concurrency.
* There is the {@link org.apache.commons.lang3.concurrent.ConcurrentUtils} class with a bunch of static utility methods.
* One focus of this class is dealing with exceptions thrown by JDK classes.
* Many JDK classes of the executor framework throw exceptions of type {@link java.util.concurrent.ExecutionException} if something goes wrong.
* The root cause of these exceptions can also be a runtime exception or even an error.
* In typical Java programming you often do not want to deal with runtime exceptions directly; rather you let them fall through the hierarchy of method invocations until they reach a central exception handler.
* Checked exceptions in contrast are usually handled close to their occurrence.
- * With <code>ExecutionException</code> this principle is violated.
+ * With {@code ExecutionException} this principle is violated.
* Because it is a checked exception, an application is forced to handle it even if the cause is a runtime exception.
- * So you typically have to inspect the cause of the <code>ExecutionException</code> and test whether it is a checked exception which has to be handled. If this is not the case, the causing exception can be rethrown.
+ * So you typically have to inspect the cause of the {@code ExecutionException} and test whether it is a checked exception which has to be handled. If this is not the case, the causing exception can be rethrown.
* </p>
*
* <p>The {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#extractCause(java.util.concurrent.ExecutionException)} method does this work for you.
- * It is passed an <code>ExecutionException</code> and tests its root cause.
+ * It is passed an {@code ExecutionException} and tests its root cause.
* If this is an error or a runtime exception, it is directly rethrown.
* Otherwise, an instance of {@link org.apache.commons.lang3.concurrent.ConcurrentException} is created and initialized with the root cause
- * (<code>ConcurrentException</code> is a new exception class in the <code>o.a.c.l.concurrent</code> package).
- * So if you get such a <code>ConcurrentException</code>, you can be sure that the original cause for the <code>ExecutionException</code> was a checked exception.
- * For users who prefer runtime exceptions in general there is also an {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#extractCauseUnchecked(java.util.concurrent.ExecutionException)} method which behaves like <code>extractCause()</code>, but returns the unchecked exception {@link org.apache.commons.lang3.concurrent.ConcurrentRuntimeException} instead.</p>
+ * ({@code ConcurrentException} is a new exception class in the {@code o.a.c.l.concurrent} package).
+ * So if you get such a {@code ConcurrentException}, you can be sure that the original cause for the {@code ExecutionException} was a checked exception.
+ * For users who prefer runtime exceptions in general there is also an {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#extractCauseUnchecked(java.util.concurrent.ExecutionException)} method which behaves like {@code extractCause()}, but returns the unchecked exception {@link org.apache.commons.lang3.concurrent.ConcurrentRuntimeException} instead.</p>
*
- * <p>In addition to the <code>extractCause()</code> methods there are corresponding {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#handleCause(java.util.concurrent.ExecutionException)} and {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#handleCauseUnchecked(java.util.concurrent.ExecutionException)} methods.
- * These methods extract the cause of the passed in <code>ExecutionException</code> and throw the resulting <code>ConcurrentException</code> or <code>ConcurrentRuntimeException</code>.
- * This makes it easy to transform an <code>ExecutionException</code> into a <code>ConcurrentException</code> ignoring unchecked exceptions:</p>
+ * <p>In addition to the {@code extractCause()} methods there are corresponding {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#handleCause(java.util.concurrent.ExecutionException)} and {@link org.apache.commons.lang3.concurrent.ConcurrentUtils#handleCauseUnchecked(java.util.concurrent.ExecutionException)} methods.
+ * These methods extract the cause of the passed in {@code ExecutionException} and throw the resulting {@code ConcurrentException} or {@code ConcurrentRuntimeException}.
+ * This makes it easy to transform an {@code ExecutionException} into a {@code ConcurrentException} ignoring unchecked exceptions:</p>
*
* <pre>
* <code>
@@ -273,10 +273,10 @@
* </pre>
*
* <p>There is also some support for the concurrent initializers introduced in the last sub section.
- * The <code>initialize()</code> method is passed a <code>ConcurrentInitializer</code> object and returns the object created by this initializer.
+ * The {@code initialize()} method is passed a {@code ConcurrentInitializer} object and returns the object created by this initializer.
* It is null-safe.
- * The <code>initializeUnchecked()</code> method works analogously, but a <code>ConcurrentException</code> throws by the initializer is rethrown as a <code>ConcurrentRuntimeException</code>.
- * This is especially useful if the specific <code>ConcurrentInitializer</code> does not throw checked exceptions.
+ * The {@code initializeUnchecked()} method works analogously, but a {@code ConcurrentException} throws by the initializer is rethrown as a {@code ConcurrentRuntimeException}.
+ * This is especially useful if the specific {@code ConcurrentInitializer} does not throw checked exceptions.
* Using this method the code for requesting the object of an initializer becomes less verbose.
* The direct invocation looks as follows:</p>
*
@@ -306,11 +306,11 @@
* When using the <em>Executor</em> framework new in JDK 1.5 the developer usually does not have to care about creating threads; the executors create the threads they need on demand.
* However, sometimes it is desired to set some properties of the newly created worker threads.
* This is possible through the {@link java.util.concurrent.ThreadFactory} interface; an implementation of this interface has to be created and passed to an executor on creation time.
- * Currently, the JDK does not provide an implementation of <code>ThreadFactory</code>, so one has to start from scratch. </p>
+ * Currently, the JDK does not provide an implementation of {@code ThreadFactory}, so one has to start from scratch. </p>
*
- * <p> With {@link org.apache.commons.lang3.concurrent.BasicThreadFactory} Commons Lang has an implementation of <code>ThreadFactory</code> that works out of the box for many common use cases.
+ * <p> With {@link org.apache.commons.lang3.concurrent.BasicThreadFactory} Commons Lang has an implementation of {@code ThreadFactory} that works out of the box for many common use cases.
* For instance, it is possible to set a naming pattern for the new threads, set the daemon flag and a priority, or install a handler for uncaught exceptions.
- * Instances of <code>BasicThreadFactory</code> are created and configured using the nested {@link org.apache.commons.lang3.concurrent.BasicThreadFactory.Builder} class.
+ * Instances of {@code BasicThreadFactory} are created and configured using the nested {@link org.apache.commons.lang3.concurrent.BasicThreadFactory.Builder} class.
* The following example shows a typical usage scenario:</p>
*
* <pre>
@@ -324,17 +324,17 @@
* </code>
* </pre>
*
- * <p>The nested <code>Builder</code> class defines some methods for configuring the new <code>BasicThreadFactory</code> instance.
+ * <p>The nested {@code Builder} class defines some methods for configuring the new {@code BasicThreadFactory} instance.
* Objects of this class are immutable, so these attributes cannot be changed later.
- * The naming pattern is a string which can be passed to <code>String.format()</code>.
+ * The naming pattern is a string which can be passed to {@code String.format()}.
* The placeholder <em>%d</em> is replaced by an increasing counter value.
- * An instance can wrap another <code>ThreadFactory</code> implementation; this is achieved by calling the builder's {@link org.apache.commons.lang3.concurrent.BasicThreadFactory.Builder#wrappedFactory(java.util.concurrent.ThreadFactory) wrappedFactory(ThreadFactory)} method.
+ * An instance can wrap another {@code ThreadFactory} implementation; this is achieved by calling the builder's {@link org.apache.commons.lang3.concurrent.BasicThreadFactory.Builder#wrappedFactory(java.util.concurrent.ThreadFactory) wrappedFactory(ThreadFactory)} method.
* This factory is then used for creating new threads; after that the specific attributes are applied to the new thread.
* If no wrapped factory is set, the default factory provided by the JDK is used.</p>
*
* <h2>Synchronization objects</h2>
*
- * <p>The <code>concurrent</code> package also provides some support for specific synchronization problems with threads.</p>
+ * <p>The {@code concurrent} package also provides some support for specific synchronization problems with threads.</p>
*
* <p> {@link org.apache.commons.lang3.concurrent.TimedSemaphore} allows restricted access to a resource in a given time frame.
* Similar to a semaphore, a number of permits can be acquired.
@@ -346,7 +346,7 @@
* Then all blocking threads are released, and the counter of available permits is reset to 0.
* So the game can start anew.</p>
*
- * <p> What are use cases for <code>TimedSemaphore</code>?
+ * <p> What are use cases for {@code TimedSemaphore}?
* One example is to artificially limit the load produced by multiple threads.
* Consider a batch application accessing a database to extract statistical data.
* The application runs multiple threads which issue database queries in parallel and perform some calculation on the results.
@@ -354,7 +354,7 @@
* On one hand, the time required for the statistical evaluation should not take too long.
* Therefore you will probably use a larger number of threads because most of its life time a thread will just wait for the database to return query results.
* On the other hand, the load on the database generated by all these threads should be limited so that the responsiveness of the production system is not affected.
- * With a <code>TimedSemaphore</code> object this can be achieved.
+ * With a {@code TimedSemaphore} object this can be achieved.
* The semaphore can be configured to allow e.g. 100 queries per second.
* After these queries have been sent to the database the threads have to wait until the second is over - then they can query again.
* By fine-tuning the limit enforced by the semaphore a good balance between performance and database load can be established.
@@ -362,9 +362,9 @@
* So this number can be reduced during the typical working hours and increased at night.</p>
*
* <p>The following code examples demonstrate parts of the implementation of such a scenario.
- * First the batch application has to create an instance of <code>TimedSemaphore</code> and to initialize its properties with default values:</p>
+ * First the batch application has to create an instance of {@code TimedSemaphore} and to initialize its properties with default values:</p>
*
- * <code>TimedSemaphore semaphore = new TimedSemaphore(1, TimeUnit.SECONDS, 100);</code>
+ * {@code TimedSemaphore semaphore = new TimedSemaphore(1, TimeUnit.SECONDS, 100);}
*
* <p>Here we specify that the semaphore should allow 100 permits in one second.
* This is effectively the limit of database queries per second in our example use case.
@@ -397,7 +397,7 @@
* </code>
* </pre>
*
- * <p>The important line here is the call to <code>semaphore.acquire()</code>.
+ * <p>The important line here is the call to {@code semaphore.acquire()}.
* If the number of permits in the current time frame has not yet been reached, the call returns immediately.
* Otherwise, it blocks until the end of the time frame.
* The last piece missing is a scheduler service which adapts the number of permits allowed by the semaphore according to the time of day.
@@ -430,7 +430,7 @@
*
* <p>With the {@link org.apache.commons.lang3.concurrent.TimedSemaphore#setLimit(int)} method the number of permits allowed for a time frame can be changed.
* There are some other methods for querying the internal state of a timed semaphore.
- * Also some statistical data is available, e.g. the average number of <code>acquire()</code> calls per time frame.
- * When a timed semaphore is no more needed, its <code>shutdown()</code> method has to be called.</p>
+ * Also some statistical data is available, e.g. the average number of {@code acquire()} calls per time frame.
+ * When a timed semaphore is no more needed, its {@code shutdown()} method has to be called.</p>
*/
package org.apache.commons.lang3.concurrent;
diff --git a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
index 5e9a784..42fc68d 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
@@ -100,9 +100,9 @@ public class EventListenerSupport<L> implements Serializable {
* @return an EventListenerSupport object which supports the specified
* listener type.
*
- * @throws NullPointerException if <code>listenerInterface</code> is
- * <code>null</code>.
- * @throws IllegalArgumentException if <code>listenerInterface</code> is
+ * @throws NullPointerException if {@code listenerInterface} is
+ * {@code null}.
+ * @throws IllegalArgumentException if {@code listenerInterface} is
* not an interface.
*/
public static <T> EventListenerSupport<T> create(final Class<T> listenerInterface) {
@@ -116,9 +116,9 @@ public class EventListenerSupport<L> implements Serializable {
* @param listenerInterface the type of listener interface that will receive
* events posted using this class.
*
- * @throws NullPointerException if <code>listenerInterface</code> is
- * <code>null</code>.
- * @throws IllegalArgumentException if <code>listenerInterface</code> is
+ * @throws NullPointerException if {@code listenerInterface} is
+ * {@code null}.
+ * @throws IllegalArgumentException if {@code listenerInterface} is
* not an interface.
*/
public EventListenerSupport(final Class<L> listenerInterface) {
@@ -133,9 +133,9 @@ public class EventListenerSupport<L> implements Serializable {
* @param listenerInterface the listener interface.
* @param classLoader the class loader.
*
- * @throws NullPointerException if <code>listenerInterface</code> or
- * <code>classLoader</code> is <code>null</code>.
- * @throws IllegalArgumentException if <code>listenerInterface</code> is
+ * @throws NullPointerException if {@code listenerInterface} or
+ * {@code classLoader} is {@code null}.
+ * @throws IllegalArgumentException if {@code listenerInterface} is
* not an interface.
*/
public EventListenerSupport(final Class<L> listenerInterface, final ClassLoader classLoader) {
@@ -173,10 +173,10 @@ public class EventListenerSupport<L> implements Serializable {
/**
* Registers an event listener.
*
- * @param listener the event listener (may not be <code>null</code>).
+ * @param listener the event listener (may not be {@code null}).
*
- * @throws NullPointerException if <code>listener</code> is
- * <code>null</code>.
+ * @throws NullPointerException if {@code listener} is
+ * {@code null}.
*/
public void addListener(final L listener) {
addListener(listener, true);
@@ -184,13 +184,13 @@ public class EventListenerSupport<L> implements Serializable {
/**
* Registers an event listener. Will not add a pre-existing listener
- * object to the list if <code>allowDuplicate</code> is false.
+ * object to the list if {@code allowDuplicate} is false.
*
- * @param listener the event listener (may not be <code>null</code>).
+ * @param listener the event listener (may not be {@code null}).
* @param allowDuplicate the flag for determining if duplicate listener
* objects are allowed to be registered.
*
- * @throws NullPointerException if <code>listener</code> is <code>null</code>.
+ * @throws NullPointerException if {@code listener} is {@code null}.
* @since 3.5
*/
public void addListener(final L listener, final boolean allowDuplicate) {
@@ -214,10 +214,10 @@ public class EventListenerSupport<L> implements Serializable {
/**
* Unregisters an event listener.
*
- * @param listener the event listener (may not be <code>null</code>).
+ * @param listener the event listener (may not be {@code null}).
*
- * @throws NullPointerException if <code>listener</code> is
- * <code>null</code>.
+ * @throws NullPointerException if {@code listener} is
+ * {@code null}.
*/
public void removeListener(final L listener) {
Validate.notNull(listener, "Listener object cannot be null.");
diff --git a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
index be5a7a2..5969614 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
@@ -33,7 +33,7 @@ import org.apache.commons.lang3.Validate;
/**
* <p>Provides utilities for manipulating and examining
- * <code>Throwable</code> objects.</p>
+ * {@code Throwable} objects.</p>
*
* @since 1.0
*/
@@ -68,29 +68,29 @@ public class ExceptionUtils {
//-----------------------------------------------------------------------
/**
- * <p>Introspects the <code>Throwable</code> to obtain the cause.</p>
+ * <p>Introspects the {@code Throwable} to obtain the cause.</p>
*
* <p>The method searches for methods with specific names that return a
- * <code>Throwable</code> object. This will pick up most wrapping exceptions,
+ * {@code Throwable} object. This will pick up most wrapping exceptions,
* including those from JDK 1.4.
*
* <p>The default list searched for are:</p>
* <ul>
- * <li><code>getCause()</code></li>
- * <li><code>getNextException()</code></li>
- * <li><code>getTargetException()</code></li>
- * <li><code>getException()</code></li>
- * <li><code>getSourceException()</code></li>
- * <li><code>getRootCause()</code></li>
- * <li><code>getCausedByException()</code></li>
- * <li><code>getNested()</code></li>
+ * <li>{@code getCause()}</li>
+ * <li>{@code getNextException()}</li>
+ * <li>{@code getTargetException()}</li>
+ * <li>{@code getException()}</li>
+ * <li>{@code getSourceException()}</li>
+ * <li>{@code getRootCause()}</li>
+ * <li>{@code getCausedByException()}</li>
+ * <li>{@code getNested()}</li>
* </ul>
*
- * <p>If none of the above is found, returns <code>null</code>.</p>
+ * <p>If none of the above is found, returns {@code null}.</p>
*
* @param throwable the throwable to introspect for a cause, may be null
- * @return the cause of the <code>Throwable</code>,
- * <code>null</code> if none found or null throwable input
+ * @return the cause of the {@code Throwable},
+ * {@code null} if none found or null throwable input
* @since 1.0
* @deprecated This feature will be removed in Lang 4.0, use {@link Throwable#getCause} instead
*/
@@ -100,15 +100,15 @@ public class ExceptionUtils {
}
/**
- * <p>Introspects the <code>Throwable</code> to obtain the cause.</p>
+ * <p>Introspects the {@code Throwable} to obtain the cause.</p>
*
- * <p>A <code>null</code> set of method names means use the default set.
- * A <code>null</code> in the set of method names will be ignored.</p>
+ * <p>A {@code null} set of method names means use the default set.
+ * A {@code null} in the set of method names will be ignored.</p>
*
* @param throwable the throwable to introspect for a cause, may be null
* @param methodNames the method names, null treated as default set
- * @return the cause of the <code>Throwable</code>,
- * <code>null</code> if none found or null throwable input
+ * @return the cause of the {@code Throwable},
+ * {@code null} if none found or null throwable input
* @since 1.0
* @deprecated This feature will be removed in Lang 4.0, use {@link Throwable#getCause} instead
*/
@@ -140,11 +140,11 @@ public class ExceptionUtils {
}
/**
- * <p>Finds a <code>Throwable</code> by method name.</p>
+ * <p>Finds a {@code Throwable} by method name.</p>
*
* @param throwable the exception to examine
* @param methodName the name of the method to find and invoke
- * @return the wrapped exception, or <code>null</code> if not found
+ * @return the wrapped exception, or {@code null} if not found
*/
// TODO: Remove in Lang 4.0
private static Throwable getCauseUsingMethodName(final Throwable throwable, final String methodName) {
@@ -201,7 +201,7 @@ public class ExceptionUtils {
}
/**
- * <p>Introspects the <code>Throwable</code> to obtain the root cause.</p>
+ * <p>Introspects the {@code Throwable} to obtain the root cause.</p>
*
* <p>This method walks through the exception chain to the last element,
* "root" of the tree, using {@link Throwable#getCause()}, and
@@ -214,8 +214,8 @@ public class ExceptionUtils {
* loop is returned.</p>
*
* @param throwable the throwable to get the root cause for, may be null
- * @return the root cause of the <code>Throwable</code>,
- * <code>null</code> if null throwable input
+ * @return the root cause of the {@code Throwable},
+ * {@code null} if null throwable input
*/
public static Throwable getRootCause(final Throwable throwable) {
final List<Throwable> list = getThrowableList(throwable);
@@ -242,7 +242,7 @@ public class ExceptionUtils {
//-----------------------------------------------------------------------
/**
* <p>Creates a compact stack trace for the root cause of the supplied
- * <code>Throwable</code>.</p>
+ * {@code Throwable}.</p>
*
* <p>The output of this method is consistent across JDK versions.
* It consists of the root exception followed by each of its wrapping
@@ -278,13 +278,13 @@ public class ExceptionUtils {
}
/**
- * <p>Produces a <code>List</code> of stack frames - the message
+ * <p>Produces a {@code List} of stack frames - the message
* is not included. Only the trace of the specified exception is
* returned, any caused by trace is stripped.</p>
*
* <p>This works in most cases - it will only fail if the exception
* message contains a line that starts with:
- * <code>" at".</code></p>
+ * {@code " at".}</p>
*
* @param t is any throwable
* @return List of stack frames
@@ -330,7 +330,7 @@ public class ExceptionUtils {
/**
* <p>Captures the stack trace associated with the specified
- * <code>Throwable</code> object, decomposing it into a list of
+ * {@code Throwable} object, decomposing it into a list of
* stack frames.</p>
*
* <p>The result of this method vary by JDK version as this method
@@ -338,7 +338,7 @@ public class ExceptionUtils {
* On JDK1.3 and earlier, the cause exception will not be shown
* unless the specified throwable alters printStackTrace.</p>
*
- * @param throwable the <code>Throwable</code> to examine, may be null
+ * @param throwable the {@code Throwable} to examine, may be null
* @return an array of strings describing each stack frame, never null
*/
public static String[] getStackFrames(final Throwable throwable) {
@@ -357,9 +357,9 @@ public class ExceptionUtils {
* On JDK1.3 and earlier, the cause exception will not be shown
* unless the specified throwable alters printStackTrace.</p>
*
- * @param throwable the <code>Throwable</code> to be examined
+ * @param throwable the {@code Throwable} to be examined
* @return the stack trace as generated by the exception's
- * <code>printStackTrace(PrintWriter)</code> method
+ * {@code printStackTrace(PrintWriter)} method
*/
public static String getStackTrace(final Throwable throwable) {
final StringWriter sw = new StringWriter();
@@ -370,12 +370,12 @@ public class ExceptionUtils {
//-----------------------------------------------------------------------
/**
- * <p>Counts the number of <code>Throwable</code> objects in the
+ * <p>Counts the number of {@code Throwable} objects in the
* exception chain.</p>
*
- * <p>A throwable without cause will return <code>1</code>.
- * A throwable with one cause will return <code>2</code> and so on.
- * A <code>null</code> throwable will return <code>0</code>.</p>
+ * <p>A throwable without cause will return {@code 1}.
+ * A throwable with one cause will return {@code 2} and so on.
+ * A {@code null} throwable will return {@code 0}.</p>
*
* <p>From version 2.2, this method handles recursive cause structures
* that might otherwise cause infinite loops. The cause chain is
@@ -390,14 +390,14 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the list of <code>Throwable</code> objects in the
+ * <p>Returns the list of {@code Throwable} objects in the
* exception chain.</p>
*
* <p>A throwable without cause will return a list containing
* one element - the input throwable.
* A throwable with one cause will return a list containing
* two elements. - the input throwable and the cause throwable.
- * A <code>null</code> throwable will return a list of size zero.</p>
+ * A {@code null} throwable will return a list of size zero.</p>
*
* <p>This method handles recursive cause structures that might
* otherwise cause infinite loops. The cause chain is processed until
@@ -418,14 +418,14 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the list of <code>Throwable</code> objects in the
+ * <p>Returns the list of {@code Throwable} objects in the
* exception chain.</p>
*
* <p>A throwable without cause will return an array containing
* one element - the input throwable.
* A throwable with one cause will return an array containing
* two elements. - the input throwable and the cause throwable.
- * A <code>null</code> throwable will return an array of size zero.</p>
+ * A {@code null} throwable will return an array of size zero.</p>
*
* <p>From version 2.2, this method handles recursive cause structures
* that might otherwise cause infinite loops. The cause chain is
@@ -463,15 +463,15 @@ public class ExceptionUtils {
}
/**
- * <p>Worker method for the <code>indexOfType</code> methods.</p>
+ * <p>Worker method for the {@code indexOfType} methods.</p>
*
* @param throwable the throwable to inspect, may be null
* @param type the type to search for, subclasses match, null returns -1
* @param fromIndex the (zero-based) index of the starting position,
* negative treated as zero, larger than chain size returns -1
- * @param subclass if <code>true</code>, compares with {@link Class#isAssignableFrom(Class)}, otherwise compares
+ * @param subclass if {@code true}, compares with {@link Class#isAssignableFrom(Class)}, otherwise compares
* using references
- * @return index of the <code>type</code> within throwables nested within the specified <code>throwable</code>
+ * @return index of the {@code type} within throwables nested within the specified {@code throwable}
*/
private static int indexOf(final Throwable throwable, final Class<?> type, int fromIndex, final boolean subclass) {
if (throwable == null || type == null) {
@@ -501,14 +501,14 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the (zero-based) index of the first <code>Throwable</code>
+ * <p>Returns the (zero-based) index of the first {@code Throwable}
* that matches the specified class (exactly) in the exception chain.
* Subclasses of the specified class do not match - see
* {@link #indexOfType(Throwable, Class)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>-1</code>.
- * A <code>null</code> type returns <code>-1</code>.
- * No match in the chain returns <code>-1</code>.</p>
+ * <p>A {@code null} throwable returns {@code -1}.
+ * A {@code null} type returns {@code -1}.
+ * No match in the chain returns {@code -1}.</p>
*
* @param throwable the throwable to inspect, may be null
* @param clazz the class to search for, subclasses do not match, null returns -1
@@ -519,17 +519,17 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the (zero-based) index of the first <code>Throwable</code>
+ * <p>Returns the (zero-based) index of the first {@code Throwable}
* that matches the specified type in the exception chain from
* a specified index.
* Subclasses of the specified class do not match - see
* {@link #indexOfType(Throwable, Class, int)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>-1</code>.
- * A <code>null</code> type returns <code>-1</code>.
- * No match in the chain returns <code>-1</code>.
+ * <p>A {@code null} throwable returns {@code -1}.
+ * A {@code null} type returns {@code -1}.
+ * No match in the chain returns {@code -1}.
* A negative start index is treated as zero.
- * A start index greater than the number of throwables returns <code>-1</code>.</p>
+ * A start index greater than the number of throwables returns {@code -1}.</p>
*
* @param throwable the throwable to inspect, may be null
* @param clazz the class to search for, subclasses do not match, null returns -1
@@ -542,14 +542,14 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the (zero-based) index of the first <code>Throwable</code>
+ * <p>Returns the (zero-based) index of the first {@code Throwable}
* that matches the specified class or subclass in the exception chain.
* Subclasses of the specified class do match - see
* {@link #indexOfThrowable(Throwable, Class)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>-1</code>.
- * A <code>null</code> type returns <code>-1</code>.
- * No match in the chain returns <code>-1</code>.</p>
+ * <p>A {@code null} throwable returns {@code -1}.
+ * A {@code null} type returns {@code -1}.
+ * No match in the chain returns {@code -1}.</p>
*
* @param throwable the throwable to inspect, may be null
* @param type the type to search for, subclasses match, null returns -1
@@ -561,17 +561,17 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the (zero-based) index of the first <code>Throwable</code>
+ * <p>Returns the (zero-based) index of the first {@code Throwable}
* that matches the specified type in the exception chain from
* a specified index.
* Subclasses of the specified class do match - see
* {@link #indexOfThrowable(Throwable, Class)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>-1</code>.
- * A <code>null</code> type returns <code>-1</code>.
- * No match in the chain returns <code>-1</code>.
+ * <p>A {@code null} throwable returns {@code -1}.
+ * A {@code null} type returns {@code -1}.
+ * No match in the chain returns {@code -1}.
* A negative start index is treated as zero.
- * A start index greater than the number of throwables returns <code>-1</code>.</p>
+ * A start index greater than the number of throwables returns {@code -1}.</p>
*
* @param throwable the throwable to inspect, may be null
* @param type the type to search for, subclasses match, null returns -1
@@ -587,7 +587,7 @@ public class ExceptionUtils {
//-----------------------------------------------------------------------
/**
* <p>Prints a compact stack trace for the root cause of a throwable
- * to <code>System.err</code>.</p>
+ * to {@code System.err}.</p>
*
* <p>The compact stack trace starts with the root cause and prints
* stack frames up to the place where it was caught and wrapped.
@@ -597,7 +597,7 @@ public class ExceptionUtils {
* <p>The output of this method is consistent across JDK versions.
* Note that this is the opposite order to the JDK1.4 display.</p>
*
- * <p>The method is equivalent to <code>printStackTrace</code> for throwables
+ * <p>The method is equivalent to {@code printStackTrace} for throwables
* that don't have nested causes.</p>
*
* @param throwable the throwable to output
@@ -618,12 +618,12 @@ public class ExceptionUtils {
* <p>The output of this method is consistent across JDK versions.
* Note that this is the opposite order to the JDK1.4 display.</p>
*
- * <p>The method is equivalent to <code>printStackTrace</code> for throwables
+ * <p>The method is equivalent to {@code printStackTrace} for throwables
* that don't have nested causes.</p>
*
* @param throwable the throwable to output, may be null
* @param stream the stream to output to, may not be null
- * @throws IllegalArgumentException if the stream is <code>null</code>
+ * @throws IllegalArgumentException if the stream is {@code null}
* @since 2.0
*/
public static void printRootCauseStackTrace(final Throwable throwable, final PrintStream stream) {
@@ -649,12 +649,12 @@ public class ExceptionUtils {
* <p>The output of this method is consistent across JDK versions.
* Note that this is the opposite order to the JDK1.4 display.</p>
*
- * <p>The method is equivalent to <code>printStackTrace</code> for throwables
+ * <p>The method is equivalent to {@code printStackTrace} for throwables
* that don't have nested causes.</p>
*
* @param throwable the throwable to output, may be null
* @param writer the writer to output to, may not be null
- * @throws IllegalArgumentException if the writer is <code>null</code>
+ * @throws IllegalArgumentException if the writer is {@code null}
* @since 2.0
*/
public static void printRootCauseStackTrace(final Throwable throwable, final PrintWriter writer) {
@@ -757,16 +757,16 @@ public class ExceptionUtils {
}
/**
- * <p>Worker method for the <code>throwableOfType</code> methods.</p>
+ * <p>Worker method for the {@code throwableOfType} methods.</p>
*
* @param <T> the type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null
* @param type the type to search, subclasses match, null returns null
* @param fromIndex the (zero-based) index of the starting position,
* negative treated as zero, larger than chain size returns null
- * @param subclass if <code>true</code>, compares with {@link Class#isAssignableFrom(Class)}, otherwise compares
+ * @param subclass if {@code true}, compares with {@link Class#isAssignableFrom(Class)}, otherwise compares
* using references
- * @return throwable of the <code>type</code> within throwables nested within the specified <code>throwable</code>
+ * @return throwable of the {@code type} within throwables nested within the specified {@code throwable}
*/
private static <T extends Throwable> T throwableOf(final Throwable throwable, final Class<T> type, int fromIndex, final boolean subclass) {
if (throwable == null || type == null) {
@@ -796,14 +796,14 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the first <code>Throwable</code>
+ * <p>Returns the first {@code Throwable}
* that matches the specified class (exactly) in the exception chain.
* Subclasses of the specified class do not match - see
* {@link #throwableOfType(Throwable, Class)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>null</code>.
- * A <code>null</code> type returns <code>null</code>.
- * No match in the chain returns <code>null</code>.</p>
+ * <p>A {@code null} throwable returns {@code null}.
+ * A {@code null} type returns {@code null}.
+ * No match in the chain returns {@code null}.</p>
*
* @param <T> the type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null
@@ -816,17 +816,17 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the first <code>Throwable</code>
+ * <p>Returns the first {@code Throwable}
* that matches the specified type in the exception chain from
* a specified index.
* Subclasses of the specified class do not match - see
* {@link #throwableOfType(Throwable, Class, int)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>null</code>.
- * A <code>null</code> type returns <code>null</code>.
- * No match in the chain returns <code>null</code>.
+ * <p>A {@code null} throwable returns {@code null}.
+ * A {@code null} type returns {@code null}.
+ * No match in the chain returns {@code null}.
* A negative start index is treated as zero.
- * A start index greater than the number of throwables returns <code>null</code>.</p>
+ * A start index greater than the number of throwables returns {@code null}.</p>
*
* @param <T> the type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null
@@ -841,14 +841,14 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the throwable of the first <code>Throwable</code>
+ * <p>Returns the throwable of the first {@code Throwable}
* that matches the specified class or subclass in the exception chain.
* Subclasses of the specified class do match - see
* {@link #throwableOfThrowable(Throwable, Class)} for the opposite..</p>
*
- * <p>A <code>null</code> throwable returns <code>null</code>.
- * A <code>null</code> type returns <code>null</code>.
- * No match in the chain returns <code>null</code>.</p>
+ * <p>A {@code null} throwable returns {@code null}.
+ * A {@code null} type returns {@code null}.
+ * No match in the chain returns {@code null}.</p>
*
* @param <T> the type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null
@@ -861,17 +861,17 @@ public class ExceptionUtils {
}
/**
- * <p>Returns the first <code>Throwable</code>
+ * <p>Returns the first {@code Throwable}
* that matches the specified type in the exception chain from
* a specified index.
* Subclasses of the specified class do match - see
* {@link #throwableOfThrowable(Throwable, Class)} for the opposite.</p>
*
- * <p>A <code>null</code> throwable returns <code>null</code>.
- * A <code>null</code> type returns <code>null</code>.
- * No match in the chain returns <code>null</code>.
+ * <p>A {@code null} throwable returns {@code null}.
+ * A {@code null} type returns {@code null}.
+ * No match in the chain returns {@code null}.
* A negative start index is treated as zero.
- * A start index greater than the number of throwables returns <code>null</code>.</p>
+ * A start index greater than the number of throwables returns {@code null}.</p>
*
* @param <T> the type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null
@@ -929,7 +929,7 @@ public class ExceptionUtils {
/**
* <p>
- * Public constructor allows an instance of <code>ExceptionUtils</code> to be created, although that is not
+ * Public constructor allows an instance of {@code ExceptionUtils} to be created, although that is not
* normally necessary.
* </p>
*/
diff --git a/src/main/java/org/apache/commons/lang3/exception/package-info.java b/src/main/java/org/apache/commons/lang3/exception/package-info.java
index b2f31a9..5992010 100644
--- a/src/main/java/org/apache/commons/lang3/exception/package-info.java
+++ b/src/main/java/org/apache/commons/lang3/exception/package-info.java
@@ -18,7 +18,7 @@
* <p>Provides functionality for Exceptions.</p>
* <p>Contains the concept of an exception with context i.e. such an exception will contain a map with keys and values.
* This provides an easy way to pass valuable state information at exception time in useful form to a calling process.</p>
- * <p>Lastly, {@link org.apache.commons.lang3.exception.ExceptionUtils} also contains <code>Throwable</code> manipulation
+ * <p>Lastly, {@link org.apache.commons.lang3.exception.ExceptionUtils} also contains {@code Throwable} manipulation
* and examination routines.</p>
*
* @since 1.0
diff --git a/src/main/java/org/apache/commons/lang3/math/Fraction.java b/src/main/java/org/apache/commons/lang3/math/Fraction.java
index 6271add..7d452c1 100644
--- a/src/main/java/org/apache/commons/lang3/math/Fraction.java
+++ b/src/main/java/org/apache/commons/lang3/math/Fraction.java
@@ -21,11 +21,11 @@ import java.math.BigInteger;
import org.apache.commons.lang3.Validate;
/**
- * <p><code>Fraction</code> is a <code>Number</code> implementation that
+ * <p>{@code Fraction} is a {@code Number} implementation that
* stores fractions accurately.</p>
*
* <p>This class is immutable, and interoperable with most methods that accept
- * a <code>Number</code>.</p>
+ * a {@code Number}.</p>
*
* <p>Note that this class is intended for common use cases, it is <i>int</i>
* based and thus suffers from various overflow issues. For a BigInteger based
@@ -43,51 +43,51 @@ public final class Fraction extends Number implements Comparable<Fraction> {
private static final long serialVersionUID = 65382027393090L;
/**
- * <code>Fraction</code> representation of 0.
+ * {@code Fraction} representation of 0.
*/
public static final Fraction ZERO = new Fraction(0, 1);
/**
- * <code>Fraction</code> representation of 1.
+ * {@code Fraction} representation of 1.
*/
public static final Fraction ONE = new Fraction(1, 1);
/**
- * <code>Fraction</code> representation of 1/2.
+ * {@code Fraction} representation of 1/2.
*/
public static final Fraction ONE_HALF = new Fraction(1, 2);
/**
- * <code>Fraction</code> representation of 1/3.
+ * {@code Fraction} representation of 1/3.
*/
public static final Fraction ONE_THIRD = new Fraction(1, 3);
/**
- * <code>Fraction</code> representation of 2/3.
+ * {@code Fraction} representation of 2/3.
*/
public static final Fraction TWO_THIRDS = new Fraction(2, 3);
/**
- * <code>Fraction</code> representation of 1/4.
+ * {@code Fraction} representation of 1/4.
*/
public static final Fraction ONE_QUARTER = new Fraction(1, 4);
/**
- * <code>Fraction</code> representation of 2/4.
+ * {@code Fraction} representation of 2/4.
*/
public static final Fraction TWO_QUARTERS = new Fraction(2, 4);
/**
- * <code>Fraction</code> representation of 3/4.
+ * {@code Fraction} representation of 3/4.
*/
public static final Fraction THREE_QUARTERS = new Fraction(3, 4);
/**
- * <code>Fraction</code> representation of 1/5.
+ * {@code Fraction} representation of 1/5.
*/
public static final Fraction ONE_FIFTH = new Fraction(1, 5);
/**
- * <code>Fraction</code> representation of 2/5.
+ * {@code Fraction} representation of 2/5.
*/
public static final Fraction TWO_FIFTHS = new Fraction(2, 5);
/**
- * <code>Fraction</code> representation of 3/5.
+ * {@code Fraction} representation of 3/5.
*/
public static final Fraction THREE_FIFTHS = new Fraction(3, 5);
/**
- * <code>Fraction</code> representation of 4/5.
+ * {@code Fraction} representation of 4/5.
*/
public static final Fraction FOUR_FIFTHS = new Fraction(4, 5);
@@ -115,7 +115,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
private transient String toProperString = null;
/**
- * <p>Constructs a <code>Fraction</code> instance with the 2 parts
+ * <p>Constructs a {@code Fraction} instance with the 2 parts
* of a fraction Y/Z.</p>
*
* @param numerator the numerator, for example the three in 'three sevenths'
@@ -128,7 +128,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Creates a <code>Fraction</code> instance with the 2 parts
+ * <p>Creates a {@code Fraction} instance with the 2 parts
* of a fraction Y/Z.</p>
*
* <p>Any negative signs are resolved to be on the numerator.</p>
@@ -136,7 +136,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* @param numerator the numerator, for example the three in 'three sevenths'
* @param denominator the denominator, for example the seven in 'three sevenths'
* @return a new fraction instance
- * @throws ArithmeticException if the denominator is <code>zero</code>
+ * @throws ArithmeticException if the denominator is {@code zero}
* or the denominator is {@code negative} and the numerator is {@code Integer#MIN_VALUE}
*/
public static Fraction getFraction(int numerator, int denominator) {
@@ -154,7 +154,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Creates a <code>Fraction</code> instance with the 3 parts
+ * <p>Creates a {@code Fraction} instance with the 3 parts
* of a fraction X Y/Z.</p>
*
* <p>The negative sign must be passed in on the whole number part.</p>
@@ -163,11 +163,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* @param numerator the numerator, for example the three in 'one and three sevenths'
* @param denominator the denominator, for example the seven in 'one and three sevenths'
* @return a new fraction instance
- * @throws ArithmeticException if the denominator is <code>zero</code>
+ * @throws ArithmeticException if the denominator is {@code zero}
* @throws ArithmeticException if the denominator is negative
* @throws ArithmeticException if the numerator is negative
* @throws ArithmeticException if the resulting numerator exceeds
- * <code>Integer.MAX_VALUE</code>
+ * {@code Integer.MAX_VALUE}
*/
public static Fraction getFraction(final int whole, final int numerator, final int denominator) {
if (denominator == 0) {
@@ -192,7 +192,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Creates a reduced <code>Fraction</code> instance with the 2 parts
+ * <p>Creates a reduced {@code Fraction} instance with the 2 parts
* of a fraction Y/Z.</p>
*
* <p>For example, if the input parameters represent 2/4, then the created
@@ -203,7 +203,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* @param numerator the numerator, for example the three in 'three sevenths'
* @param denominator the denominator, for example the seven in 'three sevenths'
* @return a new fraction instance, with the numerator and denominator reduced
- * @throws ArithmeticException if the denominator is <code>zero</code>
+ * @throws ArithmeticException if the denominator is {@code zero}
*/
public static Fraction getReducedFraction(int numerator, int denominator) {
if (denominator == 0) {
@@ -232,7 +232,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Creates a <code>Fraction</code> instance from a <code>double</code> value.</p>
+ * <p>Creates a {@code Fraction} instance from a {@code double} value.</p>
*
* <p>This method uses the <a href="http://archives.math.utk.edu/articles/atuyl/confrac/">
* continued fraction algorithm</a>, computing a maximum of
@@ -240,9 +240,9 @@ public final class Fraction extends Number implements Comparable<Fraction> {
*
* @param value the double value to convert
* @return a new fraction instance that is close to the value
- * @throws ArithmeticException if <code>|value| > Integer.MAX_VALUE</code>
- * or <code>value = NaN</code>
- * @throws ArithmeticException if the calculated denominator is <code>zero</code>
+ * @throws ArithmeticException if {@code |value| > Integer.MAX_VALUE}
+ * or {@code value = NaN}
+ * @throws ArithmeticException if the calculated denominator is {@code zero}
* @throws ArithmeticException if the algorithm does not converge
*/
public static Fraction getFraction(double value) {
@@ -294,21 +294,21 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Creates a Fraction from a <code>String</code>.</p>
+ * <p>Creates a Fraction from a {@code String}.</p>
*
* <p>The formats accepted are:</p>
*
* <ol>
- * <li><code>double</code> String containing a dot</li>
+ * <li>{@code double} String containing a dot</li>
* <li>'X Y/Z'</li>
* <li>'Y/Z'</li>
* <li>'X' (a simple whole number)</li>
* </ol>
* <p>and a .</p>
*
- * @param str the string to parse, must not be <code>null</code>
- * @return the new <code>Fraction</code> instance
- * @throws IllegalArgumentException if the string is <code>null</code>
+ * @param str the string to parse, must not be {@code null}
+ * @return the new {@code Fraction} instance
+ * @throws IllegalArgumentException if the string is {@code null}
* @throws NumberFormatException if the number format is invalid
*/
public static Fraction getFraction(String str) {
@@ -402,7 +402,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
//-------------------------------------------------------------------
/**
- * <p>Gets the fraction as an <code>int</code>. This returns the whole number
+ * <p>Gets the fraction as an {@code int}. This returns the whole number
* part of the fraction.</p>
*
* @return the whole number fraction part
@@ -413,7 +413,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Gets the fraction as a <code>long</code>. This returns the whole number
+ * <p>Gets the fraction as a {@code long}. This returns the whole number
* part of the fraction.</p>
*
* @return the whole number fraction part
@@ -424,10 +424,10 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Gets the fraction as a <code>float</code>. This calculates the fraction
+ * <p>Gets the fraction as a {@code float}. This calculates the fraction
* as the numerator divided by denominator.</p>
*
- * @return the fraction as a <code>float</code>
+ * @return the fraction as a {@code float}
*/
@Override
public float floatValue() {
@@ -435,10 +435,10 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Gets the fraction as a <code>double</code>. This calculates the fraction
+ * <p>Gets the fraction as a {@code double}. This calculates the fraction
* as the numerator divided by denominator.</p>
*
- * @return the fraction as a <code>double</code>
+ * @return the fraction as a {@code double}
*/
@Override
public double doubleValue() {
@@ -507,11 +507,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
/**
* <p>Gets a fraction that is the positive equivalent of this one.</p>
- * <p>More precisely: <code>(fraction >= 0 ? this : -fraction)</code></p>
+ * <p>More precisely: {@code (fraction >= 0 ? this : -fraction)}</p>
*
* <p>The returned fraction is not reduced.</p>
*
- * @return <code>this</code> if it is positive, or a new positive fraction
+ * @return {@code this} if it is positive, or a new positive fraction
* instance with the opposite signed numerator
*/
public Fraction abs() {
@@ -527,11 +527,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* <p>The returned fraction is in reduced form.</p>
*
* @param power the power to raise the fraction to
- * @return <code>this</code> if the power is one, <code>ONE</code> if the power
+ * @return {@code this} if the power is one, {@code ONE} if the power
* is zero (even if the fraction equals ZERO) or a new fraction instance
* raised to the appropriate power
* @throws ArithmeticException if the resulting numerator or denominator exceeds
- * <code>Integer.MAX_VALUE</code>
+ * {@code Integer.MAX_VALUE}
*/
public Fraction pow(final int power) {
if (power == 1) {
@@ -627,7 +627,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
*
* @param x a factor
* @param y a factor
- * @return the product <code>x*y</code>
+ * @return the product {@code x*y}
* @throws ArithmeticException if the result can not be represented as
* an int
*/
@@ -644,7 +644,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
*
* @param x a non-negative factor
* @param y a non-negative factor
- * @return the product <code>x*y</code>
+ * @return the product {@code x*y}
* @throws ArithmeticException if the result can not be represented as
* an int
*/
@@ -662,7 +662,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
*
* @param x an addend
* @param y an addend
- * @return the sum <code>x+y</code>
+ * @return the sum {@code x+y}
* @throws ArithmeticException if the result can not be represented as
* an int
*/
@@ -679,7 +679,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
*
* @param x the minuend
* @param y the subtrahend
- * @return the difference <code>x-y</code>
+ * @return the difference {@code x-y}
* @throws ArithmeticException if the result can not be represented as
* an int
*/
@@ -695,11 +695,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* <p>Adds the value of this fraction to another, returning the result in reduced form.
* The algorithm follows Knuth, 4.5.1.</p>
*
- * @param fraction the fraction to add, must not be <code>null</code>
- * @return a <code>Fraction</code> instance with the resulting values
- * @throws IllegalArgumentException if the fraction is <code>null</code>
+ * @param fraction the fraction to add, must not be {@code null}
+ * @return a {@code Fraction} instance with the resulting values
+ * @throws IllegalArgumentException if the fraction is {@code null}
* @throws ArithmeticException if the resulting numerator or denominator exceeds
- * <code>Integer.MAX_VALUE</code>
+ * {@code Integer.MAX_VALUE}
*/
public Fraction add(final Fraction fraction) {
return addSub(fraction, true /* add */);
@@ -709,11 +709,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* <p>Subtracts the value of another fraction from the value of this one,
* returning the result in reduced form.</p>
*
- * @param fraction the fraction to subtract, must not be <code>null</code>
- * @return a <code>Fraction</code> instance with the resulting values
- * @throws IllegalArgumentException if the fraction is <code>null</code>
+ * @param fraction the fraction to subtract, must not be {@code null}
+ * @return a {@code Fraction} instance with the resulting values
+ * @throws IllegalArgumentException if the fraction is {@code null}
* @throws ArithmeticException if the resulting numerator or denominator
- * cannot be represented in an <code>int</code>.
+ * cannot be represented in an {@code int}.
*/
public Fraction subtract(final Fraction fraction) {
return addSub(fraction, false /* subtract */);
@@ -722,12 +722,12 @@ public final class Fraction extends Number implements Comparable<Fraction> {
/**
* Implement add and subtract using algorithm described in Knuth 4.5.1.
*
- * @param fraction the fraction to subtract, must not be <code>null</code>
+ * @param fraction the fraction to subtract, must not be {@code null}
* @param isAdd true to add, false to subtract
- * @return a <code>Fraction</code> instance with the resulting values
- * @throws IllegalArgumentException if the fraction is <code>null</code>
+ * @return a {@code Fraction} instance with the resulting values
+ * @throws IllegalArgumentException if the fraction is {@code null}
* @throws ArithmeticException if the resulting numerator or denominator
- * cannot be represented in an <code>int</code>.
+ * cannot be represented in an {@code int}.
*/
private Fraction addSub(final Fraction fraction, final boolean isAdd) {
Validate.isTrue(fraction != null, "The fraction must not be null");
@@ -771,11 +771,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* <p>Multiplies the value of this fraction by another, returning the
* result in reduced form.</p>
*
- * @param fraction the fraction to multiply by, must not be <code>null</code>
- * @return a <code>Fraction</code> instance with the resulting values
- * @throws IllegalArgumentException if the fraction is <code>null</code>
+ * @param fraction the fraction to multiply by, must not be {@code null}
+ * @return a {@code Fraction} instance with the resulting values
+ * @throws IllegalArgumentException if the fraction is {@code null}
* @throws ArithmeticException if the resulting numerator or denominator exceeds
- * <code>Integer.MAX_VALUE</code>
+ * {@code Integer.MAX_VALUE}
*/
public Fraction multiplyBy(final Fraction fraction) {
Validate.isTrue(fraction != null, "The fraction must not be null");
@@ -793,12 +793,12 @@ public final class Fraction extends Number implements Comparable<Fraction> {
/**
* <p>Divide the value of this fraction by another.</p>
*
- * @param fraction the fraction to divide by, must not be <code>null</code>
- * @return a <code>Fraction</code> instance with the resulting values
- * @throws IllegalArgumentException if the fraction is <code>null</code>
+ * @param fraction the fraction to divide by, must not be {@code null}
+ * @return a {@code Fraction} instance with the resulting values
+ * @throws IllegalArgumentException if the fraction is {@code null}
* @throws ArithmeticException if the fraction to divide by is zero
* @throws ArithmeticException if the resulting numerator or denominator exceeds
- * <code>Integer.MAX_VALUE</code>
+ * {@code Integer.MAX_VALUE}
*/
public Fraction divideBy(final Fraction fraction) {
Validate.isTrue(fraction != null, "The fraction must not be null");
@@ -817,7 +817,7 @@ public final class Fraction extends Number implements Comparable<Fraction> {
* <p>To be equal, both values must be equal. Thus 2/4 is not equal to 1/2.</p>
*
* @param obj the reference object with which to compare
- * @return <code>true</code> if this object is equal
+ * @return {@code true} if this object is equal
*/
@Override
public boolean equals(final Object obj) {
@@ -854,8 +854,8 @@ public final class Fraction extends Number implements Comparable<Fraction> {
*
* @param other the object to compare to
* @return -1 if this is less, 0 if equal, +1 if greater
- * @throws ClassCastException if the object is not a <code>Fraction</code>
- * @throws NullPointerException if the object is <code>null</code>
+ * @throws ClassCastException if the object is not a {@code Fraction}
+ * @throws NullPointerException if the object is {@code null}
*/
@Override
public int compareTo(final Fraction other) {
@@ -873,11 +873,11 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Gets the fraction as a <code>String</code>.</p>
+ * <p>Gets the fraction as a {@code String}.</p>
*
* <p>The format used is '<i>numerator</i>/<i>denominator</i>' always.
*
- * @return a <code>String</code> form of the fraction
+ * @return a {@code String} form of the fraction
*/
@Override
public String toString() {
@@ -888,13 +888,13 @@ public final class Fraction extends Number implements Comparable<Fraction> {
}
/**
- * <p>Gets the fraction as a proper <code>String</code> in the format X Y/Z.</p>
+ * <p>Gets the fraction as a proper {@code String} in the format X Y/Z.</p>
*
* <p>The format used in '<i>wholeNumber</i> <i>numerator</i>/<i>denominator</i>'.
* If the whole number is zero it will be omitted. If the numerator is zero,
* only the whole number is returned.</p>
*
- * @return a <code>String</code> form of the fraction
+ * @return a {@code String} form of the fraction
*/
public String toProperString() {
if (toProperString == null) {
diff --git a/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java b/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java
index fea8504..d9fb5fa 100644
--- a/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java
+++ b/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java
@@ -32,8 +32,8 @@ public class IEEE754rUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from min(double[]) to min(double...)
*/
public static double min(final double... array) {
@@ -54,8 +54,8 @@ public class IEEE754rUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from min(float[]) to min(float...)
*/
public static float min(final float... array) {
@@ -72,7 +72,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the minimum of three <code>double</code> values.</p>
+ * <p>Gets the minimum of three {@code double} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -86,7 +86,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the minimum of two <code>double</code> values.</p>
+ * <p>Gets the minimum of two {@code double} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -106,7 +106,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the minimum of three <code>float</code> values.</p>
+ * <p>Gets the minimum of three {@code float} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -120,7 +120,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the minimum of two <code>float</code> values.</p>
+ * <p>Gets the minimum of two {@code float} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -144,8 +144,8 @@ public class IEEE754rUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from max(double[]) to max(double...)
*/
public static double max(final double... array) {
@@ -166,8 +166,8 @@ public class IEEE754rUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from max(float[]) to max(float...)
*/
public static float max(final float... array) {
@@ -184,7 +184,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the maximum of three <code>double</code> values.</p>
+ * <p>Gets the maximum of three {@code double} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -198,7 +198,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the maximum of two <code>double</code> values.</p>
+ * <p>Gets the maximum of two {@code double} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -218,7 +218,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the maximum of three <code>float</code> values.</p>
+ * <p>Gets the maximum of three {@code float} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
@@ -232,7 +232,7 @@ public class IEEE754rUtils {
}
/**
- * <p>Gets the maximum of two <code>float</code> values.</p>
+ * <p>Gets the maximum of two {@code float} values.</p>
*
* <p>NaN is only returned if all numbers are NaN as per IEEE-754r. </p>
*
diff --git a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
index bffff0d..97aee23 100644
--- a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
+++ b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
@@ -72,8 +72,8 @@ public class NumberUtils {
/**
- * <p><code>NumberUtils</code> instances should NOT be constructed in standard programming.
- * Instead, the class should be used as <code>NumberUtils.toInt("6");</code>.</p>
+ * <p>{@code NumberUtils} instances should NOT be constructed in standard programming.
+ * Instead, the class should be used as {@code NumberUtils.toInt("6");}.</p>
*
* <p>This constructor is public to permit tools that require a JavaBean instance
* to operate.</p>
@@ -84,10 +84,10 @@ public class NumberUtils {
//-----------------------------------------------------------------------
/**
- * <p>Convert a <code>String</code> to an <code>int</code>, returning
- * <code>zero</code> if the conversion fails.</p>
+ * <p>Convert a {@code String} to an {@code int}, returning
+ * {@code zero} if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, <code>zero</code> is returned.</p>
+ * <p>If the string is {@code null}, {@code zero} is returned.</p>
*
* <pre>
* NumberUtils.toInt(null) = 0
@@ -96,7 +96,7 @@ public class NumberUtils {
* </pre>
*
* @param str the string to convert, may be null
- * @return the int represented by the string, or <code>zero</code> if
+ * @return the int represented by the string, or {@code zero} if
* conversion fails
* @since 2.1
*/
@@ -105,10 +105,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to an <code>int</code>, returning a
+ * <p>Convert a {@code String} to an {@code int}, returning a
* default value if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, the default value is returned.</p>
+ * <p>If the string is {@code null}, the default value is returned.</p>
*
* <pre>
* NumberUtils.toInt(null, 1) = 1
@@ -133,10 +133,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>long</code>, returning
- * <code>zero</code> if the conversion fails.</p>
+ * <p>Convert a {@code String} to a {@code long}, returning
+ * {@code zero} if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, <code>zero</code> is returned.</p>
+ * <p>If the string is {@code null}, {@code zero} is returned.</p>
*
* <pre>
* NumberUtils.toLong(null) = 0L
@@ -145,7 +145,7 @@ public class NumberUtils {
* </pre>
*
* @param str the string to convert, may be null
- * @return the long represented by the string, or <code>0</code> if
+ * @return the long represented by the string, or {@code 0} if
* conversion fails
* @since 2.1
*/
@@ -154,10 +154,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>long</code>, returning a
+ * <p>Convert a {@code String} to a {@code long}, returning a
* default value if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, the default value is returned.</p>
+ * <p>If the string is {@code null}, the default value is returned.</p>
*
* <pre>
* NumberUtils.toLong(null, 1L) = 1L
@@ -182,11 +182,11 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>float</code>, returning
- * <code>0.0f</code> if the conversion fails.</p>
+ * <p>Convert a {@code String} to a {@code float}, returning
+ * {@code 0.0f} if the conversion fails.</p>
*
- * <p>If the string <code>str</code> is <code>null</code>,
- * <code>0.0f</code> is returned.</p>
+ * <p>If the string {@code str} is {@code null},
+ * {@code 0.0f} is returned.</p>
*
* <pre>
* NumberUtils.toFloat(null) = 0.0f
@@ -194,8 +194,8 @@ public class NumberUtils {
* NumberUtils.toFloat("1.5") = 1.5f
* </pre>
*
- * @param str the string to convert, may be <code>null</code>
- * @return the float represented by the string, or <code>0.0f</code>
+ * @param str the string to convert, may be {@code null}
+ * @return the float represented by the string, or {@code 0.0f}
* if conversion fails
* @since 2.1
*/
@@ -204,10 +204,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>float</code>, returning a
+ * <p>Convert a {@code String} to a {@code float}, returning a
* default value if the conversion fails.</p>
*
- * <p>If the string <code>str</code> is <code>null</code>, the default
+ * <p>If the string {@code str} is {@code null}, the default
* value is returned.</p>
*
* <pre>
@@ -216,7 +216,7 @@ public class NumberUtils {
* NumberUtils.toFloat("1.5", 0.0f) = 1.5f
* </pre>
*
- * @param str the string to convert, may be <code>null</code>
+ * @param str the string to convert, may be {@code null}
* @param defaultValue the default value
* @return the float represented by the string, or defaultValue
* if conversion fails
@@ -234,11 +234,11 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>double</code>, returning
- * <code>0.0d</code> if the conversion fails.</p>
+ * <p>Convert a {@code String} to a {@code double}, returning
+ * {@code 0.0d} if the conversion fails.</p>
*
- * <p>If the string <code>str</code> is <code>null</code>,
- * <code>0.0d</code> is returned.</p>
+ * <p>If the string {@code str} is {@code null},
+ * {@code 0.0d} is returned.</p>
*
* <pre>
* NumberUtils.toDouble(null) = 0.0d
@@ -246,8 +246,8 @@ public class NumberUtils {
* NumberUtils.toDouble("1.5") = 1.5d
* </pre>
*
- * @param str the string to convert, may be <code>null</code>
- * @return the double represented by the string, or <code>0.0d</code>
+ * @param str the string to convert, may be {@code null}
+ * @return the double represented by the string, or {@code 0.0d}
* if conversion fails
* @since 2.1
*/
@@ -256,10 +256,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>double</code>, returning a
+ * <p>Convert a {@code String} to a {@code double}, returning a
* default value if the conversion fails.</p>
*
- * <p>If the string <code>str</code> is <code>null</code>, the default
+ * <p>If the string {@code str} is {@code null}, the default
* value is returned.</p>
*
* <pre>
@@ -268,7 +268,7 @@ public class NumberUtils {
* NumberUtils.toDouble("1.5", 0.0d) = 1.5d
* </pre>
*
- * @param str the string to convert, may be <code>null</code>
+ * @param str the string to convert, may be {@code null}
* @param defaultValue the default value
* @return the double represented by the string, or defaultValue
* if conversion fails
@@ -286,19 +286,19 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>BigDecimal</code> to a <code>double</code>.</p>
+ * <p>Convert a {@code BigDecimal} to a {@code double}.</p>
*
- * <p>If the <code>BigDecimal</code> <code>value</code> is
- * <code>null</code>, then the specified default value is returned.</p>
+ * <p>If the {@code BigDecimal} {@code value} is
+ * {@code null}, then the specified default value is returned.</p>
*
* <pre>
* NumberUtils.toDouble(null) = 0.0d
* NumberUtils.toDouble(BigDecimal.valudOf(8.5d)) = 8.5d
* </pre>
*
- * @param value the <code>BigDecimal</code> to convert, may be <code>null</code>.
- * @return the double represented by the <code>BigDecimal</code> or
- * <code>0.0d</code> if the <code>BigDecimal</code> is <code>null</code>.
+ * @param value the {@code BigDecimal} to convert, may be {@code null}.
+ * @return the double represented by the {@code BigDecimal} or
+ * {@code 0.0d} if the {@code BigDecimal} is {@code null}.
* @since 3.8
*/
public static double toDouble(final BigDecimal value) {
@@ -306,20 +306,20 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>BigDecimal</code> to a <code>double</code>.</p>
+ * <p>Convert a {@code BigDecimal} to a {@code double}.</p>
*
- * <p>If the <code>BigDecimal</code> <code>value</code> is
- * <code>null</code>, then the specified default value is returned.</p>
+ * <p>If the {@code BigDecimal} {@code value} is
+ * {@code null}, then the specified default value is returned.</p>
*
* <pre>
* NumberUtils.toDouble(null, 1.1d) = 1.1d
* NumberUtils.toDouble(BigDecimal.valudOf(8.5d), 1.1d) = 8.5d
* </pre>
*
- * @param value the <code>BigDecimal</code> to convert, may be <code>null</code>.
+ * @param value the {@code BigDecimal} to convert, may be {@code null}.
* @param defaultValue the default value
- * @return the double represented by the <code>BigDecimal</code> or the
- * defaultValue if the <code>BigDecimal</code> is <code>null</code>.
+ * @return the double represented by the {@code BigDecimal} or the
+ * defaultValue if the {@code BigDecimal} is {@code null}.
* @since 3.8
*/
public static double toDouble(final BigDecimal value, final double defaultValue) {
@@ -328,10 +328,10 @@ public class NumberUtils {
//-----------------------------------------------------------------------
/**
- * <p>Convert a <code>String</code> to a <code>byte</code>, returning
- * <code>zero</code> if the conversion fails.</p>
+ * <p>Convert a {@code String} to a {@code byte}, returning
+ * {@code zero} if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, <code>zero</code> is returned.</p>
+ * <p>If the string is {@code null}, {@code zero} is returned.</p>
*
* <pre>
* NumberUtils.toByte(null) = 0
@@ -340,7 +340,7 @@ public class NumberUtils {
* </pre>
*
* @param str the string to convert, may be null
- * @return the byte represented by the string, or <code>zero</code> if
+ * @return the byte represented by the string, or {@code zero} if
* conversion fails
* @since 2.5
*/
@@ -349,10 +349,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>byte</code>, returning a
+ * <p>Convert a {@code String} to a {@code byte}, returning a
* default value if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, the default value is returned.</p>
+ * <p>If the string is {@code null}, the default value is returned.</p>
*
* <pre>
* NumberUtils.toByte(null, 1) = 1
@@ -377,10 +377,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>short</code>, returning
- * <code>zero</code> if the conversion fails.</p>
+ * <p>Convert a {@code String} to a {@code short}, returning
+ * {@code zero} if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, <code>zero</code> is returned.</p>
+ * <p>If the string is {@code null}, {@code zero} is returned.</p>
*
* <pre>
* NumberUtils.toShort(null) = 0
@@ -389,7 +389,7 @@ public class NumberUtils {
* </pre>
*
* @param str the string to convert, may be null
- * @return the short represented by the string, or <code>zero</code> if
+ * @return the short represented by the string, or {@code zero} if
* conversion fails
* @since 2.5
*/
@@ -398,10 +398,10 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to an <code>short</code>, returning a
+ * <p>Convert a {@code String} to an {@code short}, returning a
* default value if the conversion fails.</p>
*
- * <p>If the string is <code>null</code>, the default value is returned.</p>
+ * <p>If the string is {@code null}, the default value is returned.</p>
*
* <pre>
* NumberUtils.toShort(null, 1) = 1
@@ -426,15 +426,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>BigDecimal</code> to a <code>BigDecimal</code> with a scale of
- * two that has been rounded using <code>RoundingMode.HALF_EVEN</code>. If the supplied
- * <code>value</code> is null, then <code>BigDecimal.ZERO</code> is returned.
+ * Convert a {@code BigDecimal} to a {@code BigDecimal} with a scale of
+ * two that has been rounded using {@code RoundingMode.HALF_EVEN}. If the supplied
+ * {@code value} is null, then {@code BigDecimal.ZERO} is returned.
*
- * <p>Note, the scale of a <code>BigDecimal</code> is the number of digits to the right of the
+ * <p>Note, the scale of a {@code BigDecimal} is the number of digits to the right of the
* decimal point.</p>
*
- * @param value the <code>BigDecimal</code> to convert, may be null.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @param value the {@code BigDecimal} to convert, may be null.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final BigDecimal value) {
@@ -442,15 +442,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>BigDecimal</code> to a <code>BigDecimal</code> whose scale is the
- * specified value with a <code>RoundingMode</code> applied. If the input <code>value</code>
- * is <code>null</code>, we simply return <code>BigDecimal.ZERO</code>.
+ * Convert a {@code BigDecimal} to a {@code BigDecimal} whose scale is the
+ * specified value with a {@code RoundingMode} applied. If the input {@code value}
+ * is {@code null}, we simply return {@code BigDecimal.ZERO}.
*
- * @param value the <code>BigDecimal</code> to convert, may be null.
+ * @param value the {@code BigDecimal} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of
* discarding precision.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final BigDecimal value, final int scale, final RoundingMode roundingMode) {
@@ -464,15 +464,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>Float</code> to a <code>BigDecimal</code> with a scale of
- * two that has been rounded using <code>RoundingMode.HALF_EVEN</code>. If the supplied
- * <code>value</code> is null, then <code>BigDecimal.ZERO</code> is returned.
+ * Convert a {@code Float} to a {@code BigDecimal} with a scale of
+ * two that has been rounded using {@code RoundingMode.HALF_EVEN}. If the supplied
+ * {@code value} is null, then {@code BigDecimal.ZERO} is returned.
*
- * <p>Note, the scale of a <code>BigDecimal</code> is the number of digits to the right of the
+ * <p>Note, the scale of a {@code BigDecimal} is the number of digits to the right of the
* decimal point.</p>
*
- * @param value the <code>Float</code> to convert, may be null.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @param value the {@code Float} to convert, may be null.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Float value) {
@@ -480,15 +480,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>Float</code> to a <code>BigDecimal</code> whose scale is the
- * specified value with a <code>RoundingMode</code> applied. If the input <code>value</code>
- * is <code>null</code>, we simply return <code>BigDecimal.ZERO</code>.
+ * Convert a {@code Float} to a {@code BigDecimal} whose scale is the
+ * specified value with a {@code RoundingMode} applied. If the input {@code value}
+ * is {@code null}, we simply return {@code BigDecimal.ZERO}.
*
- * @param value the <code>Float</code> to convert, may be null.
+ * @param value the {@code Float} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of
* discarding precision.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Float value, final int scale, final RoundingMode roundingMode) {
@@ -503,15 +503,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>Double</code> to a <code>BigDecimal</code> with a scale of
- * two that has been rounded using <code>RoundingMode.HALF_EVEN</code>. If the supplied
- * <code>value</code> is null, then <code>BigDecimal.ZERO</code> is returned.
+ * Convert a {@code Double} to a {@code BigDecimal} with a scale of
+ * two that has been rounded using {@code RoundingMode.HALF_EVEN}. If the supplied
+ * {@code value} is null, then {@code BigDecimal.ZERO} is returned.
*
- * <p>Note, the scale of a <code>BigDecimal</code> is the number of digits to the right of the
+ * <p>Note, the scale of a {@code BigDecimal} is the number of digits to the right of the
* decimal point.</p>
*
- * @param value the <code>Double</code> to convert, may be null.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @param value the {@code Double} to convert, may be null.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Double value) {
@@ -519,15 +519,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>Double</code> to a <code>BigDecimal</code> whose scale is the
- * specified value with a <code>RoundingMode</code> applied. If the input <code>value</code>
- * is <code>null</code>, we simply return <code>BigDecimal.ZERO</code>.
+ * Convert a {@code Double} to a {@code BigDecimal} whose scale is the
+ * specified value with a {@code RoundingMode} applied. If the input {@code value}
+ * is {@code null}, we simply return {@code BigDecimal.ZERO}.
*
- * @param value the <code>Double</code> to convert, may be null.
+ * @param value the {@code Double} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of
* discarding precision.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Double value, final int scale, final RoundingMode roundingMode) {
@@ -542,15 +542,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>String</code> to a <code>BigDecimal</code> with a scale of
- * two that has been rounded using <code>RoundingMode.HALF_EVEN</code>. If the supplied
- * <code>value</code> is null, then <code>BigDecimal.ZERO</code> is returned.
+ * Convert a {@code String} to a {@code BigDecimal} with a scale of
+ * two that has been rounded using {@code RoundingMode.HALF_EVEN}. If the supplied
+ * {@code value} is null, then {@code BigDecimal.ZERO} is returned.
*
- * <p>Note, the scale of a <code>BigDecimal</code> is the number of digits to the right of the
+ * <p>Note, the scale of a {@code BigDecimal} is the number of digits to the right of the
* decimal point.</p>
*
- * @param value the <code>String</code> to convert, may be null.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @param value the {@code String} to convert, may be null.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final String value) {
@@ -558,15 +558,15 @@ public class NumberUtils {
}
/**
- * Convert a <code>String</code> to a <code>BigDecimal</code> whose scale is the
- * specified value with a <code>RoundingMode</code> applied. If the input <code>value</code>
- * is <code>null</code>, we simply return <code>BigDecimal.ZERO</code>.
+ * Convert a {@code String} to a {@code BigDecimal} whose scale is the
+ * specified value with a {@code RoundingMode} applied. If the input {@code value}
+ * is {@code null}, we simply return {@code BigDecimal.ZERO}.
*
- * @param value the <code>String</code> to convert, may be null.
+ * @param value the {@code String} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of
* discarding precision.
- * @return the scaled, with appropriate rounding, <code>BigDecimal</code>.
+ * @return the scaled, with appropriate rounding, {@code BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final String value, final int scale, final RoundingMode roundingMode) {
@@ -624,21 +624,21 @@ public class NumberUtils {
* prefix is more than 8 - or BigInteger if there are more than 16 digits.
* </p>
* <p>Then, the value is examined for a type qualifier on the end, i.e. one of
- * <code>'f', 'F', 'd', 'D', 'l', 'L'</code>. If it is found, it starts
+ * {@code 'f', 'F', 'd', 'D', 'l', 'L'}. If it is found, it starts
* trying to create successively larger types from the type specified
* until one is found that can represent the value.</p>
*
* <p>If a type specifier is not found, it will check for a decimal point
- * and then try successively larger types from <code>Integer</code> to
- * <code>BigInteger</code> and from <code>Float</code> to
- * <code>BigDecimal</code>.</p>
+ * and then try successively larger types from {@code Integer} to
+ * {@code BigInteger} and from {@code Float} to
+ * {@code BigDecimal}.</p>
*
* <p>
* Integral values with a leading {@code 0} will be interpreted as octal; the returned number will
* be Integer, Long or BigDecimal as appropriate.
* </p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
* <p>This method does not trim the input string, i.e., strings with leading
* or trailing spaces will generate NumberFormatExceptions.</p>
@@ -847,10 +847,10 @@ public class NumberUtils {
/**
* <p>Utility method for {@link #createNumber(java.lang.String)}.</p>
*
- * <p>Returns <code>true</code> if s is <code>null</code>.</p>
+ * <p>Returns {@code true} if s is {@code null}.</p>
*
* @param str the String to check
- * @return if it is all zeros or <code>null</code>
+ * @return if it is all zeros or {@code null}
*/
private static boolean isAllZeros(final String str) {
if (str == null) {
@@ -866,12 +866,12 @@ public class NumberUtils {
//-----------------------------------------------------------------------
/**
- * <p>Convert a <code>String</code> to a <code>Float</code>.</p>
+ * <p>Convert a {@code String} to a {@code Float}.</p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
- * @param str a <code>String</code> to convert, may be null
- * @return converted <code>Float</code> (or null if the input is null)
+ * @param str a {@code String} to convert, may be null
+ * @return converted {@code Float} (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Float createFloat(final String str) {
@@ -882,12 +882,12 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>Double</code>.</p>
+ * <p>Convert a {@code String} to a {@code Double}.</p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
- * @param str a <code>String</code> to convert, may be null
- * @return converted <code>Double</code> (or null if the input is null)
+ * @param str a {@code String} to convert, may be null
+ * @return converted {@code Double} (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Double createDouble(final String str) {
@@ -898,14 +898,14 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>Integer</code>, handling
+ * <p>Convert a {@code String} to a {@code Integer}, handling
* hex (0xhhhh) and octal (0dddd) notations.
* N.B. a leading zero means octal; spaces are not trimmed.</p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
- * @param str a <code>String</code> to convert, may be null
- * @return converted <code>Integer</code> (or null if the input is null)
+ * @param str a {@code String} to convert, may be null
+ * @return converted {@code Integer} (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Integer createInteger(final String str) {
@@ -917,14 +917,14 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>Long</code>;
+ * <p>Convert a {@code String} to a {@code Long};
* since 3.1 it handles hex (0Xhhhh) and octal (0ddd) notations.
* N.B. a leading zero means octal; spaces are not trimmed.</p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
- * @param str a <code>String</code> to convert, may be null
- * @return converted <code>Long</code> (or null if the input is null)
+ * @param str a {@code String} to convert, may be null
+ * @return converted {@code Long} (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Long createLong(final String str) {
@@ -935,13 +935,13 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>BigInteger</code>;
+ * <p>Convert a {@code String} to a {@code BigInteger};
* since 3.2 it handles hex (0x or #) and octal (0) notations.</p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
- * @param str a <code>String</code> to convert, may be null
- * @return converted <code>BigInteger</code> (or null if the input is null)
+ * @param str a {@code String} to convert, may be null
+ * @return converted {@code BigInteger} (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static BigInteger createBigInteger(final String str) {
@@ -971,12 +971,12 @@ public class NumberUtils {
}
/**
- * <p>Convert a <code>String</code> to a <code>BigDecimal</code>.</p>
+ * <p>Convert a {@code String} to a {@code BigDecimal}.</p>
*
- * <p>Returns <code>null</code> if the string is <code>null</code>.</p>
+ * <p>Returns {@code null} if the string is {@code null}.</p>
*
- * @param str a <code>String</code> to convert, may be null
- * @return converted <code>BigDecimal</code> (or null if the input is null)
+ * @param str a {@code String} to convert, may be null
+ * @return converted {@code BigDecimal} (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static BigDecimal createBigDecimal(final String str) {
@@ -1004,8 +1004,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from min(long[]) to min(long...)
*/
public static long min(final long... array) {
@@ -1028,8 +1028,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from min(int[]) to min(int...)
*/
public static int min(final int... array) {
@@ -1052,8 +1052,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from min(short[]) to min(short...)
*/
public static short min(final short... array) {
@@ -1076,8 +1076,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from min(byte[]) to min(byte...)
*/
public static byte min(final byte... array) {
@@ -1100,8 +1100,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @see IEEE754rUtils#min(double[]) IEEE754rUtils for a version of this method that handles NaN differently
* @since 3.4 Changed signature from min(double[]) to min(double...)
*/
@@ -1128,8 +1128,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the minimum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @see IEEE754rUtils#min(float[]) IEEE754rUtils for a version of this method that handles NaN differently
* @since 3.4 Changed signature from min(float[]) to min(float...)
*/
@@ -1158,8 +1158,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the maximum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from max(long[]) to max(long...)
*/
public static long max(final long... array) {
@@ -1182,8 +1182,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the maximum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from max(int[]) to max(int...)
*/
public static int max(final int... array) {
@@ -1206,8 +1206,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the maximum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from max(short[]) to max(short...)
*/
public static short max(final short... array) {
@@ -1230,8 +1230,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the maximum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @since 3.4 Changed signature from max(byte[]) to max(byte...)
*/
public static byte max(final byte... array) {
@@ -1254,8 +1254,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the maximum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @see IEEE754rUtils#max(double[]) IEEE754rUtils for a version of this method that handles NaN differently
* @since 3.4 Changed signature from max(double[]) to max(double...)
*/
@@ -1282,8 +1282,8 @@ public class NumberUtils {
*
* @param array an array, must not be null or empty
* @return the maximum value in the array
- * @throws IllegalArgumentException if <code>array</code> is <code>null</code>
- * @throws IllegalArgumentException if <code>array</code> is empty
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty
* @see IEEE754rUtils#max(float[]) IEEE754rUtils for a version of this method that handles NaN differently
* @since 3.4 Changed signature from max(float[]) to max(float...)
*/
@@ -1319,7 +1319,7 @@ public class NumberUtils {
// 3 param min
//-----------------------------------------------------------------------
/**
- * <p>Gets the minimum of three <code>long</code> values.</p>
+ * <p>Gets the minimum of three {@code long} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1337,7 +1337,7 @@ public class NumberUtils {
}
/**
- * <p>Gets the minimum of three <code>int</code> values.</p>
+ * <p>Gets the minimum of three {@code int} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1355,7 +1355,7 @@ public class NumberUtils {
}
/**
- * <p>Gets the minimum of three <code>short</code> values.</p>
+ * <p>Gets the minimum of three {@code short} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1373,7 +1373,7 @@ public class NumberUtils {
}
/**
- * <p>Gets the minimum of three <code>byte</code> values.</p>
+ * <p>Gets the minimum of three {@code byte} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1391,9 +1391,9 @@ public class NumberUtils {
}
/**
- * <p>Gets the minimum of three <code>double</code> values.</p>
+ * <p>Gets the minimum of three {@code double} values.</p>
*
- * <p>If any value is <code>NaN</code>, <code>NaN</code> is
+ * <p>If any value is {@code NaN}, {@code NaN} is
* returned. Infinity is handled.</p>
*
* @param a value 1
@@ -1407,9 +1407,9 @@ public class NumberUtils {
}
/**
- * <p>Gets the minimum of three <code>float</code> values.</p>
+ * <p>Gets the minimum of three {@code float} values.</p>
*
- * <p>If any value is <code>NaN</code>, <code>NaN</code> is
+ * <p>If any value is {@code NaN}, {@code NaN} is
* returned. Infinity is handled.</p>
*
* @param a value 1
@@ -1425,7 +1425,7 @@ public class NumberUtils {
// 3 param max
//-----------------------------------------------------------------------
/**
- * <p>Gets the maximum of three <code>long</code> values.</p>
+ * <p>Gets the maximum of three {@code long} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1443,7 +1443,7 @@ public class NumberUtils {
}
/**
- * <p>Gets the maximum of three <code>int</code> values.</p>
+ * <p>Gets the maximum of three {@code int} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1461,7 +1461,7 @@ public class NumberUtils {
}
/**
- * <p>Gets the maximum of three <code>short</code> values.</p>
+ * <p>Gets the maximum of three {@code short} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1479,7 +1479,7 @@ public class NumberUtils {
}
/**
- * <p>Gets the maximum of three <code>byte</code> values.</p>
+ * <p>Gets the maximum of three {@code byte} values.</p>
*
* @param a value 1
* @param b value 2
@@ -1497,9 +1497,9 @@ public class NumberUtils {
}
/**
- * <p>Gets the maximum of three <code>double</code> values.</p>
+ * <p>Gets the maximum of three {@code double} values.</p>
*
- * <p>If any value is <code>NaN</code>, <code>NaN</code> is
+ * <p>If any value is {@code NaN}, {@code NaN} is
* returned. Infinity is handled.</p>
*
* @param a value 1
@@ -1513,9 +1513,9 @@ public class NumberUtils {
}
/**
- * <p>Gets the maximum of three <code>float</code> values.</p>
+ * <p>Gets the maximum of three {@code float} values.</p>
*
- * <p>If any value is <code>NaN</code>, <code>NaN</code> is
+ * <p>If any value is {@code NaN}, {@code NaN} is
* returned. Infinity is handled.</p>
*
* @param a value 1
@@ -1530,14 +1530,14 @@ public class NumberUtils {
//-----------------------------------------------------------------------
/**
- * <p>Checks whether the <code>String</code> contains only
+ * <p>Checks whether the {@code String} contains only
* digit characters.</p>
*
- * <p><code>Null</code> and empty String will return
- * <code>false</code>.</p>
+ * <p>{@code Null} and empty String will return
+ * {@code false}.</p>
*
- * @param str the <code>String</code> to check
- * @return <code>true</code> if str contains only Unicode numeric
+ * @param str the {@code String} to check
+ * @return {@code true} if str contains only Unicode numeric
*/
public static boolean isDigits(final String str) {
return StringUtils.isNumeric(str);
@@ -1546,23 +1546,23 @@ public class NumberUtils {
/**
* <p>Checks whether the String a valid Java number.</p>
*
- * <p>Valid numbers include hexadecimal marked with the <code>0x</code> or
- * <code>0X</code> qualifier, octal numbers, scientific notation and
+ * <p>Valid numbers include hexadecimal marked with the {@code 0x} or
+ * {@code 0X} qualifier, octal numbers, scientific notation and
* numbers marked with a type qualifier (e.g. 123L).</p>
*
* <p>Non-hexadecimal strings beginning with a leading zero are
- * treated as octal values. Thus the string <code>09</code> will return
- * <code>false</code>, since <code>9</code> is not a valid octal value.
+ * treated as octal values. Thus the string {@code 09} will return
+ * {@code false}, since {@code 9} is not a valid octal value.
* However, numbers beginning with {@code 0.} are treated as decimal.</p>
*
- * <p><code>null</code> and empty/blank {@code String} will return
- * <code>false</code>.</p>
+ * <p>{@code null} and empty/blank {@code String} will return
+ * {@code false}.</p>
*
* <p>Note, {@link #createNumber(String)} should return a number for every
- * input resulting in <code>true</code>.</p>
+ * input resulting in {@code true}.</p>
*
- * @param str the <code>String</code> to check
- * @return <code>true</code> if the string is a correctly formatted number
+ * @param str the {@code String} to check
+ * @return {@code true} if the string is a correctly formatted number
* @since 3.3 the code supports hex {@code 0Xhhh} an
* octal {@code 0ddd} validation
* @deprecated This feature will be removed in Lang 4.0,
@@ -1576,23 +1576,23 @@ public class NumberUtils {
/**
* <p>Checks whether the String a valid Java number.</p>
*
- * <p>Valid numbers include hexadecimal marked with the <code>0x</code> or
- * <code>0X</code> qualifier, octal numbers, scientific notation and
+ * <p>Valid numbers include hexadecimal marked with the {@code 0x} or
+ * {@code 0X} qualifier, octal numbers, scientific notation and
* numbers marked with a type qualifier (e.g. 123L).</p>
*
* <p>Non-hexadecimal strings beginning with a leading zero are
- * treated as octal values. Thus the string <code>09</code> will return
- * <code>false</code>, since <code>9</code> is not a valid octal value.
+ * treated as octal values. Thus the string {@code 09} will return
+ * {@code false}, since {@code 9} is not a valid octal value.
* However, numbers beginning with {@code 0.} are treated as decimal.</p>
*
- * <p><code>null</code> and empty/blank {@code String} will return
- * <code>false</code>.</p>
+ * <p>{@code null} and empty/blank {@code String} will return
+ * {@code false}.</p>
*
* <p>Note, {@link #createNumber(String)} should return a number for every
- * input resulting in <code>true</code>.</p>
+ * input resulting in {@code true}.</p>
*
- * @param str the <code>String</code> to check
- * @return <code>true</code> if the string is a correctly formatted number
+ * @param str the {@code String} to check
+ * @return {@code true} if the string is a correctly formatted number
* @since 3.5
*/
public static boolean isCreatable(final String str) {
@@ -1719,7 +1719,7 @@ public class NumberUtils {
* <p>Hexadecimal and scientific notations are <strong>not</strong> considered parsable.
* See {@link #isCreatable(String)} on those cases.</p>
*
- * <p>{@code Null} and empty String will return <code>false</code>.</p>
+ * <p>{@code Null} and empty String will return {@code false}.</p>
*
* @param str the String to check.
* @return {@code true} if the string is a parsable number.
diff --git a/src/main/java/org/apache/commons/lang3/math/package-info.java b/src/main/java/org/apache/commons/lang3/math/package-info.java
index 5be9368..bd56cdd 100644
--- a/src/main/java/org/apache/commons/lang3/math/package-info.java
+++ b/src/main/java/org/apache/commons/lang3/math/package-info.java
@@ -25,7 +25,7 @@
*
* <p>There are two aspects of this package that should be highlighted.
* The first is {@link org.apache.commons.lang3.math.NumberUtils#createNumber(String)}, a method which does its best to convert a String into a {@link java.lang.Number} object.
- * You have no idea what type of Number it will return, so you should call the relevant <code>xxxValue</code> method when you reach the point of needing a number.
+ * You have no idea what type of Number it will return, so you should call the relevant {@code xxxValue} method when you reach the point of needing a number.
* NumberUtils also has a related {@link org.apache.commons.lang3.math.NumberUtils#isCreatable(String)} method.</p>
*
* @since 2.0
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 85f2bdc..6aa3182 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
@@ -20,7 +20,7 @@ package org.apache.commons.lang3.mutable;
/**
* Provides mutable access to a value.
* <p>
- * <code>Mutable</code> is used as a generic interface to the implementations in this package.
+ * {@code Mutable} is used as a generic interface to the implementations in this package.
* <p>
* A typical use case would be to enable a primitive or string to be passed to a method and allow that method to
* effectively change the value of the primitive/string. Another use case is to store a frequently changing primitive in
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java b/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java
index af13516..7fb3195 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java
@@ -22,7 +22,7 @@ import java.io.Serializable;
import org.apache.commons.lang3.BooleanUtils;
/**
- * A mutable <code>boolean</code> wrapper.
+ * A mutable {@code boolean} wrapper.
* <p>
* Note that as MutableBoolean does not extend Boolean, it is not treated by String.format as a Boolean parameter.
*
@@ -120,9 +120,9 @@ public class MutableBoolean implements Mutable<Boolean>, Serializable, Comparabl
//-----------------------------------------------------------------------
/**
- * Checks if the current value is <code>true</code>.
+ * Checks if the current value is {@code true}.
*
- * @return <code>true</code> if the current value is <code>true</code>
+ * @return {@code true} if the current value is {@code true}
* @since 2.5
*/
public boolean isTrue() {
@@ -130,9 +130,9 @@ public class MutableBoolean implements Mutable<Boolean>, Serializable, Comparabl
}
/**
- * Checks if the current value is <code>false</code>.
+ * Checks if the current value is {@code false}.
*
- * @return <code>true</code> if the current value is <code>false</code>
+ * @return {@code true} if the current value is {@code false}
* @since 2.5
*/
public boolean isFalse() {
@@ -162,12 +162,12 @@ public class MutableBoolean implements Mutable<Boolean>, Serializable, Comparabl
//-----------------------------------------------------------------------
/**
- * Compares this object to the specified object. The result is <code>true</code> if and only if the argument is
- * not <code>null</code> and is an <code>MutableBoolean</code> object that contains the same
- * <code>boolean</code> value as this object.
+ * Compares this object to the specified object. The result is {@code true} if and only if the argument is
+ * not {@code null} and is an {@code MutableBoolean} object that contains the same
+ * {@code boolean} value as this object.
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
@@ -180,7 +180,7 @@ public class MutableBoolean implements Mutable<Boolean>, Serializable, Comparabl
/**
* Returns a suitable hash code for this mutable.
*
- * @return the hash code returned by <code>Boolean.TRUE</code> or <code>Boolean.FALSE</code>
+ * @return the hash code returned by {@code Boolean.TRUE} or {@code Boolean.FALSE}
*/
@Override
public int hashCode() {
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 dfedf78..23a3cf5 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
@@ -19,7 +19,7 @@ package org.apache.commons.lang3.mutable;
import org.apache.commons.lang3.math.NumberUtils;
/**
- * A mutable <code>byte</code> wrapper.
+ * A mutable {@code byte} wrapper.
* <p>
* Note that as MutableByte does not extend Byte, it is not treated by String.format as a Byte parameter.
*
@@ -341,12 +341,12 @@ public class MutableByte extends Number implements Comparable<MutableByte>, Muta
//-----------------------------------------------------------------------
/**
- * Compares this object to the specified object. The result is <code>true</code> if and only if the argument is
- * not <code>null</code> and is a <code>MutableByte</code> object that contains the same <code>byte</code> value
+ * Compares this object to the specified object. The result is {@code true} if and only if the argument is
+ * not {@code null} and is a {@code MutableByte} object that contains the same {@code byte} value
* as this object.
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
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 a9037bd..9003572 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
@@ -17,7 +17,7 @@
package org.apache.commons.lang3.mutable;
/**
- * A mutable <code>double</code> wrapper.
+ * A mutable {@code double} wrapper.
* <p>
* Note that as MutableDouble does not extend Double, it is not treated by String.format as a Double parameter.
*
@@ -348,14 +348,14 @@ public class MutableDouble extends Number implements Comparable<MutableDouble>,
//-----------------------------------------------------------------------
/**
- * Compares this object against the specified object. The result is <code>true</code> if and only if the argument
- * is not <code>null</code> and is a <code>Double</code> object that represents a double that has the identical
+ * Compares this object against the specified object. The result is {@code true} if and only if the argument
+ * is not {@code null} and is a {@code Double} object that represents a double that has the identical
* bit pattern to the bit pattern of the double represented by this object. For this purpose, two
- * <code>double</code> values are considered to be the same if and only if the method
+ * {@code double} values are considered to be the same if and only if the method
* {@link Double#doubleToLongBits(double)}returns the same long value when applied to each.
* <p>
- * Note that in most cases, for two instances of class <code>Double</code>,<code>d1</code> and <code>d2</code>,
- * the value of <code>d1.equals(d2)</code> is <code>true</code> if and only if <blockquote>
+ * Note that in most cases, for two instances of class {@code Double},{@code d1} and {@code d2},
+ * the value of {@code d1.equals(d2)} is {@code true} if and only if <blockquote>
*
* <pre>
* d1.doubleValue() == d2.doubleValue()
@@ -363,18 +363,18 @@ public class MutableDouble extends Number implements Comparable<MutableDouble>,
*
* </blockquote>
* <p>
- * also has the value <code>true</code>. However, there are two exceptions:
+ * also has the value {@code true}. However, there are two exceptions:
* <ul>
- * <li>If <code>d1</code> and <code>d2</code> both represent <code>Double.NaN</code>, then the
- * <code>equals</code> method returns <code>true</code>, even though <code>Double.NaN==Double.NaN</code> has
- * the value <code>false</code>.
- * <li>If <code>d1</code> represents <code>+0.0</code> while <code>d2</code> represents <code>-0.0</code>,
- * or vice versa, the <code>equal</code> test has the value <code>false</code>, even though
- * <code>+0.0==-0.0</code> has the value <code>true</code>. This allows hashtables to operate properly.
+ * <li>If {@code d1} and {@code d2} both represent {@code Double.NaN}, then the
+ * {@code equals} method returns {@code true}, even though {@code Double.NaN==Double.NaN} has
+ * the value {@code false}.
+ * <li>If {@code d1} represents {@code +0.0} while {@code d2} represents {@code -0.0},
+ * or vice versa, the {@code equal} test has the value {@code false}, even though
+ * {@code +0.0==-0.0} has the value {@code true}. This allows hashtables to operate properly.
* </ul>
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
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 700ac5c..8f61341 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
@@ -17,7 +17,7 @@
package org.apache.commons.lang3.mutable;
/**
- * A mutable <code>float</code> wrapper.
+ * A mutable {@code float} wrapper.
* <p>
* Note that as MutableFloat does not extend Float, it is not treated by String.format as a Float parameter.
*
@@ -348,14 +348,14 @@ public class MutableFloat extends Number implements Comparable<MutableFloat>, Mu
//-----------------------------------------------------------------------
/**
- * Compares this object against some other object. The result is <code>true</code> if and only if the argument is
- * not <code>null</code> and is a <code>Float</code> object that represents a <code>float</code> that has the
- * identical bit pattern to the bit pattern of the <code>float</code> represented by this object. For this
+ * Compares this object against some other object. The result is {@code true} if and only if the argument is
+ * not {@code null} and is a {@code Float} object that represents a {@code float} that has the
+ * identical bit pattern to the bit pattern of the {@code float} represented by this object. For this
* purpose, two float values are considered to be the same if and only if the method
* {@link Float#floatToIntBits(float)}returns the same int value when applied to each.
* <p>
- * Note that in most cases, for two instances of class <code>Float</code>,<code>f1</code> and <code>f2</code>,
- * the value of <code>f1.equals(f2)</code> is <code>true</code> if and only if <blockquote>
+ * Note that in most cases, for two instances of class {@code Float},{@code f1} and {@code f2},
+ * the value of {@code f1.equals(f2)} is {@code true} if and only if <blockquote>
*
* <pre>
* f1.floatValue() == f2.floatValue()
@@ -363,19 +363,19 @@ public class MutableFloat extends Number implements Comparable<MutableFloat>, Mu
*
* </blockquote>
* <p>
- * also has the value <code>true</code>. However, there are two exceptions:
+ * also has the value {@code true}. However, there are two exceptions:
* <ul>
- * <li>If <code>f1</code> and <code>f2</code> both represent <code>Float.NaN</code>, then the
- * <code>equals</code> method returns <code>true</code>, even though <code>Float.NaN==Float.NaN</code> has
- * the value <code>false</code>.
- * <li>If <code>f1</code> represents <code>+0.0f</code> while <code>f2</code> represents <code>-0.0f</code>,
- * or vice versa, the <code>equal</code> test has the value <code>false</code>, even though
- * <code>0.0f==-0.0f</code> has the value <code>true</code>.
+ * <li>If {@code f1} and {@code f2} both represent {@code Float.NaN}, then the
+ * {@code equals} method returns {@code true}, even though {@code Float.NaN==Float.NaN} has
+ * the value {@code false}.
+ * <li>If {@code f1} represents {@code +0.0f} while {@code f2} represents {@code -0.0f},
+ * or vice versa, the {@code equal} test has the value {@code false}, even though
+ * {@code 0.0f==-0.0f} has the value {@code true}.
* </ul>
* This definition allows hashtables to operate properly.
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
* @see java.lang.Float#floatToIntBits(float)
*/
@Override
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 330d02c..f406d34 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
@@ -19,7 +19,7 @@ package org.apache.commons.lang3.mutable;
import org.apache.commons.lang3.math.NumberUtils;
/**
- * A mutable <code>int</code> wrapper.
+ * A mutable {@code int} wrapper.
* <p>
* Note that as MutableInt does not extend Integer, it is not treated by String.format as an Integer parameter.
*
@@ -331,12 +331,12 @@ public class MutableInt extends Number implements Comparable<MutableInt>, Mutabl
//-----------------------------------------------------------------------
/**
- * Compares this object to the specified object. The result is <code>true</code> if and only if the argument is
- * not <code>null</code> and is a <code>MutableInt</code> object that contains the same <code>int</code> value
+ * Compares this object to the specified object. The result is {@code true} if and only if the argument is
+ * not {@code null} and is a {@code MutableInt} object that contains the same {@code int} value
* as this object.
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
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 4bf0fa5..6680e50 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
@@ -19,7 +19,7 @@ package org.apache.commons.lang3.mutable;
import org.apache.commons.lang3.math.NumberUtils;
/**
- * A mutable <code>long</code> wrapper.
+ * A mutable {@code long} wrapper.
* <p>
* Note that as MutableLong does not extend Long, it is not treated by String.format as a Long parameter.
*
@@ -331,12 +331,12 @@ public class MutableLong extends Number implements Comparable<MutableLong>, Muta
//-----------------------------------------------------------------------
/**
- * Compares this object to the specified object. The result is <code>true</code> if and only if the argument
- * is not <code>null</code> and is a <code>MutableLong</code> object that contains the same <code>long</code>
+ * Compares this object to the specified object. The result is {@code true} if and only if the argument
+ * is not {@code null} and is a {@code MutableLong} object that contains the same {@code long}
* value as this object.
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java b/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
index 3c78bc1..8ce1a68 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
@@ -20,7 +20,7 @@ package org.apache.commons.lang3.mutable;
import java.io.Serializable;
/**
- * A mutable <code>Object</code> wrapper.
+ * A mutable {@code Object} wrapper.
*
* @param <T> the type to set and get
* @since 2.1
@@ -38,7 +38,7 @@ public class MutableObject<T> implements Mutable<T>, Serializable {
private T value;
/**
- * Constructs a new MutableObject with the default value of <code>null</code>.
+ * Constructs a new MutableObject with the default value of {@code null}.
*/
public MutableObject() {
super();
@@ -78,15 +78,15 @@ public class MutableObject<T> implements Mutable<T>, Serializable {
//-----------------------------------------------------------------------
/**
* <p>
- * Compares this object against the specified object. The result is <code>true</code> if and only if the argument
- * is not <code>null</code> and is a <code>MutableObject</code> object that contains the same <code>T</code>
+ * Compares this object against the specified object. The result is {@code true} if and only if the argument
+ * is not {@code null} and is a {@code MutableObject} object that contains the same {@code T}
* value as this object.
* </p>
*
- * @param obj the object to compare with, <code>null</code> returns <code>false</code>
- * @return <code>true</code> if the objects are the same;
- * <code>true</code> if the objects have equivalent <code>value</code> fields;
- * <code>false</code> otherwise.
+ * @param obj the object to compare with, {@code null} returns {@code false}
+ * @return {@code true} if the objects are the same;
+ * {@code true} if the objects have equivalent {@code value} fields;
+ * {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
@@ -104,9 +104,9 @@ public class MutableObject<T> implements Mutable<T>, Serializable {
}
/**
- * Returns the value's hash code or <code>0</code> if the value is <code>null</code>.
+ * Returns the value's hash code or {@code 0} if the value is {@code null}.
*
- * @return the value's hash code or <code>0</code> if the value is <code>null</code>.
+ * @return the value's hash code or {@code 0} if the value is {@code null}.
*/
@Override
public int hashCode() {
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 72c32dd..e8c9907 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
@@ -19,7 +19,7 @@ package org.apache.commons.lang3.mutable;
import org.apache.commons.lang3.math.NumberUtils;
/**
- * A mutable <code>short</code> wrapper.
+ * A mutable {@code short} wrapper.
* <p>
* Note that as MutableShort does not extend Short, it is not treated by String.format as a Short parameter.
*
@@ -341,12 +341,12 @@ public class MutableShort extends Number implements Comparable<MutableShort>, Mu
//-----------------------------------------------------------------------
/**
- * Compares this object to the specified object. The result is <code>true</code> if and only if the argument
- * is not <code>null</code> and is a <code>MutableShort</code> object that contains the same <code>short</code>
+ * Compares this object to the specified object. The result is {@code true} if and only if the argument
+ * is not {@code null} and is a {@code MutableShort} object that contains the same {@code short}
* value as this object.
*
* @param obj the object to compare with, null returns false
- * @return <code>true</code> if the objects are the same; <code>false</code> otherwise.
+ * @return {@code true} if the objects are the same; {@code false} otherwise.
*/
@Override
public boolean equals(final Object obj) {
diff --git a/src/main/java/org/apache/commons/lang3/package-info.java b/src/main/java/org/apache/commons/lang3/package-info.java
index d47d6f0..5098296 100644
--- a/src/main/java/org/apache/commons/lang3/package-info.java
+++ b/src/main/java/org/apache/commons/lang3/package-info.java
@@ -52,7 +52,7 @@
* <p>In addition to dealing with Strings, it's also important to deal with chars and Characters.
* {@link org.apache.commons.lang3.CharUtils} exists for this purpose, while {@link org.apache.commons.lang3.CharSetUtils} exists for set-manipulation of Strings.
* Be careful, although CharSetUtils takes an argument of type String, it is only as a set of characters.
- * For example, <code>CharSetUtils.delete("testtest", "tr")</code> will remove all t's and all r's from the String, not just the String "tr". </p>
+ * For example, {@code CharSetUtils.delete("testtest", "tr")} will remove all t's and all r's from the String, not just the String "tr". </p>
*
* <p>{@link org.apache.commons.lang3.CharRange} and {@link org.apache.commons.lang3.CharSet} are both used internally by CharSetUtils, and will probably rarely be used.</p>
*
@@ -60,7 +60,7 @@
*
* <p>SystemUtils is a simple little class which makes it easy to find out information about which platform you are on.
* For some, this is a necessary evil. It was never something I expected to use myself until I was trying to ensure that Commons Lang itself compiled under JDK 1.2.
- * Having pushed out a few JDK 1.3 bits that had slipped in (<code>Collections.EMPTY_MAP</code> is a classic offender), I then found that one of the Unit Tests was dying mysteriously under JDK 1.2, but ran fine under JDK 1.3.
+ * Having pushed out a few JDK 1.3 bits that had slipped in ({@code Collections.EMPTY_MAP} is a classic offender), I then found that one of the Unit Tests was dying mysteriously under JDK 1.2, but ran fine under JDK 1.3.
* There was no obvious solution and I needed to move onwards, so the simple solution was to wrap that particular test in a <code>if (SystemUtils.isJavaVersionAtLeast(1.3f)) {</code>, make a note and move on.</p>
*
* <p>The {@link org.apache.commons.lang3.CharEncoding} class is also used to interact with the Java environment and may be used to see which character encodings are supported in a particular environment. </p>
@@ -75,7 +75,7 @@
* <p>Would you believe it, {@link org.apache.commons.lang3.ObjectUtils} contains handy functions for Objects, mainly null-safe implementations of the methods on {@link java.lang.Object}.</p>
*
* <p>{@link org.apache.commons.lang3.ClassUtils} is largely a set of helper methods for reflection.
- * Of special note are the comparators hidden away in ClassUtils, useful for sorting Class and Package objects by name; however they merely sort alphabetically and don't understand the common habit of sorting <code>java</code> and <code>javax</code> first.</p>
+ * Of special note are the comparators hidden away in ClassUtils, useful for sorting Class and Package objects by name; however they merely sort alphabetically and don't understand the common habit of sorting {@code java} and {@code javax} first.</p>
*
* <p>Next up, {@link org.apache.commons.lang3.ArrayUtils}.
* This is a big one with many methods and many overloads of these methods so it is probably worth an in depth look here.
@@ -84,17 +84,17 @@
*
* <ul>
* <li>ArrayUtils provides singleton empty arrays for all the basic types. These will largely be of use in the Collections API with its toArray methods, but also will be of use with methods which want to return an empty array on error.</li>
- * <li><code>add(xxx[], xxx)</code> will add a primitive type to an array, resizing the array as you'd expect. Object is also supported. </li>
- * <li><code>clone(xxx[])</code> clones a primitive or Object array. </li>
- * <li><code>contains(xxx[], xxx)</code> searches for a primitive or Object in a primitive or Object array. </li>
- * <li><code>getLength(Object)</code> returns the length of any array or an IllegalArgumentException if the parameter is not an array. <code>hashCode(Object)</code>, <code>equals(Object, Object)</code>, <code>toString(Object)</code> </li>
- * <li><code>indexOf(xxx[], xxx)</code> and <code>indexOf(xxx[], xxx, int)</code> are copies of the classic String methods, but this time for primitive/Object arrays. In addition, a lastIndexOf set of methods exists. </li>
- * <li><code>isEmpty(xxx[])</code> lets you know if an array is zero-sized or null. </li>
- * <li><code>isSameLength(xxx[], xxx[])</code> returns true if the arrays are the same length. </li>
- * <li>Along side the add methods, there are also remove methods of two types. The first type remove the value at an index, <code>remove(xxx[], int)</code>, while the second type remove the first value from the array, <code>remove(xxx[], xxx)</code>. </li>
- * <li>Nearing the end now. The <code>reverse(xxx[])</code> method turns an array around. </li>
- * <li>The <code>subarray(xxx[], int, int)</code> method splices an array out of a larger array. </li>
- * <li>Primitive to primitive wrapper conversion is handled by the <code>toObject(xxx[])</code> and <code>toPrimitive(Xxx[])</code> methods. </li>
+ * <li>{@code add(xxx[], xxx)} will add a primitive type to an array, resizing the array as you'd expect. Object is also supported. </li>
+ * <li>{@code clone(xxx[])} clones a primitive or Object array. </li>
+ * <li>{@code contains(xxx[], xxx)} searches for a primitive or Object in a primitive or Object array. </li>
+ * <li>{@code getLength(Object)} returns the length of any array or an IllegalArgumentException if the parameter is not an array. {@code hashCode(Object)}, {@code equals(Object, Object)}, {@code toString(Object)} </li>
+ * <li>{@code indexOf(xxx[], xxx)} and {@code indexOf(xxx[], xxx, int)} are copies of the classic String methods, but this time for primitive/Object arrays. In addition, a lastIndexOf set of methods exists. </li>
+ * <li>{@code isEmpty(xxx[])} lets you know if an array is zero-sized or null. </li>
+ * <li>{@code isSameLength(xxx[], xxx[])} returns true if the arrays are the same length. </li>
+ * <li>Along side the add methods, there are also remove methods of two types. The first type remove the value at an index, {@code remove(xxx[], int)}, while the second type remove the first value from the array, {@code remove(xxx[], xxx)}. </li>
+ * <li>Nearing the end now. The {@code reverse(xxx[])} method turns an array around. </li>
+ * <li>The {@code subarray(xxx[], int, int)} method splices an array out of a larger array. </li>
+ * <li>Primitive to primitive wrapper conversion is handled by the {@code toObject(xxx[])} and {@code toPrimitive(Xxx[])} methods. </li>
* </ul>
*
* <p>Lastly, {@link org.apache.commons.lang3.ArrayUtils#toMap(Object[])} is worthy of special note.
diff --git a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
index 8075b9c..082bc89 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
@@ -160,7 +160,7 @@ public class ConstructorUtils {
* @param cls the class to be constructed, not {@code null}
* @param args the array of arguments, {@code null} treated as empty
* @param parameterTypes the array of parameter types, {@code null} treated as empty
- * @return new instance of <code>cls</code>, not {@code null}
+ * @return new instance of {@code cls}, not {@code null}
*
* @throws NullPointerException if {@code cls} is {@code null}
* @throws NoSuchMethodException if a matching constructor cannot be found
diff --git a/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java b/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
index 989155b..d72dc53 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
@@ -714,7 +714,7 @@ public class FieldUtils {
* match {@code public} fields.
* @throws IllegalArgumentException
* if the field is {@code null}
- * @deprecated As of Java 12, we can no longer drop the <code>final</code> modifier, thus
+ * @deprecated As of Java 12, we can no longer drop the {@code final} modifier, thus
* rendering this method obsolete. The JDK discussion about this change can be found
* here: http://mail.openjdk.java.net/pipermail/core-libs-dev/2018-November/056486.html
* @since 3.3
diff --git a/src/main/java/org/apache/commons/lang3/reflect/MemberUtils.java b/src/main/java/org/apache/commons/lang3/reflect/MemberUtils.java
index 3a85b78..d7e2bd2 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/MemberUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/MemberUtils.java
@@ -80,7 +80,7 @@ abstract class MemberUtils {
/**
* Returns whether a {@link Member} is accessible.
* @param m Member to check
- * @return {@code true} if <code>m</code> is accessible
+ * @return {@code true} if {@code m} is accessible
*/
static boolean isAccessible(final Member m) {
return m != null && Modifier.isPublic(m.getModifiers()) && !m.isSynthetic();
diff --git a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
index f365969..32d3d95 100644
--- a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
@@ -62,7 +62,7 @@ public class CompositeFormat extends Format {
* @param obj the object to format
* @param toAppendTo the {@link StringBuffer} to append to
* @param pos the FieldPosition to use (or ignore).
- * @return <code>toAppendTo</code>
+ * @return {@code toAppendTo}
* @see Format#format(Object, StringBuffer, FieldPosition)
*/
@Override // Therefore has to use StringBuffer
diff --git a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
index 625dcf9..f52097b 100644
--- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
@@ -30,38 +30,38 @@ import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.Validate;
/**
- * Extends <code>java.text.MessageFormat</code> to allow pluggable/additional formatting
+ * Extends {@code java.text.MessageFormat} to allow pluggable/additional formatting
* options for embedded format elements. Client code should specify a registry
- * of <code>FormatFactory</code> instances associated with <code>String</code>
+ * of {@code FormatFactory} instances associated with {@code String}
* format names. This registry will be consulted when the format elements are
* parsed from the message pattern. In this way custom patterns can be specified,
- * and the formats supported by <code>java.text.MessageFormat</code> can be overridden
+ * and the formats supported by {@code java.text.MessageFormat} can be overridden
* at the format and/or format style level (see MessageFormat). A "format element"
* embedded in the message pattern is specified (<b>()?</b> signifies optionality):<br>
- * <code>{</code><i>argument-number</i><b>(</b><code>,</code><i>format-name</i><b>
- * (</b><code>,</code><i>format-style</i><b>)?)?</b><code>}</code>
+ * {@code {}<i>argument-number</i><b>(</b>{@code ,}<i>format-name</i><b>
+ * (</b>{@code ,}<i>format-style</i><b>)?)?</b>{@code }}
*
* <p>
* <i>format-name</i> and <i>format-style</i> values are trimmed of surrounding whitespace
- * in the manner of <code>java.text.MessageFormat</code>. If <i>format-name</i> denotes
- * <code>FormatFactory formatFactoryInstance</code> in <code>registry</code>, a <code>Format</code>
+ * in the manner of {@code java.text.MessageFormat}. If <i>format-name</i> denotes
+ * {@code FormatFactory formatFactoryInstance} in {@code registry}, a {@code Format}
* matching <i>format-name</i> and <i>format-style</i> is requested from
- * <code>formatFactoryInstance</code>. If this is successful, the <code>Format</code>
+ * {@code formatFactoryInstance}. If this is successful, the {@code Format}
* found is used for this format element.
* </p>
*
* <p><b>NOTICE:</b> The various subformat mutator methods are considered unnecessary; they exist on the parent
* class to allow the type of customization which it is the job of this class to provide in
* a configurable fashion. These methods have thus been disabled and will throw
- * <code>UnsupportedOperationException</code> if called.
+ * {@code UnsupportedOperationException} if called.
* </p>
*
- * <p>Limitations inherited from <code>java.text.MessageFormat</code>:</p>
+ * <p>Limitations inherited from {@code java.text.MessageFormat}:</p>
* <ul>
* <li>When using "choice" subformats, support for nested formatting instructions is limited
* to that provided by the base class.</li>
- * <li>Thread-safety of <code>Format</code>s, including <code>MessageFormat</code> and thus
- * <code>ExtendedMessageFormat</code>, is not guaranteed.</li>
+ * <li>Thread-safety of {@code Format}s, including {@code MessageFormat} and thus
+ * {@code ExtendedMessageFormat}, is not guaranteed.</li>
* </ul>
*
* @since 2.4
@@ -456,7 +456,7 @@ public class ExtendedMessageFormat extends MessageFormat {
* Convenience method to advance parse position by 1
*
* @param pos ParsePosition
- * @return <code>pos</code>
+ * @return {@code pos}
*/
private ParsePosition next(final ParsePosition pos) {
pos.setIndex(pos.getIndex() + 1);
@@ -464,13 +464,13 @@ public class ExtendedMessageFormat extends MessageFormat {
}
/**
- * Consume a quoted string, adding it to <code>appendTo</code> if
+ * Consume a quoted string, adding it to {@code appendTo} if
* specified.
*
* @param pattern pattern to parse
* @param pos current parse position
* @param appendTo optional StringBuilder to append
- * @return <code>appendTo</code>
+ * @return {@code appendTo}
*/
private StringBuilder appendQuotedString(final String pattern, final ParsePosition pos,
final StringBuilder appendTo) {
@@ -511,7 +511,7 @@ public class ExtendedMessageFormat extends MessageFormat {
/**
* Learn whether the specified Collection contains non-null elements.
* @param coll to check
- * @return <code>true</code> if some Object was found, <code>false</code> otherwise.
+ * @return {@code true} if some Object was found, {@code false} otherwise.
*/
private boolean containsElements(final Collection<?> coll) {
if (coll == null || coll.isEmpty()) {
diff --git a/src/main/java/org/apache/commons/lang3/text/FormatFactory.java b/src/main/java/org/apache/commons/lang3/text/FormatFactory.java
index 0a206d0..4476f5b 100644
--- a/src/main/java/org/apache/commons/lang3/text/FormatFactory.java
+++ b/src/main/java/org/apache/commons/lang3/text/FormatFactory.java
@@ -35,8 +35,8 @@ public interface FormatFactory {
*
* @param name The format type name
* @param arguments Arguments used to create the format instance. This allows the
- * <code>FormatFactory</code> to implement the "format style"
- * concept from <code>java.text.MessageFormat</code>.
+ * {@code FormatFactory} to implement the "format style"
+ * concept from {@code java.text.MessageFormat}.
* @param locale The locale, may be null
* @return The format instance
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
index 4354588..31779b4 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
@@ -278,7 +278,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* This method is the same as checking {@link #length()} and is provided to match the
* API of Collections.
*
- * @return <code>true</code> if the size is <code>0</code>.
+ * @return {@code true} if the size is {@code 0}.
*/
public boolean isEmpty() {
return size == 0;
@@ -288,7 +288,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* Clears the string builder (convenience Collections API style method).
* <p>
* This method does not reduce the size of the internal character buffer.
- * To do that, call <code>clear()</code> followed by {@link #minimizeCapacity()}.
+ * To do that, call {@code clear()} followed by {@link #minimizeCapacity()}.
* <p>
* This method is the same as {@link #setLength(int)} called with zero
* and is provided to match the API of Collections.
@@ -488,7 +488,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends the text representing <code>null</code> to this string builder.
+ * Appends the text representing {@code null} to this string builder.
*
* @return this, to enable chaining
*/
@@ -919,7 +919,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends an int value to the string builder using <code>String.valueOf</code>.
+ * Appends an int value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -929,7 +929,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends a long value to the string builder using <code>String.valueOf</code>.
+ * Appends a long value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -939,7 +939,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends a float value to the string builder using <code>String.valueOf</code>.
+ * Appends a float value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -949,7 +949,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends a double value to the string builder using <code>String.valueOf</code>.
+ * Appends a double value to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1137,7 +1137,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends an int value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends an int value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1148,7 +1148,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends a long value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a long value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1159,7 +1159,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends a float value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a float value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1170,7 +1170,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends a double value followed by a new line to the string builder using <code>String.valueOf</code>.
+ * Appends a double value followed by a new line to the string builder using {@code String.valueOf}.
*
* @param value the value to append
* @return this, to enable chaining
@@ -1495,7 +1495,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
//-----------------------------------------------------------------------
/**
* Appends an object to the builder padding on the left to a fixed width.
- * The <code>toString</code> of the object is used.
+ * The {@code toString} of the object is used.
* If the object is larger than the length, the left hand side is lost.
* If the object is null, the null text value is used.
*
@@ -1528,7 +1528,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
/**
* Appends an object to the builder padding on the left to a fixed width.
- * The <code>String.valueOf</code> of the <code>int</code> value is used.
+ * The {@code String.valueOf} of the {@code int} value is used.
* If the formatted value is larger than the length, the left hand side is lost.
*
* @param value the value to append
@@ -1542,7 +1542,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
/**
* Appends an object to the builder padding on the right to a fixed length.
- * The <code>toString</code> of the object is used.
+ * The {@code toString} of the object is used.
* If the object is larger than the length, the right hand side is lost.
* If the object is null, null text value is used.
*
@@ -1575,7 +1575,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
/**
* Appends an object to the builder padding on the right to a fixed length.
- * The <code>String.valueOf</code> of the <code>int</code> value is used.
+ * The {@code String.valueOf} of the {@code int} value is used.
* If the object is larger than the length, the right hand side is lost.
*
* @param value the value to append
@@ -2290,7 +2290,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* Extracts the leftmost characters from the string builder without
* throwing an exception.
* <p>
- * This method extracts the left <code>length</code> characters from
+ * This method extracts the left {@code length} characters from
* the builder. If this many characters are not available, the whole
* builder is returned. Thus the returned string may be shorter than the
* length requested.
@@ -2312,7 +2312,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* Extracts the rightmost characters from the string builder without
* throwing an exception.
* <p>
- * This method extracts the right <code>length</code> characters from
+ * This method extracts the right {@code length} characters from
* the builder. If this many characters are not available, the whole
* builder is returned. Thus the returned string may be shorter than the
* length requested.
@@ -2334,7 +2334,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* Extracts some characters from the middle of the string builder without
* throwing an exception.
* <p>
- * This method extracts <code>length</code> characters from the builder
+ * This method extracts {@code length} characters from the builder
* at the specified index.
* If the index is negative it is treated as zero.
* If the index is greater than the builder size, it is treated as the builder size.
@@ -2690,8 +2690,8 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* This method allows the contents of the builder to be read
* using any standard method that expects a Reader.
* <p>
- * To use, simply create a <code>StrBuilder</code>, populate it with
- * data, call <code>asReader</code>, and then read away.
+ * To use, simply create a {@code StrBuilder}, populate it with
+ * data, call {@code asReader}, and then read away.
* <p>
* The internal character array is shared between the builder and the reader.
* This allows you to append to the builder after creating the reader,
@@ -2714,9 +2714,9 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
* This method allows you to populate the contents of the builder
* using any standard method that takes a Writer.
* <p>
- * To use, simply create a <code>StrBuilder</code>,
- * call <code>asWriter</code>, and populate away. The data is available
- * at any time using the methods of the <code>StrBuilder</code>.
+ * To use, simply create a {@code StrBuilder},
+ * call {@code asWriter}, and populate away. The data is available
+ * at any time using the methods of the {@code StrBuilder}.
* <p>
* The internal character array is shared between the builder and the writer.
* This allows you to intermix calls that append to the builder and
@@ -2733,7 +2733,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build
}
/**
- * Appends current contents of this <code>StrBuilder</code> to the
+ * Appends current contents of this {@code StrBuilder} to the
* provided {@link Appendable}.
* <p>
* This method tries to avoid doing any extra copies of contents.
diff --git a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java
index b323964..97d01c0 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java
@@ -224,16 +224,16 @@ public abstract class StrMatcher {
* Returns the number of matching characters, zero for no match.
* <p>
* This method is called to check for a match.
- * The parameter <code>pos</code> represents the current position to be
- * checked in the string <code>buffer</code> (a character array which must
+ * The parameter {@code pos} represents the current position to be
+ * checked in the string {@code buffer} (a character array which must
* not be changed).
- * The API guarantees that <code>pos</code> is a valid index for <code>buffer</code>.
+ * The API guarantees that {@code pos} is a valid index for {@code buffer}.
* <p>
* The character array may be larger than the active area to be matched.
* Only values in the buffer between the specified indices may be accessed.
* <p>
* The matching code may check one character or many.
- * It may check characters preceding <code>pos</code> as well as those
+ * It may check characters preceding {@code pos} as well as those
* after, so long as no checks exceed the bounds specified.
* <p>
* It must return zero for no match, or a positive number if a match was found.
@@ -251,13 +251,13 @@ public abstract class StrMatcher {
* Returns the number of matching characters, zero for no match.
* <p>
* This method is called to check for a match.
- * The parameter <code>pos</code> represents the current position to be
- * checked in the string <code>buffer</code> (a character array which must
+ * The parameter {@code pos} represents the current position to be
+ * checked in the string {@code buffer} (a character array which must
* not be changed).
- * The API guarantees that <code>pos</code> is a valid index for <code>buffer</code>.
+ * The API guarantees that {@code pos} is a valid index for {@code buffer}.
* <p>
* The matching code may check one character or many.
- * It may check characters preceding <code>pos</code> as well as those after.
+ * It may check characters preceding {@code pos} as well as those after.
* <p>
* It must return zero for no match, or a positive number if a match was found.
* The number indicates the number of characters that matched.
@@ -393,14 +393,14 @@ public abstract class StrMatcher {
static final class NoMatcher extends StrMatcher {
/**
- * Constructs a new instance of <code>NoMatcher</code>.
+ * Constructs a new instance of {@code NoMatcher}.
*/
NoMatcher() {
super();
}
/**
- * Always returns <code>false</code>.
+ * Always returns {@code false}.
*
* @param buffer the text content to match against, do not change
* @param pos the starting position for the match, valid for buffer
@@ -421,7 +421,7 @@ public abstract class StrMatcher {
static final class TrimMatcher extends StrMatcher {
/**
- * Constructs a new instance of <code>TrimMatcher</code>.
+ * Constructs a new instance of {@code TrimMatcher}.
*/
TrimMatcher() {
super();
diff --git a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
index 9222e3b..ed6c05a 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
@@ -29,7 +29,7 @@ import org.apache.commons.lang3.StringUtils;
* Substitutes variables within a string by values.
* <p>
* This class takes a piece of text and substitutes all the variables within it.
- * The default definition of a variable is <code>${variableName}</code>.
+ * The default definition of a variable is {@code ${variableName}}.
* The prefix and suffix can be changed via constructors and set methods.
* <p>
* Variable values are typically resolved from a map, but could also be resolved
@@ -44,7 +44,7 @@ import org.apache.commons.lang3.StringUtils;
* Typical usage of this class follows the following pattern: First an instance is created
* and initialized with the map that contains the values for the available variables.
* If a prefix and/or suffix for variables should be used other than the default ones,
- * the appropriate settings can be performed. After that the <code>replace()</code>
+ * the appropriate settings can be performed. After that the {@code replace()}
* method can be called passing in the source text for interpolation. In the returned
* text all variable references (as long as their values are known) will be resolved.
* The following example demonstrates this:
@@ -96,7 +96,7 @@ import org.apache.commons.lang3.StringUtils;
* The variable ${${name}} must be used.
* </pre>
* Here only the variable's name referred to in the text should be replaced resulting
- * in the text (assuming that the value of the <code>name</code> variable is <code>x</code>):
+ * in the text (assuming that the value of the {@code name} variable is {@code x}):
* <pre>
* The variable ${x} must be used.
* </pre>
@@ -114,7 +114,7 @@ import org.apache.commons.lang3.StringUtils;
* <pre>
* ${jre-${java.specification.version}}
* </pre>
- * <code>StrSubstitutor</code> supports this recursive substitution in variable
+ * {@code StrSubstitutor} supports this recursive substitution in variable
* names, but it has to be enabled explicitly by setting the
* {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables}
* property to <b>true</b>.
@@ -592,7 +592,7 @@ public class StrSubstitutor {
/**
* Replaces all the occurrences of variables in the given source object with
* their matching values from the resolver. The input source object is
- * converted to a string using <code>toString</code> and is not altered.
+ * converted to a string using {@code toString} and is not altered.
*
* @param source the source to replace in, null returns null
* @return the result of the replace operation
@@ -1111,7 +1111,7 @@ public class StrSubstitutor {
* variable name and the variable default value. This delimiter is expressed in terms of a matcher
* allowing advanced variable default value delimiter matches.
* <p>
- * If the <code>valueDelimiterMatcher</code> is null, then the variable default value resolution
+ * If the {@code valueDelimiterMatcher} is null, then the variable default value resolution
* becomes disabled.
*
* @param valueDelimiterMatcher variable default value delimiter matcher to use, may be null
@@ -1145,7 +1145,7 @@ public class StrSubstitutor {
* variable name and the variable default value. This method allows a string
* variable default value delimiter to be easily set.
* <p>
- * If the <code>valueDelimiter</code> is null or empty string, then the variable default
+ * If the {@code valueDelimiter} is null or empty string, then the variable default
* value resolution becomes disabled.
*
* @param valueDelimiter the variable default value delimiter string to use, may be null or empty
@@ -1196,7 +1196,7 @@ public class StrSubstitutor {
* Sets a flag whether substitution is done in variable names. If set to
* <b>true</b>, the names of variables can contain other variables which are
* processed first before the original variable is evaluated, e.g.
- * <code>${jre-${java.version}}</code>. The default value is <b>false</b>.
+ * {@code ${jre-${java.version}}}. The default value is <b>false</b>.
*
* @param enableSubstitutionInVariables the new value of the flag
* @since 3.0
@@ -1220,11 +1220,11 @@ public class StrSubstitutor {
/**
* Sets a flag controlling whether escapes are preserved during
* substitution. If set to <b>true</b>, the escape character is retained
- * during substitution (e.g. <code>$${this-is-escaped}</code> remains
- * <code>$${this-is-escaped}</code>). If set to <b>false</b>, the escape
+ * during substitution (e.g. {@code $${this-is-escaped}} remains
+ * {@code $${this-is-escaped}}). If set to <b>false</b>, the escape
* character is removed during substitution (e.g.
- * <code>$${this-is-escaped}</code> becomes
- * <code>${this-is-escaped}</code>). The default value is <b>false</b>
+ * {@code $${this-is-escaped}} becomes
+ * {@code ${this-is-escaped}}). The default value is <b>false</b>
*
* @param preserveEscapes true if escapes are to be preserved
* @since 3.5
diff --git a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
index e66f4d8..c9ab666 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
@@ -33,8 +33,8 @@ import org.apache.commons.lang3.StringUtils;
* This class can split a String into many smaller strings. It aims
* to do a similar job to {@link java.util.StringTokenizer StringTokenizer},
* however it offers much more control and flexibility including implementing
- * the <code>ListIterator</code> interface. By default, it is set up
- * like <code>StringTokenizer</code>.
+ * the {@code ListIterator} interface. By default, it is set up
+ * like {@code StringTokenizer}.
* <p>
* The input String is split into a number of <i>tokens</i>.
* Each token is separated from the next String by a <i>delimiter</i>.
@@ -133,9 +133,9 @@ public class StrTokenizer implements ListIterator<String>, Cloneable {
//-----------------------------------------------------------------------
/**
- * Returns a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>.
+ * Returns a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>.
+ * @return a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*/
private static StrTokenizer getCSVClone() {
return (StrTokenizer) CSV_TOKENIZER_PROTOTYPE.clone();
@@ -185,9 +185,9 @@ public class StrTokenizer implements ListIterator<String>, Cloneable {
}
/**
- * Returns a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>.
+ * Returns a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>.
+ * @return a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*/
private static StrTokenizer getTSVClone() {
return (StrTokenizer) TSV_TOKENIZER_PROTOTYPE.clone();
@@ -623,7 +623,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable {
* offset or count to be parsed, or call the tokenizer multiple times on
* multiple strings. It is also be possible to filter the results.
* <p>
- * <code>StrTokenizer</code> will always pass a zero offset and a count
+ * {@code StrTokenizer} will always pass a zero offset and a count
* equal to the length of the array to this method, however a subclass
* may pass other values, or even an entirely different array.
*
@@ -1067,7 +1067,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable {
/**
* Creates a new instance of this Tokenizer. The new instance is reset so
* that it will be at the start of the token list.
- * If a {@link CloneNotSupportedException} is caught, return <code>null</code>.
+ * If a {@link CloneNotSupportedException} is caught, return {@code null}.
*
* @return a new instance of this Tokenizer which has been reset.
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/WordUtils.java b/src/main/java/org/apache/commons/lang3/text/WordUtils.java
index 47150e7..aa84e75 100644
--- a/src/main/java/org/apache/commons/lang3/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/lang3/text/WordUtils.java
@@ -25,8 +25,8 @@ import org.apache.commons.lang3.StringUtils;
/**
* <p>Operations on Strings that contain words.</p>
*
- * <p>This class tries to handle <code>null</code> input gracefully.
- * An exception will not be thrown for a <code>null</code> input.
+ * <p>This class tries to handle {@code null} input gracefully.
+ * An exception will not be thrown for a {@code null} input.
* Each method documents its behaviour in more detail.</p>
*
* @since 2.0
@@ -38,9 +38,9 @@ import org.apache.commons.lang3.StringUtils;
public class WordUtils {
/**
- * <p><code>WordUtils</code> instances should NOT be constructed in
+ * <p>{@code WordUtils} instances should NOT be constructed in
* standard programming. Instead, the class should be used as
- * <code>WordUtils.wrap("foo bar", 20);</code>.</p>
+ * {@code WordUtils.wrap("foo bar", 20);}.</p>
*
* <p>This constructor is public to permit tools that require a JavaBean
* instance to operate.</p>
@@ -52,7 +52,7 @@ public class WordUtils {
// Wrapping
//--------------------------------------------------------------------------
/**
- * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p>
+ * <p>Wraps a single line of text, identifying words by {@code ' '}.</p>
*
* <p>New lines will be separated by the system property line separator.
* Very long words, such as URLs will <i>not</i> be wrapped.</p>
@@ -98,14 +98,14 @@ public class WordUtils {
*
* @param str the String to be word wrapped, may be null
* @param wrapLength the column to wrap the words at, less than 1 is treated as 1
- * @return a line with newlines inserted, <code>null</code> if null input
+ * @return a line with newlines inserted, {@code null} if null input
*/
public static String wrap(final String str, final int wrapLength) {
return wrap(str, wrapLength, null, false);
}
/**
- * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p>
+ * <p>Wraps a single line of text, identifying words by {@code ' '}.</p>
*
* <p>Leading spaces on a new line are stripped.
* Trailing spaces are not stripped.</p>
@@ -173,16 +173,16 @@ public class WordUtils {
* @param str the String to be word wrapped, may be null
* @param wrapLength the column to wrap the words at, less than 1 is treated as 1
* @param newLineStr the string to insert for a new line,
- * <code>null</code> uses the system property line separator
+ * {@code null} uses the system property line separator
* @param wrapLongWords true if long words (such as URLs) should be wrapped
- * @return a line with newlines inserted, <code>null</code> if null input
+ * @return a line with newlines inserted, {@code null} if null input
*/
public static String wrap(final String str, final int wrapLength, final String newLineStr, final boolean wrapLongWords) {
return wrap(str, wrapLength, newLineStr, wrapLongWords, " ");
}
/**
- * <p>Wraps a single line of text, identifying words by <code>wrapOn</code>.</p>
+ * <p>Wraps a single line of text, identifying words by {@code wrapOn}.</p>
*
* <p>Leading spaces on a new line are stripped.
* Trailing spaces are not stripped.</p>
@@ -265,11 +265,11 @@ public class WordUtils {
* @param str the String to be word wrapped, may be null
* @param wrapLength the column to wrap the words at, less than 1 is treated as 1
* @param newLineStr the string to insert for a new line,
- * <code>null</code> uses the system property line separator
+ * {@code null} uses the system property line separator
* @param wrapLongWords true if long words (such as URLs) should be wrapped
* @param wrapOn regex expression to be used as a breakable characters,
* if blank string is provided a space character will be used
- * @return a line with newlines inserted, <code>null</code> if null input
+ * @return a line with newlines inserted, {@code null} if null input
*/
public static String wrap(final String str, int wrapLength, String newLineStr, final boolean wrapLongWords, String wrapOn) {
if (str == null) {
@@ -357,7 +357,7 @@ public class WordUtils {
* use {@link #capitalizeFully(String)}.</p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.
+ * A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -368,7 +368,7 @@ public class WordUtils {
* </pre>
*
* @param str the String to capitalize, may be null
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
* @see #uncapitalize(String)
* @see #capitalizeFully(String)
*/
@@ -386,7 +386,7 @@ public class WordUtils {
* The first string character and the first non-delimiter character after a
* delimiter will be capitalized. </p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -400,7 +400,7 @@ public class WordUtils {
*
* @param str the String to capitalize, may be null
* @param delimiters set of characters to determine capitalization, null means whitespace
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
* @see #uncapitalize(String)
* @see #capitalizeFully(String)
* @since 2.1
@@ -431,7 +431,7 @@ public class WordUtils {
* lowercase characters. </p>
*
* <p>Whitespace is defined by {@link Character#isWhitespace(char)}.
- * A <code>null</code> input String returns <code>null</code>.
+ * A {@code null} input String returns {@code null}.
* Capitalization uses the Unicode title case, normally equivalent to
* upper case.</p>
*
@@ -442,7 +442,7 @@ public class WordUtils {
* </pre>
*
* @param str the String to capitalize, may be null
- * @return capitalized String, <code>null</code> if null String input
+ * @return capitalized String, {@code null} if null String input
*/
public static String capitalizeFully(final String str) {
return capitalizeFully(str, null);
@@ -457,7 +457,7 @@ public class WordUtils {
* The first string character and the first non-delimiter character after a
* delimiter will be capitalized. </p>
*
- * <p>A <code>null</code> input String returns <code>null</code>.
+ * <p>A {@code null} input String returns {@code null}.
... 1126 lines suppressed ...