This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new de7f14bf4 Fix malformed Javadoc comments
de7f14bf4 is described below
commit de7f14bf44c9eebf1314c69feeabadb4759c6261
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Dec 13 08:32:07 2025 -0500
Fix malformed Javadoc comments
---
src/changes/changes.xml | 1 +
.../apache/commons/collections4/ClosureUtils.java | 26 +++++++--------
.../commons/collections4/CollectionUtils.java | 20 ++++++------
.../apache/commons/collections4/FactoryUtils.java | 14 ++++----
.../commons/collections4/FluentIterable.java | 15 ++++-----
.../apache/commons/collections4/IterableUtils.java | 4 +--
.../apache/commons/collections4/IteratorUtils.java | 22 ++++++-------
.../org/apache/commons/collections4/MapUtils.java | 26 +++++++--------
.../commons/collections4/PredicateUtils.java | 36 ++++++++++----------
.../commons/collections4/TransformerUtils.java | 38 +++++++++++-----------
.../commons/collections4/bag/package-info.java | 14 ++++----
.../commons/collections4/bidimap/package-info.java | 10 +++---
.../bloomfilter/LayeredBloomFilter.java | 2 +-
.../collections4/collection/package-info.java | 15 +++++----
.../collections4/keyvalue/package-info.java | 7 ++--
.../apache/commons/collections4/map/Flat3Map.java | 10 +++---
.../commons/collections4/map/MultiKeyMap.java | 6 ++--
.../commons/collections4/map/SingletonMap.java | 6 ++--
.../commons/collections4/map/package-info.java | 38 ++++++++++++----------
.../collections4/multimap/package-info.java | 10 +++---
.../collections4/multiset/package-info.java | 10 +++---
.../apache/commons/collections4/package-info.java | 2 +-
.../commons/collections4/queue/package-info.java | 10 +++---
.../commons/collections4/set/package-info.java | 16 +++++----
.../collections4/splitmap/package-info.java | 2 +-
.../collections4/trie/AbstractPatriciaTrie.java | 18 +++++-----
.../commons/collections4/trie/package-info.java | 7 ++--
27 files changed, 202 insertions(+), 183 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 01f289224..3ccd92dac 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -41,6 +41,7 @@
<action type="fix" dev="ggregory" due-to="Gary Gregory" >Fix
SortedProperties.stringPropertyNames() returned an unsorted Set.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory" >Fix
SortedProperties.forEach() called its consumer out of order.</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Apache RAT
plugin console warnings.</action>
+ <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix malformed
Javadoc comments.</action>
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary Gregory">Add generics to
UnmodifiableIterator for the wrapped type.</action>
<action type="add" dev="ggregory" due-to="Gary Gregory">Add a Maven
benchmark profile for JMH.</action>
diff --git a/src/main/java/org/apache/commons/collections4/ClosureUtils.java
b/src/main/java/org/apache/commons/collections4/ClosureUtils.java
index d65472f17..4ad525c4d 100644
--- a/src/main/java/org/apache/commons/collections4/ClosureUtils.java
+++ b/src/main/java/org/apache/commons/collections4/ClosureUtils.java
@@ -35,25 +35,25 @@ import
org.apache.commons.collections4.functors.WhileClosure;
* {@code ClosureUtils} provides reference implementations and utilities
* for the Closure functor interface. The supplied closures are:
* <ul>
- * <li>Invoker - invokes a method on the input object
- * <li>For - repeatedly calls a closure for a fixed number of times
- * <li>While - repeatedly calls a closure while a predicate is true
- * <li>Chained - chains two or more closures together
- * <li>If - calls one closure or another based on a predicate
- * <li>Switch - calls one closure based on one or more predicates
- * <li>SwitchMap - calls one closure looked up from a Map
- * <li>Transformer - wraps a Transformer as a Closure
- * <li>NOP - does nothing
- * <li>Exception - always throws an exception
+ * <li>Invoker - invokes a method on the input object</li>
+ * <li>For - repeatedly calls a closure for a fixed number of times</li>
+ * <li>While - repeatedly calls a closure while a predicate is true</li>
+ * <li>Chained - chains two or more closures together</li>
+ * <li>If - calls one closure or another based on a predicate</li>
+ * <li>Switch - calls one closure based on one or more predicates</li>
+ * <li>SwitchMap - calls one closure looked up from a Map</li>
+ * <li>Transformer - wraps a Transformer as a Closure</li>
+ * <li>NOP - does nothing</li>
+ * <li>Exception - always throws an exception</li>
* </ul>
* <p>
* Since v4.1 only closures which are considered to be safe are
* Serializable. Closures considered to be unsafe for serialization are:
* </p>
* <ul>
- * <li>Invoker
- * <li>For
- * <li>While
+ * <li>Invoker</li>
+ * <li>For</li>
+ * <li>While</li>
* </ul>
*
* @since 3.0
diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
index b782bbf26..d28636ee9 100644
--- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
+++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
@@ -1838,11 +1838,11 @@ public class CollectionUtils {
* This method can handles objects as follows
* </p>
* <ul>
- * <li>Collection - the collection size
- * <li>Map - the map size
- * <li>Array - the array size
- * <li>Iterator - the number of elements remaining in the iterator
- * <li>Enumeration - the number of elements remaining in the enumeration
+ * <li>Collection - the collection size</li>
+ * <li>Map - the map size</li>
+ * <li>Array - the array size</li>
+ * <li>Iterator - the number of elements remaining in the iterator</li>
+ * <li>Enumeration - the number of elements remaining in the
enumeration</li>
* </ul>
*
* @param object the object to get the size of, may be null
@@ -1887,11 +1887,11 @@ public class CollectionUtils {
* This method can handles objects as follows
* </p>
* <ul>
- * <li>Collection - via collection isEmpty
- * <li>Map - via map isEmpty
- * <li>Array - using array size
- * <li>Iterator - via hasNext
- * <li>Enumeration - via hasMoreElements
+ * <li>Collection - via collection isEmpty</li>
+ * <li>Map - via map isEmpty</li>
+ * <li>Array - using array size</li>
+ * <li>Iterator - via hasNext</li>
+ * <li>Enumeration - via hasMoreElements</li>
* </ul>
* <p>
* Note: This method is named to avoid clashing with
diff --git a/src/main/java/org/apache/commons/collections4/FactoryUtils.java
b/src/main/java/org/apache/commons/collections4/FactoryUtils.java
index 74628112e..b80c7faf5 100644
--- a/src/main/java/org/apache/commons/collections4/FactoryUtils.java
+++ b/src/main/java/org/apache/commons/collections4/FactoryUtils.java
@@ -25,19 +25,19 @@ import
org.apache.commons.collections4.functors.PrototypeFactory;
* {@code FactoryUtils} provides reference implementations and utilities
* for the Factory functor interface. The supplied factories are:
* <ul>
- * <li>Prototype - clones a specified object
- * <li>Instantiate - creates objects using reflection
- * <li>Constant - always returns the same object
- * <li>Null - always returns null
- * <li>Exception - always throws an exception
+ * <li>Prototype - clones a specified object</li>
+ * <li>Instantiate - creates objects using reflection</li>
+ * <li>Constant - always returns the same object</li>
+ * <li>Null - always returns null</li>
+ * <li>Exception - always throws an exception</li>
* </ul>
* <p>
* Since v4.1 only factories which are considered to be safe are
* Serializable. Factories considered to be unsafe for serialization are:
* </p>
* <ul>
- * <li>Prototype
- * <li>Instantiate
+ * <li>Prototype</li>
+ * <li>Instantiate</li>
* </ul>
*
* @since 3.0
diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java
b/src/main/java/org/apache/commons/collections4/FluentIterable.java
index 0c2b88743..e58ad1e28 100644
--- a/src/main/java/org/apache/commons/collections4/FluentIterable.java
+++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java
@@ -35,12 +35,11 @@ import
org.apache.commons.collections4.iterators.SingletonIterator;
* </p>
* <ul>
* <li>fluent methods which return a new {@code FluentIterable} instance,
- * providing a view of the original iterable (for example
filter(Predicate));
+ * providing a view of the original iterable (for example
filter(Predicate));</li>
* <li>conversion methods which copy the FluentIterable's contents into a
- * new collection or array (for example toList());
+ * new collection or array (for example toList());</li>
* <li>utility methods which answer questions about the FluentIterable's
- * contents (for example size(), anyMatch(Predicate)).
- * <li>
+ * contents (for example size(), anyMatch(Predicate)).</li>
* </ul>
* <p>
* The following example outputs the first 3 even numbers in the range [1, 10]
@@ -218,8 +217,8 @@ public class FluentIterable<E> implements Iterable<E> {
* Example: natural ordering
* </p>
* <ul>
- * <li>this contains elements [1, 3, 5, 7]
- * <li>other contains elements [2, 4, 6, 8]
+ * <li>this contains elements [1, 3, 5, 7]</li>
+ * <li>other contains elements [2, 4, 6, 8]</li>
* </ul>
* <p>
* The returned iterable will traverse the elements in the following
@@ -243,8 +242,8 @@ public class FluentIterable<E> implements Iterable<E> {
* Example: descending order
* </p>
* <ul>
- * <li>this contains elements [7, 5, 3, 1]
- * <li>other contains elements [8, 6, 4, 2]
+ * <li>this contains elements [7, 5, 3, 1]</li>
+ * <li>other contains elements [8, 6, 4, 2]</li>
* </ul>
* <p>
* The returned iterable will traverse the elements in the following
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java
b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index 0a2e1d224..d36a1317a 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -39,10 +39,10 @@ import
org.apache.commons.collections4.iterators.UniqueFilterIterator;
* </p>
* <ul>
* <li>All decorator methods are <em>not</em> null-safe for the provided
Iterable argument; for example, they will throw a {@link NullPointerException}
if a
- * null Iterable is passed as argument.
+ * null Iterable is passed as argument.</li>
* <li>All other utility methods are null-safe for the provided Iterable
argument; for example, they will treat a null Iterable the same way as an empty
one.
* For other arguments which are null, a {@link Predicate} will result in a
{@link NullPointerException}. Exception: passing a null {@link Comparator} is
- * equivalent to a Comparator with natural ordering.
+ * equivalent to a Comparator with natural ordering.</li>
* </ul>
*
* @since 4.1
diff --git a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
index ac11f21ab..41858a7af 100644
--- a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
@@ -866,17 +866,17 @@ public class IteratorUtils {
* This method can handle objects as follows
* </p>
* <ul>
- * <li>null - empty iterator
- * <li>Iterator - returned directly
- * <li>Enumeration - wrapped
- * <li>Collection - iterator from collection returned
- * <li>Map - values iterator returned
- * <li>Dictionary - values (elements) enumeration returned as iterator
- * <li>array - iterator over array returned
- * <li>object with iterator() public method accessed by reflection
- * <li>object - singleton iterator
- * <li>NodeList - iterator over the list
- * <li>Node - iterator over the child nodes
+ * <li>null - empty iterator</li>
+ * <li>Iterator - returned directly</li>
+ * <li>Enumeration - wrapped</li>
+ * <li>Collection - iterator from collection returned</li>
+ * <li>Map - values iterator returned</li>
+ * <li>Dictionary - values (elements) enumeration returned as iterator</li>
+ * <li>array - iterator over array returned</li>
+ * <li>object with iterator() public method accessed by reflection</li>
+ * <li>object - singleton iterator</li>
+ * <li>NodeList - iterator over the list</li>
+ * <li>Node - iterator over the child nodes</li>
* </ul>
*
* @param obj the object to convert to an iterator
diff --git a/src/main/java/org/apache/commons/collections4/MapUtils.java
b/src/main/java/org/apache/commons/collections4/MapUtils.java
index 2f52dd9ba..800199dfe 100644
--- a/src/main/java/org/apache/commons/collections4/MapUtils.java
+++ b/src/main/java/org/apache/commons/collections4/MapUtils.java
@@ -60,19 +60,19 @@ import
org.apache.commons.collections4.map.UnmodifiableSortedMap;
* </p>
*
* <ul>
- * <li>{@link #fixedSizeMap(Map)}
- * <li>{@link #fixedSizeSortedMap(SortedMap)}
- * <li>{@link #lazyMap(Map,Factory)}
- * <li>{@link #lazyMap(Map,Transformer)}
- * <li>{@link #lazySortedMap(SortedMap,Factory)}
- * <li>{@link #lazySortedMap(SortedMap,Transformer)}
- * <li>{@link #predicatedMap(Map,Predicate,Predicate)}
- * <li>{@link #predicatedSortedMap(SortedMap,Predicate,Predicate)}
- * <li>{@link #transformedMap(Map, Transformer, Transformer)}
- * <li>{@link #transformedSortedMap(SortedMap, Transformer, Transformer)}
- * <li>{@link #multiValueMap(Map)}
- * <li>{@link #multiValueMap(Map, Class)}
- * <li>{@link #multiValueMap(Map, Factory)}
+ * <li>{@link #fixedSizeMap(Map)}</li>
+ * <li>{@link #fixedSizeSortedMap(SortedMap)}</li>
+ * <li>{@link #lazyMap(Map,Factory)}</li>
+ * <li>{@link #lazyMap(Map,Transformer)}</li>
+ * <li>{@link #lazySortedMap(SortedMap,Factory)}</li>
+ * <li>{@link #lazySortedMap(SortedMap,Transformer)}</li>
+ * <li>{@link #predicatedMap(Map,Predicate,Predicate)}</li>
+ * <li>{@link #predicatedSortedMap(SortedMap,Predicate,Predicate)}</li>
+ * <li>{@link #transformedMap(Map, Transformer, Transformer)}</li>
+ * <li>{@link #transformedSortedMap(SortedMap, Transformer, Transformer)}</li>
+ * <li>{@link #multiValueMap(Map)}</li>
+ * <li>{@link #multiValueMap(Map, Class)}</li>
+ * <li>{@link #multiValueMap(Map, Factory)}</li>
* </ul>
*
* @since 1.0
diff --git a/src/main/java/org/apache/commons/collections4/PredicateUtils.java
b/src/main/java/org/apache/commons/collections4/PredicateUtils.java
index bce080858..0229f0503 100644
--- a/src/main/java/org/apache/commons/collections4/PredicateUtils.java
+++ b/src/main/java/org/apache/commons/collections4/PredicateUtils.java
@@ -45,24 +45,24 @@ import
org.apache.commons.collections4.functors.UniquePredicate;
* {@code PredicateUtils} provides reference implementations and utilities
* for the Predicate functor interface. The supplied predicates are:
* <ul>
- * <li>Invoker - returns the result of a method call on the input object
- * <li>InstanceOf - true if the object is an instanceof a class
- * <li>Equal - true if the object equals() a specified object
- * <li>Identity - true if the object == a specified object
- * <li>Null - true if the object is null
- * <li>NotNull - true if the object is not null
- * <li>Unique - true if the object has not already been evaluated
- * <li>And/All - true if all of the predicates are true
- * <li>Or/Any - true if any of the predicates is true
- * <li>Either/One - true if only one of the predicate is true
- * <li>Neither/None - true if none of the predicates are true
- * <li>Not - true if the predicate is false, and vice versa
- * <li>Transformer - wraps a Transformer as a Predicate
- * <li>True - always return true
- * <li>False - always return false
- * <li>Exception - always throws an exception
- * <li>NullIsException/NullIsFalse/NullIsTrue - check for null input
- * <li>Transformed - transforms the input before calling the predicate
+ * <li>Invoker - returns the result of a method call on the input object</li>
+ * <li>InstanceOf - true if the object is an instanceof a class</li>
+ * <li>Equal - true if the object equals() a specified object</li>
+ * <li>Identity - true if the object == a specified object</li>
+ * <li>Null - true if the object is null</li>
+ * <li>NotNull - true if the object is not null</li>
+ * <li>Unique - true if the object has not already been evaluated</li>
+ * <li>And/All - true if all of the predicates are true</li>
+ * <li>Or/Any - true if any of the predicates is true</li>
+ * <li>Either/One - true if only one of the predicate is true</li>
+ * <li>Neither/None - true if none of the predicates are true</li>
+ * <li>Not - true if the predicate is false, and vice versa</li>
+ * <li>Transformer - wraps a Transformer as a Predicate</li>
+ * <li>True - always return true</li>
+ * <li>False - always return false</li>
+ * <li>Exception - always throws an exception</li>
+ * <li>NullIsException/NullIsFalse/NullIsTrue - check for null input</li>
+ * <li>Transformed - transforms the input before calling the predicate</li>
* </ul>
* <p>
* All the supplied predicates are Serializable.
diff --git
a/src/main/java/org/apache/commons/collections4/TransformerUtils.java
b/src/main/java/org/apache/commons/collections4/TransformerUtils.java
index 9fd16482a..3b1bdceab 100644
--- a/src/main/java/org/apache/commons/collections4/TransformerUtils.java
+++ b/src/main/java/org/apache/commons/collections4/TransformerUtils.java
@@ -40,31 +40,31 @@ import
org.apache.commons.collections4.functors.SwitchTransformer;
* {@code TransformerUtils} provides reference implementations and
* utilities for the Transformer functor interface. The supplied transformers
are:
* <ul>
- * <li>Invoker - returns the result of a method call on the input object
- * <li>Clone - returns a clone of the input object
- * <li>Constant - always returns the same object
- * <li>Closure - performs a Closure and returns the input object
- * <li>Predicate - returns the result of the predicate as a Boolean
- * <li>Factory - returns a new object from a factory
- * <li>Chained - chains two or more transformers together
- * <li>If - calls one transformer or another based on a predicate
- * <li>Switch - calls one transformer based on one or more predicates
- * <li>SwitchMap - calls one transformer looked up from a Map
- * <li>Instantiate - the Class input object is instantiated
- * <li>Map - returns an object from a supplied Map
- * <li>Null - always returns null
- * <li>NOP - returns the input object, which should be immutable
- * <li>Exception - always throws an exception
- * <li>StringValue - returns a {@link String} representation of the input
object
+ * <li>Invoker - returns the result of a method call on the input object</li>
+ * <li>Clone - returns a clone of the input object</li>
+ * <li>Constant - always returns the same object</li>
+ * <li>Closure - performs a Closure and returns the input object</li>
+ * <li>Predicate - returns the result of the predicate as a Boolean</li>
+ * <li>Factory - returns a new object from a factory</li>
+ * <li>Chained - chains two or more transformers together</li>
+ * <li>If - calls one transformer or another based on a predicate</li>
+ * <li>Switch - calls one transformer based on one or more predicates</li>
+ * <li>SwitchMap - calls one transformer looked up from a Map</li>
+ * <li>Instantiate - the Class input object is instantiated</li>
+ * <li>Map - returns an object from a supplied Map</li>
+ * <li>Null - always returns null</li>
+ * <li>NOP - returns the input object, which should be immutable</li>
+ * <li>Exception - always throws an exception</li>
+ * <li>StringValue - returns a {@link String} representation of the input
object</li>
* </ul>
* <p>
* Since v4.1 only transformers which are considered to be safe are
* Serializable. Transformers considered to be unsafe for serialization are:
* </p>
* <ul>
- * <li>Invoker
- * <li>Clone
- * <li>Instantiate
+ * <li>Invoker</li>
+ * <li>Clone</li>
+ * <li>Instantiate</li>
* </ul>
*
* @since 3.0
diff --git
a/src/main/java/org/apache/commons/collections4/bag/package-info.java
b/src/main/java/org/apache/commons/collections4/bag/package-info.java
index d28e0b197..cb8284af7 100644
--- a/src/main/java/org/apache/commons/collections4/bag/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/bag/package-info.java
@@ -23,18 +23,18 @@
* The following implementations are provided in the package:
* </p>
* <ul>
- * <li>HashBag - implementation that uses a HashMap to store the data
- * <li>TreeBag - implementation that uses a TreeMap to store the data
+ * <li>HashBag - implementation that uses a HashMap to store the data</li>
+ * <li>TreeBag - implementation that uses a TreeMap to store the data</li>
* </ul>
* <p>
* The following decorators are provided in the package:
* </p>
* <ul>
- * <li>Synchronized - synchronizes method access for multithreaded
environments
- * <li>Unmodifiable - ensures the bag cannot be altered
- * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added
- * <li>Transformed - transforms each element added to the bag
- * <li>Collection - ensures compliance with the java.util.Collection contract
+ * <li>Synchronized - synchronizes method access for multithreaded
environments</li>
+ * <li>Unmodifiable - ensures the bag cannot be altered</li>
+ * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added</li>
+ * <li>Transformed - transforms each element added to the bag</li>
+ * <li>Collection - ensures compliance with the java.util.Collection
contract</li>
* </ul>
*/
package org.apache.commons.collections4.bag;
diff --git
a/src/main/java/org/apache/commons/collections4/bidimap/package-info.java
b/src/main/java/org/apache/commons/collections4/bidimap/package-info.java
index 28983f281..3b447054a 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/package-info.java
@@ -27,16 +27,16 @@
* The following implementations are provided in the package:
* </p>
* <ul>
- * <li>DualHashBidiMap - uses two HashMaps to implement BidiMap
- * <li>DualLinkedHashBidiMap - uses two LinkedHashMaps to implement BidiMap
- * <li>DualTreeBidiMap - uses two TreeMaps to implement SortedBidiMap
- * <li>TreeBidiMap - red-black tree implementation of OrderedBidiMap
+ * <li>DualHashBidiMap - uses two HashMaps to implement BidiMap</li>
+ * <li>DualLinkedHashBidiMap - uses two LinkedHashMaps to implement
BidiMap</li>
+ * <li>DualTreeBidiMap - uses two TreeMaps to implement SortedBidiMap</li>
+ * <li>TreeBidiMap - red-black tree implementation of OrderedBidiMap</li>
* </ul>
* <p>
* The following decorators are provided in the package:
* </p>
* <ul>
- * <li>Unmodifiable - ensures the map cannot be altered
+ * <li>Unmodifiable - ensures the map cannot be altered</li>
* </ul>
*/
package org.apache.commons.collections4.bidimap;
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java
index b47b9a462..5d0531c50 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java
@@ -45,7 +45,7 @@ import java.util.function.Predicate;
* <ul>
* <li>Level 0 is the oldest layer and the highest level is the newest.</li>
* <li>There is always at least one enclosed filter.</li>
- * <li>The newest filter is the {@code target} into which merges are performed.
+ * <li>The newest filter is the {@code target} into which merges are
performed.</li>
* <li>Whenever the target is retrieved, or a {@code merge} operation is
performed the code checks if any older layers should be removed, and if so
removes
* them. It also checks it a new layer should be added, and if so adds it and
sets the {@code target} before the operation.</li>
* </ul>
diff --git
a/src/main/java/org/apache/commons/collections4/collection/package-info.java
b/src/main/java/org/apache/commons/collections4/collection/package-info.java
index 912a520b1..6958e97e2 100644
--- a/src/main/java/org/apache/commons/collections4/collection/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/collection/package-info.java
@@ -20,16 +20,19 @@
* {@link java.util.Collection Collection} interface.
* <p>
* The following implementations are provided in the package:
+ * </p>
* <ul>
- * <li>CompositeCollection - a collection that combines multiple collections
into one
+ * <li>CompositeCollection - a collection that combines multiple collections
into one</li>
* </ul>
+ * <p>
* The following decorators are provided in the package:
+ * </p>
* <ul>
- * <li>Synchronized - synchronizes method access for multithreaded
environments
- * <li>Unmodifiable - ensures the collection cannot be altered
- * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added
- * <li>Transformed - transforms elements as they are added
- * <li>Indexed - provides a map-like view onto another collection
+ * <li>Synchronized - synchronizes method access for multithreaded
environments</li>
+ * <li>Unmodifiable - ensures the collection cannot be altered</li>
+ * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added</li>
+ * <li>Transformed - transforms elements as they are added</li>
+ * <li>Indexed - provides a map-like view onto another collection</li>
* </ul>
*/
package org.apache.commons.collections4.collection;
diff --git
a/src/main/java/org/apache/commons/collections4/keyvalue/package-info.java
b/src/main/java/org/apache/commons/collections4/keyvalue/package-info.java
index f6f305feb..4a1b20446 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/package-info.java
@@ -20,10 +20,11 @@
* These are usually used in maps, however they can be used as data holders in
any collection.
* <p>
* The following key/value designs are included:
+ * </p>
* <ul>
- * <li>Map Entry - various map entry implementations
- * <li>KeyValue - a key and value pair, without map entry semantics
- * <li>MultiKey - a holder of multiple keys tied together
+ * <li>Map Entry - various map entry implementations</li>
+ * <li>KeyValue - a key and value pair, without map entry semantics</li>
+ * <li>MultiKey - a holder of multiple keys tied together</li>
* </ul>
*/
package org.apache.commons.collections4.keyvalue;
diff --git a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java
b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java
index f9d7dbaec..ec679989e 100644
--- a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java
+++ b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java
@@ -44,11 +44,11 @@ import
org.apache.commons.collections4.iterators.EmptyMapIterator;
* It also has good garbage collection characteristics.
* </p>
* <ul>
- * <li>Optimized for operation at size 3 or less.
- * <li>Still works well once size 3 exceeded.
- * <li>Gets at size 3 or less are about 0-10% faster than HashMap,
- * <li>Puts at size 3 or less are over 4 times faster than HashMap.
- * <li>Performance 5% slower than HashMap once size 3 exceeded once.
+ * <li>Optimized for operation at size 3 or less.</li>
+ * <li>Still works well once size 3 exceeded.</li>
+ * <li>Gets at size 3 or less are about 0-10% faster than HashMap,</li>
+ * <li>Puts at size 3 or less are over 4 times faster than HashMap.</li>
+ * <li>Performance 5% slower than HashMap once size 3 exceeded once.</li>
* </ul>
* <p>
* The design uses two distinct modes of operation - flat and delegate.
diff --git a/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java
b/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java
index 7bb9e50f8..0882943fd 100644
--- a/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/MultiKeyMap.java
@@ -50,9 +50,9 @@ import
org.apache.commons.collections4.map.AbstractHashedMap.HashEntry;
* enables extra behavior to be added easily.
* </p>
* <ul>
- * <li>{@code MultiKeyMap.decorate(new LinkedMap())} creates an ordered map.
- * <li>{@code MultiKeyMap.decorate(new LRUMap())} creates an least recently
used map.
- * <li>{@code MultiKeyMap.decorate(new ReferenceMap())} creates a garbage
collector sensitive map.
+ * <li>{@code MultiKeyMap.decorate(new LinkedMap())} creates an ordered
map.</li>
+ * <li>{@code MultiKeyMap.decorate(new LRUMap())} creates an least recently
used map.</li>
+ * <li>{@code MultiKeyMap.decorate(new ReferenceMap())} creates a garbage
collector sensitive map.</li>
* </ul>
* <p>
* Note that {@code IdentityMap} and {@code ReferenceIdentityMap} are
unsuitable
diff --git
a/src/main/java/org/apache/commons/collections4/map/SingletonMap.java
b/src/main/java/org/apache/commons/collections4/map/SingletonMap.java
index dff5a199b..b70367ca0 100644
--- a/src/main/java/org/apache/commons/collections4/map/SingletonMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/SingletonMap.java
@@ -52,9 +52,9 @@ import org.apache.commons.collections4.keyvalue.TiedMapEntry;
* The key and value can be obtained by:
* </p>
* <ul>
- * <li>normal Map methods and views
- * <li>the {@code MapIterator}, see {@link #mapIterator()}
- * <li>the {@code KeyValue} interface (just cast - no object creation)
+ * <li>normal Map methods and views</li>
+ * <li>the {@code MapIterator}, see {@link #mapIterator()}</li>
+ * <li>the {@code KeyValue} interface (just cast - no object creation)</li>
* </ul>
*
* @param <K> the type of the keys in this map
diff --git
a/src/main/java/org/apache/commons/collections4/map/package-info.java
b/src/main/java/org/apache/commons/collections4/map/package-info.java
index 84364141c..c70baf091 100644
--- a/src/main/java/org/apache/commons/collections4/map/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/map/package-info.java
@@ -25,29 +25,31 @@
* simple iteration of map keys and values.
* <p>
* The following implementations are provided:
+ * </p>
* <ul>
- * <li>CaseInsensitiveMap - map that compares keys in a case insensitive way
- * <li>CompositeMap - map that combines multiple maps into a single view
- * <li>HashedMap - general purpose HashMap replacement supporting MapIterator
- * <li>Flat3Map - designed for good performance at size 3 or less
- * <li>LinkedMap - a hash map that maintains insertion order, supporting
OrderedMapIterator
- * <li>LRUMap - a hash map that maintains a maximum size by removing the
least recently used entries
- * <li>MultiKeyMap - map that provides special methods for using more than
one key to access the value
- * <li>ReferenceMap - allows the garbage collector to collect keys and
values using equals() for comparison
- * <li>ReferenceIdentityMap - allows the garbage collector to collect keys
and values using == for comparison
- * <li>SingletonMap - a fully featured map to hold one key-value pair
- * <li>StaticBucketMap - internally synchronized and designed for
thread-contentious environments
+ * <li>CaseInsensitiveMap - map that compares keys in a case insensitive
way</li>
+ * <li>CompositeMap - map that combines multiple maps into a single view</li>
+ * <li>HashedMap - general purpose HashMap replacement supporting
MapIterator</li>
+ * <li>Flat3Map - designed for good performance at size 3 or less</li>
+ * <li>LinkedMap - a hash map that maintains insertion order, supporting
OrderedMapIterator</li>
+ * <li>LRUMap - a hash map that maintains a maximum size by removing the
least recently used entries</li>
+ * <li>MultiKeyMap - map that provides special methods for using more than
one key to access the value</li>
+ * <li>ReferenceMap - allows the garbage collector to collect keys and
values using equals() for comparison</li>
+ * <li>ReferenceIdentityMap - allows the garbage collector to collect keys
and values using == for comparison</li>
+ * <li>SingletonMap - a fully featured map to hold one key-value pair</li>
+ * <li>StaticBucketMap - internally synchronized and designed for
thread-contentious environments</li>
* </ul>
* <p>
* The following decorators are provided:
+ * </p>
* <ul>
- * <li>Unmodifiable - ensures the collection cannot be altered
- * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added
- * <li>Transformed - transforms each element added
- * <li>FixedSize - ensures that the size of the map cannot change
- * <li>Defaulted - provides default values for non-existing keys
- * <li>Lazy - creates objects in the map on demand
- * <li>ListOrdered - ensures that insertion order is retained
+ * <li>Unmodifiable - ensures the collection cannot be altered</li>
+ * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added</li>
+ * <li>Transformed - transforms each element added</li>
+ * <li>FixedSize - ensures that the size of the map cannot change</li>
+ * <li>Defaulted - provides default values for non-existing keys</li>
+ * <li>Lazy - creates objects in the map on demand</li>
+ * <li>ListOrdered - ensures that insertion order is retained</li>
* </ul>
*/
package org.apache.commons.collections4.map;
diff --git
a/src/main/java/org/apache/commons/collections4/multimap/package-info.java
b/src/main/java/org/apache/commons/collections4/multimap/package-info.java
index 85cb3686c..493663507 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/package-info.java
@@ -20,15 +20,17 @@
* A MultiValuedMap holds a collection of values against each key.
* <p>
* The following implementations are provided in the package:
+ * </p>
* <ul>
- * <li>ArrayListValuedHashMap - ListValuedMap implementation using a
HashMap/ArrayList
- * <li>HashSetValuedHashMap - SetValuedMap implementation using a
HashMap/HashSet
+ * <li>ArrayListValuedHashMap - ListValuedMap implementation using a
HashMap/ArrayList</li>
+ * <li>HashSetValuedHashMap - SetValuedMap implementation using a
HashMap/HashSet</li>
* </ul>
* <p>
* The following decorators are provided in the package:
+ * </p>
* <ul>
- * <li>Transformed - transforms elements added to the MultiValuedMap
- * <li>Unmodifiable - ensures the collection cannot be altered
+ * <li>Transformed - transforms elements added to the MultiValuedMap</li>
+ * <li>Unmodifiable - ensures the collection cannot be altered</li>
* </ul>
*/
package org.apache.commons.collections4.multimap;
diff --git
a/src/main/java/org/apache/commons/collections4/multiset/package-info.java
b/src/main/java/org/apache/commons/collections4/multiset/package-info.java
index 58c1b4cd6..5b8486f54 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/package-info.java
@@ -21,15 +21,17 @@
* A multiset stores an object and a count of the number of occurrences of the
object.
* <p>
* The following implementations are provided in the package:
+ * </p>
* <ul>
- * <li>HashMultiSet - implementation that uses a HashMap to store the data
+ * <li>HashMultiSet - implementation that uses a HashMap to store the
data</li>
* </ul>
* <p>
* The following decorators are provided in the package:
+ * </p>
* <ul>
- * <li>Predicated - ensures that only elements that are valid according to
a predicate can be added
- * <li>Synchronized - synchronizes method access for multithreaded
environments
- * <li>Unmodifiable - ensures the multiset cannot be altered
+ * <li>Predicated - ensures that only elements that are valid according to
a predicate can be added</li>
+ * <li>Synchronized - synchronizes method access for multithreaded
environments</li>
+ * <li>Unmodifiable - ensures the multiset cannot be altered</li>
* </ul>
*/
package org.apache.commons.collections4.multiset;
diff --git a/src/main/java/org/apache/commons/collections4/package-info.java
b/src/main/java/org/apache/commons/collections4/package-info.java
index ef1e29105..7e45d2360 100644
--- a/src/main/java/org/apache/commons/collections4/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/package-info.java
@@ -21,7 +21,7 @@
* The following collection implementations are provided in the package:
* </p>
* <ul>
- * <li>ArrayStack - a non synchronized Stack that follows the same API as
{@code java.util Stack}
+ * <li>ArrayStack - a non synchronized Stack that follows the same API as
{@code java.util Stack}</li>
* </ul>
*/
package org.apache.commons.collections4;
diff --git
a/src/main/java/org/apache/commons/collections4/queue/package-info.java
b/src/main/java/org/apache/commons/collections4/queue/package-info.java
index 5c8af6316..a5ecac477 100644
--- a/src/main/java/org/apache/commons/collections4/queue/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/queue/package-info.java
@@ -19,15 +19,17 @@
* Implements the {@link java.util.Queue Queue} interface.
* <p>
* The following implementations are provided in the package:
+ * </p>
* <ul>
- * <li>CircularFifoQueue - implements a queue with a fixed size that
discards oldest when full
+ * <li>CircularFifoQueue - implements a queue with a fixed size that
discards oldest when full</li>
* </ul>
* <p>
* The following decorators are provided in the package:
+ * </p>
* <ul>
- * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added
- * <li>Transformed - transforms elements added to the queue
- * <li>Unmodifiable - ensures the collection cannot be altered
+ * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added</li>
+ * <li>Transformed - transforms elements added to the queue</li>
+ * <li>Unmodifiable - ensures the collection cannot be altered</li>
* </ul>
*/
package org.apache.commons.collections4.queue;
diff --git
a/src/main/java/org/apache/commons/collections4/set/package-info.java
b/src/main/java/org/apache/commons/collections4/set/package-info.java
index 644833505..25a8a31b3 100644
--- a/src/main/java/org/apache/commons/collections4/set/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/set/package-info.java
@@ -23,18 +23,22 @@
* The implementations are in the form of direct implementations and
decorators.
* A decorator wraps another implementation of the interface to add some
* specific additional functionality.
+ * </p>
* <p>
* The following implementations are provided in the package:
+ * </p>
* <ul>
- * <li>CompositeSet - a set that combines multiple sets into one
+ * <li>CompositeSet - a set that combines multiple sets into one</li>
* </ul>
+ * <p>
* The following decorators are provided in the package:
+ * </p>
* <ul>
- * <li>Unmodifiable - ensures the collection cannot be altered
- * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added
- * <li>Transformed - transforms each element added
- * <li>ListOrdered - ensures that insertion order is retained
- * <li>MapBackedSet - a set formed by decorating a Map
+ * <li>Unmodifiable - ensures the collection cannot be altered</li>
+ * <li>Predicated - ensures that only elements that are valid according to a
predicate can be added</li>
+ * <li>Transformed - transforms each element added</li>
+ * <li>ListOrdered - ensures that insertion order is retained</li>
+ * <li>MapBackedSet - a set formed by decorating a Map</li>
* </ul>
*/
package org.apache.commons.collections4.set;
diff --git
a/src/main/java/org/apache/commons/collections4/splitmap/package-info.java
b/src/main/java/org/apache/commons/collections4/splitmap/package-info.java
index e8ca8445f..6b4bbc1be 100644
--- a/src/main/java/org/apache/commons/collections4/splitmap/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/splitmap/package-info.java
@@ -32,7 +32,7 @@
* <p>
* The following decorators are provided:
* <ul>
- * <li>Transformed - transforms each element added
+ * <li>Transformed - transforms each element added</li>
* </ul>
*/
package org.apache.commons.collections4.splitmap;
diff --git
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
index eead2e723..906d3c620 100644
---
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -2259,9 +2259,9 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
* For example, given the keys:
*
* <ol>
- * <li>D = 1000100
- * <li>H = 1001000
- * <li>L = 1001100
+ * <li>D = 1000100</li>
+ * <li>H = 1001000</li>
+ * <li>L = 1001100</li>
* </ol>
*
* If the {@link org.apache.commons.collections4.Trie} contained 'H' and
'L', a lookup of 'D' would
@@ -2288,9 +2288,9 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
* For example, given the keys:
*
* <ol>
- * <li>D = 1000100
- * <li>H = 1001000
- * <li>L = 1001100
+ * <li>D = 1000100</li>
+ * <li>H = 1001000</li>
+ * <li>L = 1001100</li>
* </ol>
*
* If the {@link org.apache.commons.collections4.Trie} contained 'H' and
'L', a lookup of 'D' would
@@ -2340,9 +2340,9 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
* For example, given the keys:
*
* <ol>
- * <li>D = 1000100
- * <li>H = 1001000
- * <li>L = 1001100
+ * <li>D = 1000100</li>
+ * <li>H = 1001000</li>
+ * <li>L = 1001100</li>
* </ol>
*
* If the {@link org.apache.commons.collections4.Trie} contained 'H' and
'L', a lookup of 'D' would
diff --git
a/src/main/java/org/apache/commons/collections4/trie/package-info.java
b/src/main/java/org/apache/commons/collections4/trie/package-info.java
index 293c3074a..04d203d0f 100644
--- a/src/main/java/org/apache/commons/collections4/trie/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/trie/package-info.java
@@ -22,15 +22,18 @@
* The implementations are in the form of direct implementations and
decorators.
* A decorator wraps another implementation of the interface to add some
* specific additional functionality.
+ * </p>
* <p>
* The following implementations are provided in the package:
+ * </p>
* <ul>
- * <li>PatriciaTrie - an implementation of a PATRICIA trie
+ * <li>PatriciaTrie - an implementation of a PATRICIA trie</li>
* </ul>
* <p>
* The following decorators are provided:
+ * </p>
* <ul>
- * <li>Unmodifiable - ensures the collection cannot be altered
+ * <li>Unmodifiable - ensures the collection cannot be altered</li>
* </ul>
*/
package org.apache.commons.collections4.trie;
