aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/lang3/tuple
diff options
context:
space:
mode:
authorGary Gregory <garydgregory@gmail.com>2022-08-23 10:17:50 -0400
committerGary Gregory <garydgregory@gmail.com>2022-08-23 10:46:01 -0400
commit1c2397eb4774032eedd4223b7d3b9ec366d3b685 (patch)
tree19517082b90e6f3ec8b21c60d98c77f15a68aa36 /src/main/java/org/apache/commons/lang3/tuple
parent21da81bb4d9d1080716fe4f75eddc96a8a4e27a7 (diff)
downloadapache-commons-lang-1c2397eb4774032eedd4223b7d3b9ec366d3b685.tar.gz
First sentence of a Javadoc comment does not need p tags
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/tuple')
-rw-r--r--src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java14
-rw-r--r--src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java6
-rw-r--r--src/main/java/org/apache/commons/lang3/tuple/MutablePair.java8
-rw-r--r--src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java6
-rw-r--r--src/main/java/org/apache/commons/lang3/tuple/Pair.java30
-rw-r--r--src/main/java/org/apache/commons/lang3/tuple/Triple.java24
6 files changed, 44 insertions, 44 deletions
diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
index 7c5e0e9ab..6caf3c52b 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java
@@ -20,7 +20,7 @@ import java.util.Map;
import java.util.Objects;
/**
- * <p>An immutable pair consisting of two {@link Object} elements.</p>
+ * An immutable pair consisting of two {@link Object} elements.
*
* <p>Although the implementation is immutable, there is no restriction on the objects
* that may be stored. If mutable objects are stored in the pair, then the pair
@@ -71,7 +71,7 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates an immutable pair of two objects inferring the generic types.</p>
+ * Creates an immutable pair of two objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -99,7 +99,7 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates an immutable pair of two objects inferring the generic types.</p>
+ * Creates an immutable pair of two objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -115,7 +115,7 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates an immutable pair from a map entry.</p>
+ * Creates an immutable pair from a map entry.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -131,7 +131,7 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates an immutable pair of two non-null objects inferring the generic types.</p>
+ * Creates an immutable pair of two non-null objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -149,7 +149,7 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates an immutable pair of two objects inferring the generic types.</p>
+ * Creates an immutable pair of two objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -198,7 +198,7 @@ public class ImmutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Throws {@link UnsupportedOperationException}.</p>
+ * Throws {@link UnsupportedOperationException}.
*
* <p>This pair is immutable, so this operation is not supported.</p>
*
diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java b/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
index 40a9461c1..453d08a8a 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java
@@ -19,7 +19,7 @@ package org.apache.commons.lang3.tuple;
import java.util.Objects;
/**
- * <p>An immutable triple consisting of three {@link Object} elements.</p>
+ * An immutable triple consisting of three {@link Object} elements.
*
* <p>Although the implementation is immutable, there is no restriction on the objects
* that may be stored. If mutable objects are stored in the triple, then the triple
@@ -85,7 +85,7 @@ public class ImmutableTriple<L, M, R> extends Triple<L, M, R> {
}
/**
- * <p>Obtains an immutable triple of three objects inferring the generic types.</p>
+ * Obtains an immutable triple of three objects inferring the generic types.
*
* <p>This factory allows the triple to be created using inference to
* obtain the generic types.</p>
@@ -103,7 +103,7 @@ public class ImmutableTriple<L, M, R> extends Triple<L, M, R> {
}
/**
- * <p>Obtains an immutable triple of three non-null objects inferring the generic types.</p>
+ * Obtains an immutable triple of three non-null objects inferring the generic types.
*
* <p>This factory allows the triple to be created using inference to
* obtain the generic types.</p>
diff --git a/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java b/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
index d6caaac3f..f4b5512da 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/MutablePair.java
@@ -20,7 +20,7 @@ import java.util.Map;
import java.util.Objects;
/**
- * <p>A mutable pair consisting of two {@link Object} elements.</p>
+ * A mutable pair consisting of two {@link Object} elements.
*
* <p>Not #ThreadSafe#</p>
*
@@ -59,7 +59,7 @@ public class MutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates a mutable pair of two objects inferring the generic types.</p>
+ * Creates a mutable pair of two objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -75,7 +75,7 @@ public class MutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates a mutable pair from a map entry.</p>
+ * Creates a mutable pair from a map entry.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -99,7 +99,7 @@ public class MutablePair<L, R> extends Pair<L, R> {
}
/**
- * <p>Creates a mutable pair of two non-null objects inferring the generic types.</p>
+ * Creates a mutable pair of two non-null objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
diff --git a/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java b/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
index 8481fdda5..b446017c4 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java
@@ -19,7 +19,7 @@ package org.apache.commons.lang3.tuple;
import java.util.Objects;
/**
- * <p>A mutable triple consisting of three {@link Object} elements.</p>
+ * A mutable triple consisting of three {@link Object} elements.
*
* <p>Not #ThreadSafe#</p>
*
@@ -60,7 +60,7 @@ public class MutableTriple<L, M, R> extends Triple<L, M, R> {
}
/**
- * <p>Obtains a mutable triple of three objects inferring the generic types.</p>
+ * Obtains a mutable triple of three objects inferring the generic types.
*
* <p>This factory allows the triple to be created using inference to
* obtain the generic types.</p>
@@ -78,7 +78,7 @@ public class MutableTriple<L, M, R> extends Triple<L, M, R> {
}
/**
- * <p>Obtains a mutable triple of three non-null objects inferring the generic types.</p>
+ * Obtains a mutable triple of three non-null objects inferring the generic types.
*
* <p>This factory allows the triple to be created using inference to
* obtain the generic types.</p>
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Pair.java b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
index 2a3d7189f..3b97e061b 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Pair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
@@ -23,7 +23,7 @@ import java.util.Objects;
import org.apache.commons.lang3.builder.CompareToBuilder;
/**
- * <p>A pair consisting of two elements.</p>
+ * A pair consisting of two elements.
*
* <p>This class is an abstract implementation defining the basic API.
* It refers to the elements as 'left' and 'right'. It also implements the
@@ -68,7 +68,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Creates an immutable pair of two objects inferring the generic types.</p>
+ * Creates an immutable pair of two objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -84,7 +84,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Creates an immutable pair from a map entry.</p>
+ * Creates an immutable pair from a map entry.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -100,7 +100,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Creates an immutable pair of two non-null objects inferring the generic types.</p>
+ * Creates an immutable pair of two non-null objects inferring the generic types.
*
* <p>This factory allows the pair to be created using inference to
* obtain the generic types.</p>
@@ -118,8 +118,8 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Compares the pair based on the left element followed by the right element.
- * The types must be {@link Comparable}.</p>
+ * Compares the pair based on the left element followed by the right element.
+ * The types must be {@link Comparable}.
*
* @param other the other pair, not null
* @return negative if this is less, zero if equal, positive if greater
@@ -131,7 +131,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Compares this pair to another based on the two elements.</p>
+ * Compares this pair to another based on the two elements.
*
* @param obj the object to compare to, null returns false
* @return true if the elements of the pair are equal
@@ -150,7 +150,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Gets the key from this pair.</p>
+ * Gets the key from this pair.
*
* <p>This method implements the {@code Map.Entry} interface returning the
* left element as the key.</p>
@@ -163,7 +163,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Gets the left element from this pair.</p>
+ * Gets the left element from this pair.
*
* <p>When treated as a key-value pair, this is the key.</p>
*
@@ -172,7 +172,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
public abstract L getLeft();
/**
- * <p>Gets the right element from this pair.</p>
+ * Gets the right element from this pair.
*
* <p>When treated as a key-value pair, this is the value.</p>
*
@@ -181,7 +181,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
public abstract R getRight();
/**
- * <p>Gets the value from this pair.</p>
+ * Gets the value from this pair.
*
* <p>This method implements the {@code Map.Entry} interface returning the
* right element as the value.</p>
@@ -194,8 +194,8 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Returns a suitable hash code.
- * The hash code follows the definition in {@code Map.Entry}.</p>
+ * Returns a suitable hash code.
+ * The hash code follows the definition in {@code Map.Entry}.
*
* @return the hash code
*/
@@ -206,7 +206,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Returns a String representation of this pair using the format {@code ($left,$right)}.</p>
+ * Returns a String representation of this pair using the format {@code ($left,$right)}.
*
* @return a string describing this object, not null
*/
@@ -216,7 +216,7 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
}
/**
- * <p>Formats the receiver using the given format.</p>
+ * Formats the receiver using the given format.
*
* <p>This uses {@link java.util.Formattable} to perform the formatting. Two variables may
* be used to embed the left and right elements. Use {@code %1$s} for the left
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Triple.java b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
index ad609d43f..a7433ea60 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Triple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
@@ -22,7 +22,7 @@ import java.util.Objects;
import org.apache.commons.lang3.builder.CompareToBuilder;
/**
- * <p>A triple consisting of three elements.</p>
+ * A triple consisting of three elements.
*
* <p>This class is an abstract implementation defining the basic API.
* It refers to the elements as 'left', 'middle' and 'right'.</p>
@@ -68,7 +68,7 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Obtains an immutable triple of three objects inferring the generic types.</p>
+ * Obtains an immutable triple of three objects inferring the generic types.
*
* <p>This factory allows the triple to be created using inference to
* obtain the generic types.</p>
@@ -86,7 +86,7 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Obtains an immutable triple of three non-null objects inferring the generic types.</p>
+ * Obtains an immutable triple of three non-null objects inferring the generic types.
*
* <p>This factory allows the triple to be created using inference to
* obtain the generic types.</p>
@@ -106,9 +106,9 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Compares the triple based on the left element, followed by the middle element,
+ * Compares the triple based on the left element, followed by the middle element,
* finally the right element.
- * The types must be {@link Comparable}.</p>
+ * The types must be {@link Comparable}.
*
* @param other the other triple, not null
* @return negative if this is less, zero if equal, positive if greater
@@ -121,7 +121,7 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Compares this triple to another based on the three elements.</p>
+ * Compares this triple to another based on the three elements.
*
* @param obj the object to compare to, null returns false
* @return true if the elements of the triple are equal
@@ -141,28 +141,28 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Gets the left element from this triple.</p>
+ * Gets the left element from this triple.
*
* @return the left element, may be null
*/
public abstract L getLeft();
/**
- * <p>Gets the middle element from this triple.</p>
+ * Gets the middle element from this triple.
*
* @return the middle element, may be null
*/
public abstract M getMiddle();
/**
- * <p>Gets the right element from this triple.</p>
+ * Gets the right element from this triple.
*
* @return the right element, may be null
*/
public abstract R getRight();
/**
- * <p>Returns a suitable hash code.</p>
+ * Returns a suitable hash code.
*
* @return the hash code
*/
@@ -172,7 +172,7 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Returns a String representation of this triple using the format {@code ($left,$middle,$right)}.</p>
+ * Returns a String representation of this triple using the format {@code ($left,$middle,$right)}.
*
* @return a string describing this object, not null
*/
@@ -182,7 +182,7 @@ public abstract class Triple<L, M, R> implements Comparable<Triple<L, M, R>>, Se
}
/**
- * <p>Formats the receiver using the given format.</p>
+ * Formats the receiver using the given format.
*
* <p>This uses {@link java.util.Formattable} to perform the formatting. Three variables may
* be used to embed the left and right elements. Use {@code %1$s} for the left