aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/lang3/builder
diff options
context:
space:
mode:
authorGary Gregory <garydgregory@gmail.com>2022-06-19 09:30:36 -0400
committerGary Gregory <garydgregory@gmail.com>2022-06-19 09:30:36 -0400
commit2e71945163b08326a64b7264466069dd3a83b0de (patch)
treed9d8500b23e06b3be6718d0cad67c412cbc956c4 /src/main/java/org/apache/commons/lang3/builder
parent911fbb9352f029dd02971eebdbf7d9cffc7f9175 (diff)
downloadapache-commons-lang-2e71945163b08326a64b7264466069dd3a83b0de.tar.gz
Replace @code with @link for class references
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/builder')
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java34
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/Diff.java12
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java17
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/DiffResult.java30
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/Diffable.java6
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java36
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java18
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java4
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java4
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java28
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java28
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java50
-rw-r--r--src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java250
13 files changed, 261 insertions, 256 deletions
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 bd2b5a400..c006e05be 100644
--- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java
@@ -113,7 +113,7 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two {@code Object}s via reflection.</p>
+ * <p>Compares two {@link Object}s via reflection.</p>
*
* <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
@@ -143,7 +143,7 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two {@code Object}s via reflection.</p>
+ * <p>Compares two {@link Object}s via reflection.</p>
*
* <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
@@ -175,7 +175,7 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two {@code Object}s via reflection.</p>
+ * <p>Compares two {@link Object}s via reflection.</p>
*
* <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
@@ -208,7 +208,7 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two {@code Object}s via reflection.</p>
+ * <p>Compares two {@link Object}s via reflection.</p>
*
* <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
@@ -241,7 +241,7 @@ public class CompareToBuilder implements Builder<Integer> {
}
/**
- * <p>Compares two {@code Object}s via reflection.</p>
+ * <p>Compares two {@link Object}s via reflection.</p>
*
* <p>Fields can be private, thus {@code AccessibleObject.setAccessible}
* is used to bypass normal access control checks. This will fail under a
@@ -304,8 +304,8 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand object
* @param rhs right-hand object
- * @param clazz {@code Class} that defines fields to be compared
- * @param builder {@code CompareToBuilder} to append to
+ * @param clazz {@link Class} that defines fields to be compared
+ * @param builder {@link CompareToBuilder} to append to
* @param useTransients whether to compare transient fields
* @param excludeFields fields to exclude
*/
@@ -354,7 +354,7 @@ public class CompareToBuilder implements Builder<Integer> {
/**
* <p>Appends to the {@code builder} the comparison of
- * two {@code Object}s.</p>
+ * two {@link Object}s.</p>
*
* <ol>
* <li>Check if {@code lhs == rhs}</li>
@@ -377,7 +377,7 @@ public class CompareToBuilder implements Builder<Integer> {
/**
* <p>Appends to the {@code builder} the comparison of
- * two {@code Object}s.</p>
+ * two {@link Object}s.</p>
*
* <ol>
* <li>Check if {@code lhs == rhs}</li>
@@ -393,8 +393,8 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand object
* @param rhs right-hand object
- * @param comparator {@code Comparator} used to compare the objects,
- * {@code null} means treat lhs as {@code Comparable}
+ * @param comparator {@link Comparator} used to compare the objects,
+ * {@code null} means treat lhs as {@link Comparable}
* @return this - used to chain append calls
* @throws ClassCastException if {@code rhs} is not assignment-compatible
* with {@code lhs}
@@ -545,7 +545,7 @@ public class CompareToBuilder implements Builder<Integer> {
* <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * {@code HashCodeBuilder}.</p>
+ * {@link HashCodeBuilder}.</p>
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -566,7 +566,7 @@ public class CompareToBuilder implements Builder<Integer> {
* <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * {@code HashCodeBuilder}.</p>
+ * {@link HashCodeBuilder}.</p>
*
* @param lhs left-hand value
* @param rhs right-hand value
@@ -605,7 +605,7 @@ public class CompareToBuilder implements Builder<Integer> {
/**
* <p>Appends to the {@code builder} the deep comparison of
- * two {@code Object} arrays.</p>
+ * two {@link Object} arrays.</p>
*
* <ol>
* <li>Check if arrays are the same using {@code ==}</li>
@@ -629,7 +629,7 @@ public class CompareToBuilder implements Builder<Integer> {
/**
* <p>Appends to the {@code builder} the deep comparison of
- * two {@code Object} arrays.</p>
+ * two {@link Object} arrays.</p>
*
* <ol>
* <li>Check if arrays are the same using {@code ==}</li>
@@ -643,8 +643,8 @@ public class CompareToBuilder implements Builder<Integer> {
*
* @param lhs left-hand array
* @param rhs right-hand array
- * @param comparator {@code Comparator} to use to compare the array elements,
- * {@code null} means to treat {@code lhs} elements as {@code Comparable}.
+ * @param comparator {@link Comparator} to use to compare the array elements,
+ * {@code null} means to treat {@code lhs} elements as {@link Comparable}.
* @return this - used to chain append calls
* @throws ClassCastException if {@code rhs} is not assignment-compatible
* with {@code lhs}
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diff.java b/src/main/java/org/apache/commons/lang3/builder/Diff.java
index a7b0c2735..b7d78b915 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diff.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diff.java
@@ -24,18 +24,18 @@ import org.apache.commons.lang3.tuple.Pair;
/**
* <p>
- * A {@code Diff} contains the differences between two {@link Diffable} class
+ * A {@link Diff} contains the differences between two {@link Diffable} class
* fields.
* </p>
*
* <p>
- * Typically, {@code Diff}s are retrieved by using a {@link DiffBuilder} to
+ * Typically, {@link Diff}s are retrieved by using a {@link DiffBuilder} to
* produce a {@link DiffResult}, containing the differences between two objects.
* </p>
*
*
* @param <T>
- * The type of object contained within this {@code Diff}. Differences
+ * The type of object contained within this {@link Diff}. Differences
* between primitive objects are stored as their Object wrapper
* equivalent.
* @since 3.3
@@ -52,7 +52,7 @@ public abstract class Diff<T> extends Pair<T, T> {
/**
* <p>
- * Constructs a new {@code Diff} for the given field name.
+ * Constructs a new {@link Diff} for the given field name.
* </p>
*
* @param fieldName
@@ -89,7 +89,7 @@ public abstract class Diff<T> extends Pair<T, T> {
/**
* <p>
- * Returns a {@code String} representation of the {@code Diff}, with the
+ * Returns a {@link String} representation of the {@link Diff}, with the
* following format:</p>
*
* <pre>
@@ -106,7 +106,7 @@ public abstract class Diff<T> extends Pair<T, T> {
/**
* <p>
- * Throws {@code UnsupportedOperationException}.
+ * Throws {@link UnsupportedOperationException}.
* </p>
*
* @param value
diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
index 6b2c50a36..e39f32564 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
@@ -19,6 +19,7 @@ package org.apache.commons.lang3.builder;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.Objects;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.ObjectUtils;
@@ -53,8 +54,8 @@ import org.apache.commons.lang3.Validate;
* </pre>
*
* <p>
- * The {@code ToStringStyle} passed to the constructor is embedded in the
- * returned {@code DiffResult} and influences the style of the
+ * The {@link ToStringStyle} passed to the constructor is embedded in the
+ * returned {@link DiffResult} and influences the style of the
* {@code DiffResult.toString()} method. This style choice can be overridden by
* calling {@link DiffResult#toString(ToStringStyle)}.
* </p>
@@ -789,15 +790,15 @@ public class DiffBuilder<T> implements Builder<DiffResult<T>> {
/**
* <p>
- * Test if two {@code Objects}s are equal.
+ * Test if two {@link Objects}s are equal.
* </p>
*
* @param fieldName
* the field name
* @param lhs
- * the left hand {@code Object}
+ * the left hand {@link Object}
* @param rhs
- * the right hand {@code Object}
+ * the right hand {@link Object}
* @return this
* @throws IllegalArgumentException
* if field name is {@code null}
@@ -914,7 +915,7 @@ public class DiffBuilder<T> implements Builder<DiffResult<T>> {
/**
* <p>
- * Append diffs from another {@code DiffResult}.
+ * Append diffs from another {@link DiffResult}.
* </p>
*
* <p>
@@ -942,7 +943,7 @@ public class DiffBuilder<T> implements Builder<DiffResult<T>> {
* @param fieldName
* the field name
* @param diffResult
- * the {@code DiffResult} to append
+ * the {@link DiffResult} to append
* @return this
* @throws NullPointerException if field name is {@code null}
* @since 3.5
@@ -969,7 +970,7 @@ public class DiffBuilder<T> implements Builder<DiffResult<T>> {
* builder.
* </p>
*
- * @return a {@code DiffResult} containing the differences between the two
+ * @return a {@link DiffResult} containing the differences between the two
* objects.
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
index 0a2361d87..4e2ef64b1 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
@@ -24,13 +24,13 @@ import org.apache.commons.lang3.Validate;
/**
* <p>
- * A {@code DiffResult} contains a collection of the differences between two
+ * A {@link DiffResult} contains a collection of the differences between two
* {@link Diffable} objects. Typically these differences are displayed using
* {@link #toString()} method, which returns a string describing the fields that
* differ between the objects.
* </p>
* <p>
- * Use a {@link DiffBuilder} to build a {@code DiffResult} comparing two objects.
+ * Use a {@link DiffBuilder} to build a {@link DiffResult} comparing two objects.
* </p>
* @param <T> type of the left and right object.
*
@@ -40,7 +40,7 @@ public class DiffResult<T> implements Iterable<Diff<?>> {
/**
* <p>
- * The {@code String} returned when the objects have no differences:
+ * The {@link String} returned when the objects have no differences:
* {@value}
* </p>
*/
@@ -110,11 +110,11 @@ public class DiffResult<T> implements Iterable<Diff<?>> {
/**
* <p>
- * Returns an unmodifiable list of {@code Diff}s. The list may be empty if
+ * Returns an unmodifiable list of {@link Diff}s. The list may be empty if
* there were no differences between the objects.
* </p>
*
- * @return an unmodifiable list of {@code Diff}s
+ * @return an unmodifiable list of {@link Diff}s
*/
public List<Diff<?>> getDiffs() {
return Collections.unmodifiableList(diffList);
@@ -144,9 +144,9 @@ public class DiffResult<T> implements Iterable<Diff<?>> {
/**
* <p>
- * Builds a {@code String} description of the differences contained within
- * this {@code DiffResult}. A {@link ToStringBuilder} is used for each object
- * and the style of the output is governed by the {@code ToStringStyle}
+ * Builds a {@link String} description of the differences contained within
+ * this {@link DiffResult}. A {@link ToStringBuilder} is used for each object
+ * and the style of the output is governed by the {@link ToStringStyle}
* passed to the constructor.
* </p>
*
@@ -167,11 +167,11 @@ public class DiffResult<T> implements Iterable<Diff<?>> {
* </p>
*
* <p>
- * To use a different {@code ToStringStyle} for an instance of this class,
+ * To use a different {@link ToStringStyle} for an instance of this class,
* use {@link #toString(ToStringStyle)}.
* </p>
*
- * @return a {@code String} description of the differences.
+ * @return a {@link String} description of the differences.
*/
@Override
public String toString() {
@@ -180,14 +180,14 @@ public class DiffResult<T> implements Iterable<Diff<?>> {
/**
* <p>
- * Builds a {@code String} description of the differences contained within
- * this {@code DiffResult}, using the supplied {@code ToStringStyle}.
+ * Builds a {@link String} description of the differences contained within
+ * this {@link DiffResult}, using the supplied {@link ToStringStyle}.
* </p>
*
* @param style
- * the {@code ToStringStyle} to use when outputting the objects
+ * the {@link ToStringStyle} to use when outputting the objects
*
- * @return a {@code String} description of the differences.
+ * @return a {@link String} description of the differences.
*/
public String toString(final ToStringStyle style) {
if (diffList.isEmpty()) {
@@ -208,7 +208,7 @@ public class DiffResult<T> implements Iterable<Diff<?>> {
/**
* <p>
- * Returns an iterator over the {@code Diff} objects contained in this list.
+ * Returns an iterator over the {@link Diff} objects contained in this list.
* </p>
*
* @return the iterator
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diffable.java b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
index 71ffe31eb..ef2065516 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diffable.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
@@ -17,7 +17,7 @@
package org.apache.commons.lang3.builder;
/**
- * <p>{@code Diffable} classes can be compared with other objects
+ * <p>{@link Diffable} classes can be compared with other objects
* for differences. The {@link DiffResult} object retrieved can be queried
* for a list of differences or printed using the {@link DiffResult#toString()}.</p>
*
@@ -25,10 +25,10 @@ package org.apache.commons.lang3.builder;
* and only if {@code d1.equals(d2)} implies {@code d1.diff(d2) == ""}.
* It is strongly recommended that implementations are consistent with equals
* to avoid confusion. Note that {@code null} is not an instance of any class
- * and {@code d1.diff(null)} should throw a {@code NullPointerException}.</p>
+ * and {@code d1.diff(null)} should throw a {@link NullPointerException}.</p>
*
* <p>
- * {@code Diffable} classes lend themselves well to unit testing, in which a
+ * {@link Diffable} classes lend themselves well to unit testing, in which a
* easily readable description of the differences between an anticipated result and
* an actual result can be retrieved. For example:
* </p>
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 48910a925..72fe72e3a 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -257,13 +257,13 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Set {@code Class}es whose instances should be compared by calling their {@code equals}
+ * <p>Set {@link 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} 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>
+ * of the {@link String} class, it is included in the default bypasses classes. Usually, if you use
+ * your own set of classes here, remember to include {@link String} class, too.</p>
* @param bypassReflectionClasses classes to bypass reflection test
* @return EqualsBuilder - used to chain calls.
* @see #setTestRecursive(boolean)
@@ -298,7 +298,7 @@ public class EqualsBuilder implements Builder<Boolean> {
/**
- * <p>This method uses reflection to determine if the two {@code Object}s
+ * <p>This method uses reflection to determine if the two {@link Object}s
* are equal.</p>
*
* <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
@@ -324,7 +324,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two {@code Object}s
+ * <p>This method uses reflection to determine if the two {@link Object}s
* are equal.</p>
*
* <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
@@ -350,7 +350,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two {@code Object}s
+ * <p>This method uses reflection to determine if the two {@link Object}s
* are equal.</p>
*
* <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
@@ -361,7 +361,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* <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}.</p>
+ * derived fields, and not part of the value of the {@link Object}.</p>
*
* <p>Static fields will not be tested. Superclass fields will be included.</p>
*
@@ -377,7 +377,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two {@code Object}s
+ * <p>This method uses reflection to determine if the two {@link Object}s
* are equal.</p>
*
* <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
@@ -388,7 +388,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* <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}.</p>
+ * derived fields, and not part of the value of the {@link 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
@@ -411,7 +411,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>This method uses reflection to determine if the two {@code Object}s
+ * <p>This method uses reflection to determine if the two {@link Object}s
* are equal.</p>
*
* <p>It uses {@code AccessibleObject.setAccessible} to gain access to private
@@ -422,7 +422,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* <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}.</p>
+ * derived fields, and not part of the value of the {@link 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
@@ -430,7 +430,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* <p>If the testRecursive parameter is set to {@code true}, non primitive
* (and non primitive wrapper) field types will be compared by
- * {@code EqualsBuilder} recursively instead of invoking their
+ * {@link EqualsBuilder} recursively instead of invoking their
* {@code equals()} method. Leading to a deep reflection equals test.
*
* @param lhs {@code this} object
@@ -474,7 +474,7 @@ public class EqualsBuilder implements Builder<Boolean> {
*
* <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}.</p>
+ * derived fields, and not part of the value of the {@link 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}.
@@ -610,7 +610,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if two {@code Object}s are equal using either
+ * <p>Test if two {@link Object}s are equal using either
* #{@link #reflectionAppend(Object, Object)}, if object are non
* primitives (or wrapper of primitives) or if field {@code testRecursive}
* is set to {@code false}. Otherwise, using their
@@ -646,7 +646,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Test if an {@code Object} is equal to an array.</p>
+ * <p>Test if an {@link Object} is equal to an array.</p>
*
* @param lhs the left hand object, an array
* @param rhs the right hand object
@@ -765,7 +765,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * {@code HashCodeBuilder}.</p>
+ * {@link HashCodeBuilder}.</p>
*
* @param lhs the left hand {@code double}
* @param rhs the right hand {@code double}
@@ -785,7 +785,7 @@ public class EqualsBuilder implements Builder<Boolean> {
* <p>This handles NaNs, Infinities, and {@code -0.0}.</p>
*
* <p>It is compatible with the hash code generated by
- * {@code HashCodeBuilder}.</p>
+ * {@link HashCodeBuilder}.</p>
*
* @param lhs the left hand {@code float}
* @param rhs the right hand {@code float}
@@ -814,7 +814,7 @@ public class EqualsBuilder implements Builder<Boolean> {
}
/**
- * <p>Performs a deep comparison of two {@code Object} arrays.</p>
+ * <p>Performs a deep comparison of two {@link Object} arrays.</p>
*
* <p>This also will be called for the top level of
* multi-dimensional, ragged, and multi-typed arrays.</p>
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 46167659c..48b177eb0 100644
--- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java
@@ -170,7 +170,7 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Appends the fields and values defined by the given object of the given {@code Class}.
+ * Appends the fields and values defined by the given object of the given {@link Class}.
* </p>
*
* @param object
@@ -228,7 +228,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* <p>
* Transient members will be not be used, as they are likely derived fields, and not part of the value of the
- * {@code Object}.
+ * {@link Object}.
* </p>
*
* <p>
@@ -272,7 +272,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* <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}.
+ * are ignored, as they are likely derived fields, and not part of the value of the {@link Object}.
* </p>
*
* <p>
@@ -319,7 +319,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* <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}.
+ * are ignored, as they are likely derived fields, and not part of the value of the {@link Object}.
* </p>
*
* <p>
@@ -386,7 +386,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* <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}.
+ * are ignored, as they are likely derived fields, and not part of the value of the {@link Object}.
* </p>
*
* <p>
@@ -426,7 +426,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* <p>
* Transient members will be not be used, as they are likely derived fields, and not part of the value of the
- * {@code Object}.
+ * {@link Object}.
* </p>
*
* <p>
@@ -465,7 +465,7 @@ public class HashCodeBuilder implements Builder<Integer> {
*
* <p>
* Transient members will be not be used, as they are likely derived fields, and not part of the value of the
- * {@code Object}.
+ * {@link Object}.
* </p>
*
* <p>
@@ -826,7 +826,7 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a {@code hashCode} for an {@code Object}.
+ * Append a {@code hashCode} for an {@link Object}.
* </p>
*
* @param object
@@ -882,7 +882,7 @@ public class HashCodeBuilder implements Builder<Integer> {
/**
* <p>
- * Append a {@code hashCode} for an {@code Object} array.
+ * Append a {@code hashCode} for an {@link Object} array.
* </p>
*
* @param array
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 6895869d7..ef974e8e5 100644
--- a/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java
@@ -84,13 +84,13 @@ public class RecursiveToStringStyle extends ToStringStyle {
}
/**
- * Returns whether or not to recursively format the given {@code Class}.
+ * Returns whether or not to recursively format the given {@link 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}.
+ * @return Whether or not to recursively format the given {@link Class}.
*/
protected boolean accept(final Class<?> clazz) {
return true;
diff --git a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
index 5b60bd813..a0395e236 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
@@ -54,8 +54,8 @@ import org.apache.commons.lang3.reflect.FieldUtils;
* </pre>
*
* <p>
- * The {@code ToStringStyle} passed to the constructor is embedded in the
- * returned {@code DiffResult} and influences the style of the
+ * The {@link ToStringStyle} passed to the constructor is embedded in the
+ * returned {@link DiffResult} and influences the style of the
* {@code DiffResult.toString()} method. This style choice can be overridden by
* calling {@link DiffResult#toString(ToStringStyle)}.
* </p>
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 a763029e9..1e2fd132c 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -70,7 +70,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} field in the returned {@code String}:
+ * For example, this method does <i>not</i> include the {@code password} field in the returned {@link String}:
* </p>
* <pre>
* public String toString() {
@@ -104,7 +104,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Builds a {@code toString} value using the default {@code ToStringStyle} through reflection.
+ * Builds a {@code toString} value using the default {@link ToStringStyle} through reflection.
* </p>
*
* <p>
@@ -148,7 +148,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is {@code null}, the default {@code ToStringStyle} is used.
+ * If the style is {@code null}, the default {@link ToStringStyle} is used.
* </p>
*
* @param object
@@ -157,7 +157,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* the style of the {@code toString} to create, may be {@code null}
* @return the String result
* @throws IllegalArgumentException
- * if the Object or {@code ToStringStyle} is {@code null}
+ * if the Object or {@link ToStringStyle} is {@code null}
*
* @see ToStringExclude
* @see ToStringSummary
@@ -187,7 +187,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is {@code null}, the default {@code ToStringStyle} is used.
+ * If the style is {@code null}, the default {@link ToStringStyle} is used.
* </p>
*
* @param object
@@ -233,7 +233,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is {@code null}, the default {@code ToStringStyle} is used.
+ * If the style is {@code null}, the default {@link ToStringStyle} is used.
* </p>
*
* @param object
@@ -283,7 +283,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is {@code null}, the default {@code ToStringStyle} is used.
+ * If the style is {@code null}, the default {@link ToStringStyle} is used.
* </p>
*
* @param <T>
@@ -340,7 +340,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* </p>
*
* <p>
- * If the style is {@code null}, the default {@code ToStringStyle} is used.
+ * If the style is {@code null}, the default {@link ToStringStyle} is used.
* </p>
*
* @param <T>
@@ -521,7 +521,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param style
* the style of the {@code toString} to create, may be {@code null}
* @param buffer
- * the {@code StringBuffer} to populate, may be {@code null}
+ * the {@link StringBuffer} to populate, may be {@code null}
* @throws IllegalArgumentException
* if the Object passed in is {@code null}
*/
@@ -539,7 +539,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param style
* the style of the {@code toString} to create, may be {@code null}
* @param buffer
- * the {@code StringBuffer} to populate, may be {@code null}
+ * the {@link StringBuffer} to populate, may be {@code null}
* @param reflectUpToClass
* the superclass to reflect up to (inclusive), may be {@code null}
* @param outputTransients
@@ -567,7 +567,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
* @param style
* the style of the {@code toString} to create, may be {@code null}
* @param buffer
- * the {@code StringBuffer} to populate, may be {@code null}
+ * the {@link StringBuffer} to populate, may be {@code null}
* @param reflectUpToClass
* the superclass to reflect up to (inclusive), may be {@code null}
* @param outputTransients
@@ -590,7 +590,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
}
/**
- * Returns whether or not to append the given {@code Field}.
+ * Returns whether or not to append the given {@link Field}.
* <ul>
* <li>Transient fields are appended only if {@link #isAppendTransients()} returns {@code true}.
* <li>Static fields are appended only if {@link #isAppendStatics()} returns {@code true}.
@@ -599,7 +599,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
*
* @param field
* The Field to test.
- * @return Whether or not to append the given {@code Field}.
+ * @return Whether or not to append the given {@link Field}.
*/
protected boolean accept(final Field field) {
if (field.getName().indexOf(ClassUtils.INNER_CLASS_SEPARATOR_CHAR) != -1) {
@@ -739,7 +739,7 @@ public class ReflectionToStringBuilder extends ToStringBuilder {
/**
* <p>
- * Append to the {@code toString} an {@code Object} array.
+ * Append to the {@code toString} an {@link Object} array.
* </p>
*
* @param array
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 b60f13dca..7e0b445b9 100644
--- a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
@@ -16,6 +16,10 @@
*/
package org.apache.commons.lang3.builder;
+import java.lang.reflect.Array;
+import java.util.Collection;
+import java.util.Map;
+
/**
* <p>Works with {@link ToStringBuilder} to create a {@code toString}.</p>
*
@@ -398,8 +402,8 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Gets the text to output when a {@code Collection},
- * {@code Map} or {@code Array} size is output.</p>
+ * <p>Gets the text to output when a {@link Collection},
+ * {@link Map} or {@link Array} size is output.</p>
*
* <p>This is output before the size value.</p>
*
@@ -411,8 +415,8 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the start text to output when a {@code Collection},
- * {@code Map} or {@code Array} size is output.</p>
+ * <p>Sets the start text to output when a {@link Collection},
+ * {@link Map} or {@link Array} size is output.</p>
*
* <p>This is output before the size value.</p>
*
@@ -427,8 +431,8 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Gets the end text to output when a {@code Collection},
- * {@code Map} or {@code Array} size is output.</p>
+ * <p>Gets the end text to output when a {@link Collection},
+ * {@link Map} or {@link Array} size is output.</p>
*
* <p>This is output after the size value.</p>
*
@@ -440,8 +444,8 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the end text to output when a {@code Collection},
- * {@code Map} or {@code Array} size is output.</p>
+ * <p>Sets the end text to output when a {@link Collection},
+ * {@link Map} or {@link Array} size is output.</p>
*
* <p>This is output after the size value.</p>
*
@@ -456,7 +460,7 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Gets the start text to output when an {@code Object} is
+ * <p>Gets the start text to output when an {@link Object} is
* output in summary mode.</p>
*
* <P>This is output before the size value.</p>
@@ -469,7 +473,7 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the start text to output when an {@code Object} is
+ * <p>Sets the start text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output before the size value.</p>
@@ -485,7 +489,7 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Gets the end text to output when an {@code Object} is
+ * <p>Gets the end text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
@@ -498,7 +502,7 @@ public class StandardToStringStyle extends ToStringStyle {
}
/**
- * <p>Sets the end text to output when an {@code Object} is
+ * <p>Sets the end text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
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 5830051a1..983cb68ad 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
@@ -94,11 +94,11 @@ public class ToStringBuilder implements Builder<String> {
private static volatile ToStringStyle defaultStyle = ToStringStyle.DEFAULT_STYLE;
/**
- * <p>Gets the default {@code ToStringStyle} to use.</p>
+ * <p>Gets the default {@link 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} to the constructor instead
+ * It is recommended to pass a {@link ToStringStyle} to the constructor instead
* of using this global default.</p>
*
* <p>This method can be used from multiple threads.
@@ -109,25 +109,25 @@ public class ToStringBuilder implements Builder<String> {
* <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}, never null
+ * @return the default {@link ToStringStyle}, never null
*/
public static ToStringStyle getDefaultStyle() {
return defaultStyle;
}
/**
- * <p>Sets the default {@code ToStringStyle} to use.</p>
+ * <p>Sets the default {@link 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} to the constructor instead
+ * It is recommended to pass a {@link 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} 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}
+ * @param style the default {@link ToStringStyle}
* @throws IllegalArgumentException if the style is {@code null}
*/
public static void setDefaultStyle(final ToStringStyle style) {
@@ -135,7 +135,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * <p>Uses {@link ReflectionToStringBuilder} to generate a
* {@code toString} for the specified object.</p>
*
* @param object the Object to be output
@@ -147,7 +147,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * <p>Uses {@link ReflectionToStringBuilder} to generate a
* {@code toString} for the specified object.</p>
*
* @param object the Object to be output
@@ -160,7 +160,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * <p>Uses {@link ReflectionToStringBuilder} to generate a
* {@code toString} for the specified object.</p>
*
* @param object the Object to be output
@@ -174,7 +174,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Uses {@code ReflectionToStringBuilder} to generate a
+ * <p>Uses {@link ReflectionToStringBuilder} to generate a
* {@code toString} for the specified object.</p>
*
* @param <T> the type of the object
@@ -239,7 +239,7 @@ public class ToStringBuilder implements Builder<String> {
*
* @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
+ * @param buffer the {@link StringBuffer} to populate, may be null
*/
public ToStringBuilder(final Object object, ToStringStyle style, StringBuffer buffer) {
if (style == null) {
@@ -424,7 +424,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* value.</p>
*
* @param obj the value to add to the {@code toString}
@@ -436,7 +436,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* array.</p>
*
* @param array the array to add to the {@code toString}
@@ -793,7 +793,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* value.</p>
*
* @param fieldName the field name
@@ -806,7 +806,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* value.</p>
*
* @param fieldName the field name
@@ -821,7 +821,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* array.</p>
*
* @param fieldName the field name
@@ -834,7 +834,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* array.</p>
*
* <p>A boolean parameter controls the level of detail to show.
@@ -904,7 +904,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} whose class name and id to output
+ * @param srcObject the {@link Object} whose class name and id to output
* @return this
* @since 2.0
*/
@@ -916,7 +916,7 @@ public class ToStringBuilder implements Builder<String> {
/**
* <p>Append the {@code toString} from the superclass.</p>
*
- * <p>This method assumes that the superclass uses the same {@code ToStringStyle}
+ * <p>This method assumes that the superclass uses the same {@link ToStringStyle}
* as this one.</p>
*
* <p>If {@code superToString} is {@code null}, no change is made.</p>
@@ -950,7 +950,7 @@ public class ToStringBuilder implements Builder<String> {
* toString();
* }</pre>
*
- * <p>This method assumes that the other object uses the same {@code ToStringStyle}
+ * <p>This method assumes that the other object uses the same {@link ToStringStyle}
* as this one.</p>
*
* <p>If the {@code toString} is {@code null}, no change is made.</p>
@@ -967,7 +967,7 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Returns the {@code Object} being output.</p>
+ * <p>Returns the {@link Object} being output.</p>
*
* @return The object being output.
* @since 2.0
@@ -977,18 +977,18 @@ public class ToStringBuilder implements Builder<String> {
}
/**
- * <p>Gets the {@code StringBuffer} being populated.</p>
+ * <p>Gets the {@link StringBuffer} being populated.</p>
*
- * @return the {@code StringBuffer} being populated
+ * @return the {@link StringBuffer} being populated
*/
public StringBuffer getStringBuffer() {
return buffer;
}
/**
- * <p>Gets the {@code ToStringStyle} being used.</p>
+ * <p>Gets the {@link ToStringStyle} being used.</p>
*
- * @return the {@code ToStringStyle} being used
+ * @return the {@link ToStringStyle} being used
* @since 2.0
*/
public ToStringStyle getStyle() {
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 70f642f32..8f71b97ba 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
@@ -30,10 +30,10 @@ import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.commons.lang3.StringUtils;
/**
- * <p>Controls {@code String} formatting for {@link ToStringBuilder}.
- * The main public interface is always via {@code ToStringBuilder}.</p>
+ * <p>Controls {@link String} formatting for {@link ToStringBuilder}.
+ * The main public interface is always via {@link ToStringBuilder}.</p>
*
- * <p>These classes are intended to be used as {@code Singletons}.
+ * <p>These classes are intended to be used as <em>singletons</em>.
* 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
@@ -42,7 +42,7 @@ import org.apache.commons.lang3.StringUtils;
*
* <p>If required, a subclass can override as many or as few of the
* methods as it requires. Each object type (from {@code boolean}
- * to {@code long} to {@code Object} to {@code int[]}) has
+ * to {@code long} to {@link 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
@@ -363,7 +363,7 @@ public abstract class ToStringStyle implements Serializable {
*
* <p>A {@code null} {@code superToString} is ignored.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param superToString the {@code super.toString()}
* @since 2.0
*/
@@ -377,7 +377,7 @@ public abstract class ToStringStyle implements Serializable {
*
* <p>A {@code null} {@code toString} is ignored.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param toString the additional {@code toString}
* @since 2.0
*/
@@ -398,8 +398,8 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the start of data indicator.</p>
*
- * @param buffer the {@code StringBuffer} to populate
- * @param object the {@code Object} to build a {@code toString} for
+ * @param buffer the {@link StringBuffer} to populate
+ * @param object the {@link Object} to build a {@code toString} for
*/
public void appendStart(final StringBuffer buffer, final Object object) {
if (object != null) {
@@ -415,8 +415,8 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the end of data indicator.</p>
*
- * @param buffer the {@code StringBuffer} to populate
- * @param object the {@code Object} to build a
+ * @param buffer the {@link StringBuffer} to populate
+ * @param object the {@link Object} to build a
* {@code toString} for.
*/
public void appendEnd(final StringBuffer buffer, final Object object) {
@@ -430,7 +430,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Remove the last field separator from the buffer.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @since 2.0
*/
protected void removeLastFieldSeparator(final StringBuffer buffer) {
@@ -440,11 +440,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* value, printing the full {@code toString} of the
- * {@code Object} passed in.</p>
+ * {@link Object} passed in.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
@@ -464,19 +464,19 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} an {@code Object},
+ * <p>Append to the {@code toString} an {@link Object},
* correctly interpreting its type.</p>
*
* <p>This method performs the main lookup by Class type to correctly
- * route arrays, {@code Collections}, {@code Maps} and
- * {@code Objects} to the appropriate method.</p>
+ * route arrays, {@link Collection}s, {@link Map}s and
+ * {@link 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()} format.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString},
* not {@code null}
@@ -580,11 +580,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link 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} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString},
* not {@code null}
@@ -596,10 +596,10 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
- * value, printing the full detail of the {@code Object}.</p>
+ * <p>Append to the {@code toString} an {@link Object}
+ * value, printing the full detail of the {@link Object}.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString},
* not {@code null}
@@ -609,11 +609,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} a {@code Collection}.</p>
+ * <p>Append to the {@code toString} a {@link Collection}.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param coll the {@code Collection} to add to the
+ * @param coll the {@link Collection} to add to the
* {@code toString}, not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final Collection<?> coll) {
@@ -621,11 +621,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} a {@code Map}.</p>
+ * <p>Append to the {@code toString} a {@link Map}.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
- * @param map the {@code Map} to add to the {@code toString},
+ * @param map the {@link Map} to add to the {@code toString},
* not {@code null}
*/
protected void appendDetail(final StringBuffer buffer, final String fieldName, final Map<?, ?> map) {
@@ -633,10 +633,10 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
- * value, printing a summary of the {@code Object}.</P>
+ * <p>Append to the {@code toString} an {@link Object}
+ * value, printing a summary of the {@link Object}.</P>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString},
* not {@code null}
@@ -651,7 +651,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code long}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -665,7 +665,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code long}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -677,7 +677,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} an {@code int}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -691,7 +691,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} an {@code int}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -703,7 +703,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code short}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -717,7 +717,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code short}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -729,7 +729,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code byte}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -743,7 +743,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code byte}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -755,7 +755,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code char}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -769,7 +769,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code char}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -781,7 +781,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code double}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -795,7 +795,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code double}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -807,7 +807,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code float}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -821,7 +821,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code float}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -833,7 +833,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code boolean}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param value the value to add to the {@code toString}
*/
@@ -847,7 +847,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code boolean}
* value.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the {@code toString}
*/
@@ -856,10 +856,10 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Append to the {@code toString} an {@code Object}
+ * <p>Append to the {@code toString} an {@link Object}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail {@code true} for detail, {@code false}
@@ -883,9 +883,9 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the detail of an
- * {@code Object} array.</p>
+ * {@link Object} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -901,9 +901,9 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the detail of an
- * {@code Object} array item.</p>
+ * {@link Object} array item.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param i the array item index to add
* @param item the array item to add
@@ -923,7 +923,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the detail of an array type.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -941,9 +941,9 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} a summary of an
- * {@code Object} array.</p>
+ * {@link Object} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -956,7 +956,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code long}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
@@ -982,7 +982,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code long} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1002,7 +1002,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code long} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1015,7 +1015,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} an {@code int}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
@@ -1041,7 +1041,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of an
* {@code int} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1061,7 +1061,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of an
* {@code int} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1074,7 +1074,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code short}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
@@ -1100,7 +1100,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code short} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1120,7 +1120,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code short} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1133,7 +1133,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code byte}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
@@ -1159,7 +1159,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code byte} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1179,7 +1179,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code byte} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1192,7 +1192,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code char}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the {@code toString}
* @param fullDetail {@code true} for detail, {@code false}
@@ -1218,7 +1218,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code char} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1238,7 +1238,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code char} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1251,7 +1251,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code double}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail {@code true} for detail, {@code false}
@@ -1277,7 +1277,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code double} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1297,7 +1297,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code double} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1310,7 +1310,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code float}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail {@code true} for detail, {@code false}
@@ -1336,7 +1336,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code float} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1356,7 +1356,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code float} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1369,7 +1369,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a {@code boolean}
* array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail {@code true} for detail, {@code false}
@@ -1395,7 +1395,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} the detail of a
* {@code boolean} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1415,7 +1415,7 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a summary of a
* {@code boolean} array.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the {@code toString},
* not {@code null}
@@ -1427,8 +1427,8 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the class name.</p>
*
- * @param buffer the {@code StringBuffer} to populate
- * @param object the {@code Object} whose name to output
+ * @param buffer the {@link StringBuffer} to populate
+ * @param object the {@link Object} whose name to output
*/
protected void appendClassName(final StringBuffer buffer, final Object object) {
if (useClassName && object != null) {
@@ -1444,8 +1444,8 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append the {@link System#identityHashCode(java.lang.Object)}.</p>
*
- * @param buffer the {@code StringBuffer} to populate
- * @param object the {@code Object} whose id to output
+ * @param buffer the {@link StringBuffer} to populate
+ * @param object the {@link Object} whose id to output
*/
protected void appendIdentityHashCode(final StringBuffer buffer, final Object object) {
if (this.isUseIdentityHashCode() && object != null) {
@@ -1458,7 +1458,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the content start.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
*/
protected void appendContentStart(final StringBuffer buffer) {
buffer.append(contentStart);
@@ -1467,7 +1467,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the content end.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
*/
protected void appendContentEnd(final StringBuffer buffer) {
buffer.append(contentEnd);
@@ -1478,7 +1478,7 @@ public abstract class ToStringStyle implements Serializable {
*
* <p>The default indicator is {@code '&lt;null&gt;'}.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
*/
protected void appendNullText(final StringBuffer buffer, final String fieldName) {
@@ -1488,7 +1488,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the field separator.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
*/
protected void appendFieldSeparator(final StringBuffer buffer) {
buffer.append(fieldSeparator);
@@ -1497,7 +1497,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the field start.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name
*/
protected void appendFieldStart(final StringBuffer buffer, final String fieldName) {
@@ -1510,7 +1510,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>Append to the {@code toString} the field end.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
*/
protected void appendFieldEnd(final StringBuffer buffer, final String fieldName) {
@@ -1521,14 +1521,14 @@ public abstract class ToStringStyle implements Serializable {
* <p>Append to the {@code toString} a size summary.</p>
*
* <p>The size summary is used to summarize the contents of
- * {@code Collections}, {@code Maps} and arrays.</p>
+ * {@link Collection}s, {@link Map}s and arrays.</p>
*
* <p>The output consists of a prefix, the passed in size
* and a suffix.</p>
*
* <p>The default format is {@code '&lt;size=n&gt;'}.</p>
*
- * @param buffer the {@code StringBuffer} to populate
+ * @param buffer the {@link StringBuffer} to populate
* @param fieldName the field name, typically not used as already appended
* @param size the size to append
*/
@@ -1565,7 +1565,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} to get the short name of
+ * @param cls the {@link Class} to get the short name of
* @return the short name
*/
protected String getShortClassName(final Class<?> cls) {
@@ -1924,8 +1924,8 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Gets the start text to output when a {@code Collection},
- * {@code Map} or array size is output.</p>
+ * <p>Gets the start text to output when a {@link Collection},
+ * {@link Map} or array size is output.</p>
*
* <p>This is output before the size value.</p>
*
@@ -1936,8 +1936,8 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the start text to output when a {@code Collection},
- * {@code Map} or array size is output.</p>
+ * <p>Sets the start text to output when a {@link Collection},
+ * {@link Map} or array size is output.</p>
*
* <p>This is output before the size value.</p>
*
@@ -1954,8 +1954,8 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Gets the end text to output when a {@code Collection},
- * {@code Map} or array size is output.</p>
+ * <p>Gets the end text to output when a {@link Collection},
+ * {@link Map} or array size is output.</p>
*
* <p>This is output after the size value.</p>
*
@@ -1966,8 +1966,8 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the end text to output when a {@code Collection},
- * {@code Map} or array size is output.</p>
+ * <p>Sets the end text to output when a {@link Collection},
+ * {@link Map} or array size is output.</p>
*
* <p>This is output after the size value.</p>
*
@@ -1984,7 +1984,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Gets the start text to output when an {@code Object} is
+ * <p>Gets the start text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output before the size value.</p>
@@ -1996,7 +1996,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the start text to output when an {@code Object} is
+ * <p>Sets the start text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output before the size value.</p>
@@ -2014,7 +2014,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Gets the end text to output when an {@code Object} is
+ * <p>Gets the end text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
@@ -2026,7 +2026,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Sets the end text to output when an {@code Object} is
+ * <p>Sets the end text to output when an {@link Object} is
* output in summary mode.</p>
*
* <p>This is output after the size value.</p>
@@ -2044,10 +2044,10 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Default {@code ToStringStyle}.</p>
+ * <p>Default {@link ToStringStyle}.</p>
*
* <p>This is an inner class rather than using
- * {@code StandardToStringStyle} to ensure its immutability.</p>
+ * {@link StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class DefaultToStringStyle extends ToStringStyle {
@@ -2067,7 +2067,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure {@code Singleton} after serialization.</p>
+ * <p>Ensure {@link Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2078,11 +2078,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>{@code ToStringStyle} that does not print out
+ * <p>{@link ToStringStyle} that does not print out
* the field names.</p>
*
* <p>This is an inner class rather than using
- * {@code StandardToStringStyle} to ensure its immutability.
+ * {@link StandardToStringStyle} to ensure its immutability.
*/
private static final class NoFieldNameToStringStyle extends ToStringStyle {
@@ -2098,7 +2098,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure {@code Singleton} after serialization.</p>
+ * <p>Ensure {@link Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2109,11 +2109,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>{@code ToStringStyle} that prints out the short
+ * <p>{@link ToStringStyle} that prints out the short
* class name and no identity hashcode.</p>
*
* <p>This is an inner class rather than using
- * {@code StandardToStringStyle} to ensure its immutability.</p>
+ * {@link StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class ShortPrefixToStringStyle extends ToStringStyle {
@@ -2140,11 +2140,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>{@code ToStringStyle} that does not print out the
+ * <p>{@link 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} to ensure its immutability.</p>
+ * {@link StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class SimpleToStringStyle extends ToStringStyle {
@@ -2174,10 +2174,10 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>{@code ToStringStyle} that outputs on multiple lines.</p>
+ * <p>{@link ToStringStyle} that outputs on multiple lines.</p>
*
* <p>This is an inner class rather than using
- * {@code StandardToStringStyle} to ensure its immutability.</p>
+ * {@link StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class MultiLineToStringStyle extends ToStringStyle {
@@ -2196,7 +2196,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure {@code Singleton} after serialization.</p>
+ * <p>Ensure {@link Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2207,11 +2207,11 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>{@code ToStringStyle} that does not print out the classname
+ * <p>{@link 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} to ensure its immutability.</p>
+ * {@link StandardToStringStyle} to ensure its immutability.</p>
*/
private static final class NoClassNameToStringStyle extends ToStringStyle {
@@ -2228,7 +2228,7 @@ public abstract class ToStringStyle implements Serializable {
}
/**
- * <p>Ensure {@code Singleton} after serialization.</p>
+ * <p>Ensure {@link Singleton} after serialization.</p>
*
* @return the singleton
*/
@@ -2240,12 +2240,12 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * {@code ToStringStyle} that outputs with JSON format.
+ * {@link ToStringStyle} that outputs with JSON format.
* </p>
*
* <p>
* This is an inner class rather than using
- * {@code StandardToStringStyle} to ensure its immutability.
+ * {@link StandardToStringStyle} to ensure its immutability.
* </p>
*
* @since 3.4
@@ -2560,7 +2560,7 @@ public abstract class ToStringStyle implements Serializable {
/**
* <p>
- * Ensure {@code Singleton} after serialization.
+ * Ensure {@link Singleton} after serialization.
* </p>
*
* @return the singleton
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-25 02:51:25 +0000