You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/11/15 15:11:58 UTC
(commons-collections) branch master updated (70c7a2acc -> 95673e47c)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
from 70c7a2acc Bump github/codeql-action from 3.27.0 to 3.27.4
new 45cd71153 [COLLECTIONS-857] Update documentation to match bloomfilter implementation
new 95673e47c Javadoc: Use semantic tag <strong> instead of style tag <b>
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/main/java/org/apache/commons/collections4/ArrayStack.java | 2 +-
.../java/org/apache/commons/collections4/CollectionUtils.java | 8 ++++----
.../java/org/apache/commons/collections4/IterableUtils.java | 6 +++---
src/main/java/org/apache/commons/collections4/ListUtils.java | 4 ++--
.../java/org/apache/commons/collections4/ListValuedMap.java | 2 +-
.../java/org/apache/commons/collections4/MultiValuedMap.java | 2 +-
src/main/java/org/apache/commons/collections4/SetUtils.java | 10 +++++-----
.../org/apache/commons/collections4/bag/CollectionBag.java | 4 ++--
.../apache/commons/collections4/bloomfilter/package-info.java | 4 ++--
.../collections4/collection/AbstractCollectionDecorator.java | 2 +-
.../commons/collections4/comparators/ReverseComparator.java | 2 +-
.../apache/commons/collections4/functors/CloneTransformer.java | 2 +-
.../commons/collections4/functors/ComparatorPredicate.java | 2 +-
.../org/apache/commons/collections4/functors/ForClosure.java | 2 +-
.../commons/collections4/functors/InstantiateFactory.java | 2 +-
.../commons/collections4/functors/InstantiateTransformer.java | 2 +-
.../commons/collections4/functors/InvokerTransformer.java | 2 +-
.../apache/commons/collections4/functors/PrototypeFactory.java | 4 ++--
.../org/apache/commons/collections4/functors/WhileClosure.java | 2 +-
.../org/apache/commons/collections4/functors/package-info.java | 2 +-
.../commons/collections4/iterators/ArrayListIterator.java | 2 +-
.../commons/collections4/iterators/LazyIteratorChain.java | 2 +-
.../collections4/iterators/ObjectArrayListIterator.java | 2 +-
.../org/apache/commons/collections4/keyvalue/MultiKey.java | 2 +-
.../apache/commons/collections4/list/CursorableLinkedList.java | 8 ++++----
.../commons/collections4/list/NodeCachingLinkedList.java | 2 +-
.../org/apache/commons/collections4/map/StaticBucketMap.java | 4 ++--
.../commons/collections4/multimap/AbstractMultiValuedMap.java | 4 ++--
.../commons/collections4/multiset/AbstractMapMultiSet.java | 2 +-
.../org/apache/commons/collections4/bag/AbstractBagTest.java | 2 +-
.../collections4/collection/AbstractCollectionTest.java | 10 +++++-----
.../org/apache/commons/collections4/map/AbstractMapTest.java | 10 +++++-----
32 files changed, 58 insertions(+), 58 deletions(-)
(commons-collections) 02/02: Javadoc: Use semantic tag instead of style tag
Posted by gg...@apache.org.
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
commit 95673e47cefd2d01e073369616c969c19a282176
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Nov 15 10:11:52 2024 -0500
Javadoc: Use semantic tag <strong> instead of style tag <b>
---
src/main/java/org/apache/commons/collections4/ArrayStack.java | 2 +-
.../java/org/apache/commons/collections4/CollectionUtils.java | 8 ++++----
.../java/org/apache/commons/collections4/IterableUtils.java | 6 +++---
src/main/java/org/apache/commons/collections4/ListUtils.java | 4 ++--
.../java/org/apache/commons/collections4/ListValuedMap.java | 2 +-
.../java/org/apache/commons/collections4/MultiValuedMap.java | 2 +-
src/main/java/org/apache/commons/collections4/SetUtils.java | 10 +++++-----
.../org/apache/commons/collections4/bag/CollectionBag.java | 4 ++--
.../collections4/collection/AbstractCollectionDecorator.java | 2 +-
.../commons/collections4/comparators/ReverseComparator.java | 2 +-
.../apache/commons/collections4/functors/CloneTransformer.java | 2 +-
.../commons/collections4/functors/ComparatorPredicate.java | 2 +-
.../org/apache/commons/collections4/functors/ForClosure.java | 2 +-
.../commons/collections4/functors/InstantiateFactory.java | 2 +-
.../commons/collections4/functors/InstantiateTransformer.java | 2 +-
.../commons/collections4/functors/InvokerTransformer.java | 2 +-
.../apache/commons/collections4/functors/PrototypeFactory.java | 4 ++--
.../org/apache/commons/collections4/functors/WhileClosure.java | 2 +-
.../org/apache/commons/collections4/functors/package-info.java | 2 +-
.../commons/collections4/iterators/ArrayListIterator.java | 2 +-
.../commons/collections4/iterators/LazyIteratorChain.java | 2 +-
.../collections4/iterators/ObjectArrayListIterator.java | 2 +-
.../org/apache/commons/collections4/keyvalue/MultiKey.java | 2 +-
.../apache/commons/collections4/list/CursorableLinkedList.java | 8 ++++----
.../commons/collections4/list/NodeCachingLinkedList.java | 2 +-
.../org/apache/commons/collections4/map/StaticBucketMap.java | 4 ++--
.../commons/collections4/multimap/AbstractMultiValuedMap.java | 4 ++--
.../commons/collections4/multiset/AbstractMapMultiSet.java | 2 +-
.../org/apache/commons/collections4/bag/AbstractBagTest.java | 2 +-
.../collections4/collection/AbstractCollectionTest.java | 10 +++++-----
.../org/apache/commons/collections4/map/AbstractMapTest.java | 10 +++++-----
31 files changed, 56 insertions(+), 56 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/ArrayStack.java b/src/main/java/org/apache/commons/collections4/ArrayStack.java
index 26831efeb..4f21ea0cd 100644
--- a/src/main/java/org/apache/commons/collections4/ArrayStack.java
+++ b/src/main/java/org/apache/commons/collections4/ArrayStack.java
@@ -34,7 +34,7 @@ import java.util.EmptyStackException;
* <p>
* Unlike {@code Stack}, {@code ArrayStack} accepts null entries.
* <p>
- * <b>Note:</b> From version 4.0 onwards, this class does not implement the
+ * <strong>Note:</strong> From version 4.0 onwards, this class does not implement the
* removed {@code Buffer} interface anymore.
* </p>
*
diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
index 1d13ec116..469b1b922 100644
--- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
+++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
@@ -1214,7 +1214,7 @@ public class CollectionUtils {
* for each element <em>e</em> in <em>a</em> or <em>b</em>.
* </p>
* <p>
- * <b>Note:</b> from version 4.1 onwards this method requires the input
+ * <strong>Note:</strong> from version 4.1 onwards this method requires the input
* collections and equator to be of compatible type (using bounded wildcards).
* Providing incompatible arguments (e.g. by casting to their rawtypes)
* will result in a {@code ClassCastException} thrown at runtime.
@@ -1404,7 +1404,7 @@ public class CollectionUtils {
* <p>
* NOTE: the number of permutations of a given collection is equal to n!, where
* n is the size of the collection. Thus, the resulting collection will become
- * <b>very</b> large for collections > 10 (e.g. 10! = 3628800, 15! = 1307674368000).
+ * <strong>very</strong> large for collections > 10 (e.g. 10! = 3628800, 15! = 1307674368000).
* </p>
* <p>
* For larger collections it is advised to use a {@link PermutationIterator} to
@@ -1792,7 +1792,7 @@ public class CollectionUtils {
* @param <O> the type of object the {@link Iterable} contains
* @param inputCollection the collection to get the input from, may not be null
* @param predicate the predicate to use, may be null
- * @return the elements <b>not</b> matching the predicate (new list)
+ * @return the elements <strong>not</strong> matching the predicate (new list)
*/
public static <O> Collection<O> selectRejected(final Iterable<? extends O> inputCollection,
final Predicate<? super O> predicate) {
@@ -1962,7 +1962,7 @@ public class CollectionUtils {
* minus the cardinality of <em>e</em> in <em>b</em>, or zero, whichever is greater.
* </p>
* <p>
- * The cardinality of each element <em>e</em> in the returned {@link Collection} that does <b>not</b>
+ * The cardinality of each element <em>e</em> in the returned {@link Collection} that does <strong>not</strong>
* satisfy the predicate condition will be equal to the cardinality of <em>e</em> in <em>a</em>.
* </p>
*
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index 109f5669e..38a1c11a5 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -35,7 +35,7 @@ import org.apache.commons.collections4.iterators.UniqueFilterIterator;
/**
* Provides utility methods and decorators for {@link Iterable} instances.
* <p>
- * <b>Note</b>: This utility class has been designed with fail-fast argument checking.
+ * <strong>Note</strong>: This utility class has been designed with fail-fast argument checking.
* </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
@@ -685,7 +685,7 @@ public class IterableUtils {
* R = collection of elements rejected by all predicates
* </pre>
* <p>
- * <b>Note</b>: elements are only added to the output collection of the first matching
+ * <strong>Note</strong>: elements are only added to the output collection of the first matching
* predicate, determined by the order of arguments.
* </p>
* <p>
@@ -818,7 +818,7 @@ public class IterableUtils {
* R = collection of elements rejected by all predicates
* </pre>
* <p>
- * <b>Note</b>: elements are only added to the output collection of the first matching
+ * <strong>Note</strong>: elements are only added to the output collection of the first matching
* predicate, determined by the order of arguments.
* </p>
* <p>
diff --git a/src/main/java/org/apache/commons/collections4/ListUtils.java b/src/main/java/org/apache/commons/collections4/ListUtils.java
index 9e98cb18a..d8d6f32cf 100644
--- a/src/main/java/org/apache/commons/collections4/ListUtils.java
+++ b/src/main/java/org/apache/commons/collections4/ListUtils.java
@@ -309,7 +309,7 @@ public class ListUtils {
* different implementations of the {@code List} interface.
* </blockquote>
* <p>
- * <b>Note:</b> The behavior of this method is undefined if the lists are
+ * <strong>Note:</strong> The behavior of this method is undefined if the lists are
* modified during the equals comparison.
* </p>
*
@@ -625,7 +625,7 @@ public class ListUtils {
* @param <E> the element type
* @param inputCollection the collection to get the input from, may not be null
* @param predicate the predicate to use, may be null
- * @return the elements <b>not</b> matching the predicate (new list)
+ * @return the elements <strong>not</strong> matching the predicate (new list)
* @throws NullPointerException if the input collection is null
*
* @since 4.0
diff --git a/src/main/java/org/apache/commons/collections4/ListValuedMap.java b/src/main/java/org/apache/commons/collections4/ListValuedMap.java
index 37174ae5a..f87b4253c 100644
--- a/src/main/java/org/apache/commons/collections4/ListValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/ListValuedMap.java
@@ -37,7 +37,7 @@ public interface ListValuedMap<K, V> extends MultiValuedMap<K, V> {
/**
* Gets the list of values associated with the specified key.
* <p>
- * This method will return an <b>empty</b> list if
+ * This method will return an <strong>empty</strong> list if
* {@link #containsKey(Object)} returns {@code false}. Changes to the
* returned list will update the underlying {@code ListValuedMap} and
* vice-versa.
diff --git a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
index b5620e2c1..7fd138b35 100644
--- a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
@@ -128,7 +128,7 @@ public interface MultiValuedMap<K, V> {
/**
* Returns a view collection of the values associated with the specified key.
* <p>
- * This method will return an <b>empty</b> collection if {@link #containsKey(Object)}
+ * This method will return an <strong>empty</strong> collection if {@link #containsKey(Object)}
* returns {@code false}. Changes to the returned collection will update the underlying
* {@code MultiValuedMap} and vice-versa.
* </p>
diff --git a/src/main/java/org/apache/commons/collections4/SetUtils.java b/src/main/java/org/apache/commons/collections4/SetUtils.java
index bdef4b5a8..5b1e515bf 100644
--- a/src/main/java/org/apache/commons/collections4/SetUtils.java
+++ b/src/main/java/org/apache/commons/collections4/SetUtils.java
@@ -49,7 +49,7 @@ import org.apache.commons.collections4.set.UnmodifiableSortedSet;
public class SetUtils {
/**
- * An unmodifiable <b>view</b> of a set that may be backed by other sets.
+ * An unmodifiable <strong>view</strong> of a set that may be backed by other sets.
* <p>
* If the decorated sets change, this view will change as well. The contents
* of this view can be transferred to another instance via the {@link #copyInto(Set)}
@@ -109,7 +109,7 @@ public class SetUtils {
UnmodifiableSortedSet.unmodifiableSortedSet(new TreeSet<>());
/**
- * Returns an unmodifiable <b>view</b> containing the difference of the given
+ * Returns an unmodifiable <strong>view</strong> containing the difference of the given
* {@link Set}s, denoted by {@code a \ b} (or {@code a - b}).
* <p>
* The returned view contains all elements of {@code a} that are not a member
@@ -142,7 +142,7 @@ public class SetUtils {
}
/**
- * Returns an unmodifiable <b>view</b> of the symmetric difference of the given
+ * Returns an unmodifiable <strong>view</strong> of the symmetric difference of the given
* {@link Set}s.
* <p>
* The returned view contains all elements of {@code a} and {@code b} that are
@@ -261,7 +261,7 @@ public class SetUtils {
}
/**
- * Returns an unmodifiable <b>view</b> of the intersection of the given {@link Set}s.
+ * Returns an unmodifiable <strong>view</strong> of the intersection of the given {@link Set}s.
* <p>
* The returned view contains all elements that are members of both input sets
* ({@code a} and {@code b}).
@@ -548,7 +548,7 @@ public class SetUtils {
// Set operations
/**
- * Returns an unmodifiable <b>view</b> of the union of the given {@link Set}s.
+ * Returns an unmodifiable <strong>view</strong> of the union of the given {@link Set}s.
* <p>
* The returned view contains all elements of {@code a} and {@code b}.
*
diff --git a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
index 0938b29a3..2f6bcbfbd 100644
--- a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
@@ -112,7 +112,7 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
/**
* <em>(Change)</em>
* Returns {@code true} if the bag contains all elements in
- * the given collection, <b>not</b> respecting cardinality. That is,
+ * the given collection, <strong>not</strong> respecting cardinality. That is,
* if the given collection {@code coll} contains at least one of
* every object contained in this object.
*
@@ -157,7 +157,7 @@ public final class CollectionBag<E> extends AbstractBagDecorator<E> {
/**
* <em>(Change)</em>
* Remove all elements represented in the given collection,
- * <b>not</b> respecting cardinality. That is, remove <em>all</em>
+ * <strong>not</strong> respecting cardinality. That is, remove <em>all</em>
* occurrences of every object contained in the given collection.
*
* @param coll the collection to remove
diff --git a/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java b/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
index c28e3ab51..493ff7327 100644
--- a/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
@@ -153,7 +153,7 @@ public abstract class AbstractCollectionDecorator<E>
/**
* Sets the collection being decorated.
* <p>
- * <b>NOTE:</b> this method should only be used during deserialization
+ * <strong>NOTE:</strong> this method should only be used during deserialization
*
* @param collection the decorated collection
*/
diff --git a/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java b/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
index 3066c70d4..e7d1be680 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/ReverseComparator.java
@@ -42,7 +42,7 @@ public class ReverseComparator<E> implements Comparator<E>, Serializable {
* Creates a comparator that compares objects based on the inverse of their
* natural ordering. Using this Constructor will create a ReverseComparator
* that is functionally identical to the Comparator returned by
- * java.util.Collections.<b>reverseOrder()</b>.
+ * java.util.Collections.<strong>reverseOrder()</strong>.
*
* @see java.util.Collections#reverseOrder()
*/
diff --git a/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java b/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java
index 80eb58673..32a0b8774 100644
--- a/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java
+++ b/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java
@@ -24,7 +24,7 @@ import org.apache.commons.collections4.Transformer;
* Clone is performed using {@code PrototypeFactory.prototypeFactory(input).create()}.
* </p>
* <p>
- * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
+ * <strong>WARNING:</strong> from v4.1 onwards this class will <strong>not</strong> be serializable anymore
* in order to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java
index 092b09d19..93e8998bb 100644
--- a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java
+++ b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java
@@ -67,7 +67,7 @@ import org.apache.commons.collections4.Predicate;
* evaluation of a comparator result.</p>
*
* <pre>
- * ComparatorPredicate.comparatorPredicate(ONE, comparator,<b>ComparatorPredicate.Criterion.GREATER</b>).test(TWO);
+ * ComparatorPredicate.comparatorPredicate(ONE, comparator,<strong>ComparatorPredicate.Criterion.GREATER</strong>).test(TWO);
* </pre>
*
* <p>The input variable TWO is compared to the stored variable ONE using the supplied {@code comparator}
diff --git a/src/main/java/org/apache/commons/collections4/functors/ForClosure.java b/src/main/java/org/apache/commons/collections4/functors/ForClosure.java
index 09c1effca..7abb4d797 100644
--- a/src/main/java/org/apache/commons/collections4/functors/ForClosure.java
+++ b/src/main/java/org/apache/commons/collections4/functors/ForClosure.java
@@ -21,7 +21,7 @@ import org.apache.commons.collections4.Closure;
/**
* Closure implementation that calls another closure n times, like a for loop.
* <p>
- * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
+ * <strong>WARNING:</strong> from v4.1 onwards this class will <strong>not</strong> be serializable anymore
* in order to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java
index e80cdeda1..72b1c5803 100644
--- a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java
+++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java
@@ -26,7 +26,7 @@ import org.apache.commons.collections4.FunctorException;
/**
* Factory implementation that creates a new object instance by reflection.
* <p>
- * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
+ * <strong>WARNING:</strong> from v4.1 onwards this class will <strong>not</strong> be serializable anymore
* in order to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java
index ed063fedd..6f7ec6ca8 100644
--- a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java
+++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java
@@ -25,7 +25,7 @@ import org.apache.commons.collections4.Transformer;
/**
* Transformer implementation that creates a new object instance by reflection.
* <p>
- * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
+ * <strong>WARNING:</strong> from v4.1 onwards this class will <strong>not</strong> be serializable anymore
* in order to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java b/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java
index 353c6f844..5ed076953 100644
--- a/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java
+++ b/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java
@@ -26,7 +26,7 @@ import org.apache.commons.collections4.Transformer;
/**
* Transformer implementation that creates a new object instance by reflection.
* <p>
- * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
+ * <strong>WARNING:</strong> from v4.1 onwards this class will <strong>not</strong> be serializable anymore
* in order to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java
index 65ac42cae..36cd29c12 100644
--- a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java
+++ b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java
@@ -31,8 +31,8 @@ import org.apache.commons.collections4.FunctorException;
/**
* Factory implementation that creates a new instance each time based on a prototype.
* <p>
- * <b>WARNING:</b> from v4.1 onwards {@link Factory} instances returned by
- * {@link #prototypeFactory(Object)} will <b>not</b> be serializable anymore in order
+ * <strong>WARNING:</strong> from v4.1 onwards {@link Factory} instances returned by
+ * {@link #prototypeFactory(Object)} will <strong>not</strong> be serializable anymore in order
* to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java b/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java
index c4bbea5b8..cb4386214 100644
--- a/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java
+++ b/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java
@@ -25,7 +25,7 @@ import org.apache.commons.collections4.Predicate;
* Closure implementation that executes a closure repeatedly until a condition is met,
* like a do-while or while loop.
* <p>
- * <b>WARNING:</b> from v4.1 onwards this class will <b>not</b> be serializable anymore
+ * <strong>WARNING:</strong> from v4.1 onwards this class will <strong>not</strong> be serializable anymore
* in order to prevent potential remote code execution exploits. Please refer to
* <a href="https://issues.apache.org/jira/browse/COLLECTIONS-580">COLLECTIONS-580</a>
* for more details.
diff --git a/src/main/java/org/apache/commons/collections4/functors/package-info.java b/src/main/java/org/apache/commons/collections4/functors/package-info.java
index 0dd906754..545e754c1 100644
--- a/src/main/java/org/apache/commons/collections4/functors/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/functors/package-info.java
@@ -23,7 +23,7 @@
* {@link org.apache.commons.collections4.Factory Factory} interfaces.
* These provide simple callbacks for processing with collections.
* <p>
- * <b>WARNING:</b> from v4.1 onwards several unsafe classes in this package
+ * <strong>WARNING:</strong> from v4.1 onwards several unsafe classes in this package
* will not be serializable anymore in order to prevent potential remote
* code execution exploits.
* <p>
diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java
index 9f4fe4d8f..a4293ddbf 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java
@@ -184,7 +184,7 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
* to {@link #next()} of {@link #previous()}.
* </p>
* <p>
- * <b>Note:</b> {@link java.util.ListIterator} implementations that support
+ * <strong>Note:</strong> {@link java.util.ListIterator} implementations that support
* {@code add()} and {@code remove()} only allow {@code set()} to be called
* once per call to {@code next()} or {@code previous} (see the {@link java.util.ListIterator}
* Javadoc for more details). Since this implementation does
diff --git a/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java b/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java
index 3b9b8b842..d9ed489ef 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/LazyIteratorChain.java
@@ -95,7 +95,7 @@ public abstract class LazyIteratorChain<E> implements Iterator<E> {
/**
* Gets the next iterator after the previous one has been exhausted.
* <p>
- * This method <b>MUST</b> return null when there are no more iterators.
+ * This method <strong>MUST</strong> return null when there are no more iterators.
* </p>
*
* @param count the number of time this method has been called (starts with 1)
diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
index 06851a176..2ca332cab 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
@@ -176,7 +176,7 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
* to {@link #next()} of {@link #previous()}.
* </p>
* <p>
- * <b>Note:</b> {@link java.util.ListIterator} implementations that support {@code add()}
+ * <strong>Note:</strong> {@link java.util.ListIterator} implementations that support {@code add()}
* and {@code remove()} only allow {@code set()} to be called once per call
* to {@code next()} or {@code previous} (see the {@link java.util.ListIterator}
* Javadoc for more details). Since this implementation does not support
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java b/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
index 514eef693..fdcfce6a1 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
@@ -194,7 +194,7 @@ public class MultiKey<K> implements Serializable {
/**
* Constructor taking an array of keys, optionally choosing whether to clone.
* <p>
- * <b>If the array is not cloned, then it must not be modified.</b>
+ * <strong>If the array is not cloned, then it must not be modified.</strong>
* <p>
* This method is public for performance reasons only, to avoid a clone.
* The hash code is calculated once here in this method.
diff --git a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
index b8cd8bc59..cbbd11c36 100644
--- a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java
@@ -42,7 +42,7 @@ import java.util.ListIterator;
* methods provides access to a {@code Cursor} instance which extends
* {@code ListIterator}. The cursor allows changes to the list concurrent
* with changes to the iterator. Note that the {@link #iterator()} method and
- * sublists do <b>not</b> provide this cursor behavior.
+ * sublists do <strong>not</strong> provide this cursor behavior.
* </p>
* <p>
* The {@code Cursor} class is provided partly for backwards compatibility
@@ -52,7 +52,7 @@ import java.util.ListIterator;
* the garbage collector to the rest.
* </p>
* <p>
- * <b>Note that this implementation is not synchronized.</b>
+ * <strong>Note that this implementation is not synchronized.</strong>
* </p>
*
* @param <E> the type of the elements in the list.
@@ -464,13 +464,13 @@ public class CursorableLinkedList<E> extends AbstractLinkedList<E> implements Se
}
/**
- * Returns an iterator that does <b>not</b> support concurrent modification.
+ * Returns an iterator that does <strong>not</strong> support concurrent modification.
* <p>
* If the underlying list is modified while iterating using this iterator
* a ConcurrentModificationException will occur.
* The cursor behavior is available via {@link #listIterator()}.
*
- * @return a new iterator that does <b>not</b> support concurrent modification
+ * @return a new iterator that does <strong>not</strong> support concurrent modification
*/
@Override
public Iterator<E> iterator() {
diff --git a/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java b/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
index 02f18139d..31411a4e2 100644
--- a/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/NodeCachingLinkedList.java
@@ -36,7 +36,7 @@ import java.util.Collection;
* using this class.
* </p>
* <p>
- * <b>Note that this implementation is not synchronized.</b>
+ * <strong>Note that this implementation is not synchronized.</strong>
* </p>
*
* @param <E> the type of the elements in the list.
diff --git a/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java b/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java
index a33af9c60..0c6943a89 100644
--- a/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java
@@ -407,7 +407,7 @@ public final class StaticBucketMap<K, V> extends AbstractIterableMap<K, V> {
* });
* </pre>
* <p>
- * <b>Implementation note:</b> This method requires a lot of time and a ton of stack space. Essentially a recursive algorithm is used to enter each bucket's
+ * <strong>Implementation note:</strong> This method requires a lot of time and a ton of stack space. Essentially a recursive algorithm is used to enter each bucket's
* monitor. If you have twenty thousand buckets in your map, then the recursive method will be invoked twenty thousand times. You have been warned.
* </p>
*
@@ -660,7 +660,7 @@ public final class StaticBucketMap<K, V> extends AbstractIterableMap<K, V> {
/**
* Puts all the entries from the specified map into this map.
- * This operation is <b>not atomic</b> and may have undesired effects.
+ * This operation is <strong>not atomic</strong> and may have undesired effects.
*
* @param map the map of entries to add
*/
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
index 05610c963..39d0cd5c6 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
@@ -873,7 +873,7 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
/**
* Sets the map being wrapped.
* <p>
- * <b>NOTE:</b> this method should only be used during deserialization
+ * <strong>NOTE:</strong> this method should only be used during deserialization
*
* @param map the map to wrap
*/
@@ -885,7 +885,7 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
/**
* {@inheritDoc}
* <p>
- * This implementation does <b>not</b> cache the total size
+ * This implementation does <strong>not</strong> cache the total size
* of the multivalued map, but rather calculates it by iterating
* over the entries of the underlying map.
*/
diff --git a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
index 225662f23..15b2169d3 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -484,7 +484,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
/**
* Sets the map being wrapped.
* <p>
- * <b>Note:</b> this method should only be used during deserialization
+ * <strong>Note:</strong> this method should only be used during deserialization
* </p>
*
* @param map the map to wrap
diff --git a/src/test/java/org/apache/commons/collections4/bag/AbstractBagTest.java b/src/test/java/org/apache/commons/collections4/bag/AbstractBagTest.java
index 7c55ecd15..8b0445090 100644
--- a/src/test/java/org/apache/commons/collections4/bag/AbstractBagTest.java
+++ b/src/test/java/org/apache/commons/collections4/bag/AbstractBagTest.java
@@ -51,7 +51,7 @@ import org.junit.jupiter.api.Test;
* you may still use this base set of cases. Simply override the
* test case (method) your bag fails.
* <p>
- * <b>Note:</b> The Bag interface does not conform to the Collection interface
+ * <strong>Note:</strong> The Bag interface does not conform to the Collection interface
* so the generic collection tests from AbstractCollectionTest would normally fail.
* As a work-around since 4.0, a CollectionBag decorator can be used
* to make any Bag implementation comply to the Collection contract.
diff --git a/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java b/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java
index ec48d6714..5f66f0924 100644
--- a/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java
+++ b/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java
@@ -58,7 +58,7 @@ import org.junit.jupiter.api.Test;
* and {@link #makeConfirmedFullCollection()} methods.
* You might want to override some of the additional public methods as well:
* <p>
- * <b>Element Population Methods</b>
+ * <strong>Element Population Methods</strong>
* <p>
* Override these if your collection restricts what kind of elements are
* allowed (for instance, if {@code null} is not permitted):
@@ -67,7 +67,7 @@ import org.junit.jupiter.api.Test;
* <li>{@link #getOtherElements()}
* </ul>
* <p>
- * <b>Supported Operation Methods</b>
+ * <strong>Supported Operation Methods</strong>
* <p>
* Override these if your collection doesn't support certain operations:
* <ul>
@@ -78,14 +78,14 @@ import org.junit.jupiter.api.Test;
* <li>{@link #isFailFastSupported()}
* </ul>
* <p>
- * <b>Indicate Collection Behaviour</b>
+ * <strong>Indicate Collection Behaviour</strong>
* <p>
* Override these if your collection makes specific behavior guarantees:
* <ul>
* <li>{@link #getIterationBehaviour()}</li>
* </ul>
* <p>
- * <b>Fixture Methods</b>
+ * <strong>Fixture Methods</strong>
* <p>
* Fixtures are used to verify that the operation results in correct state
* for the collection. Basically, the operation is performed against your
@@ -131,7 +131,7 @@ import org.junit.jupiter.api.Test;
* above methods, because those three classes already override the methods
* to provide standard JDK confirmed collections.<P>
* <p>
- * <b>Other notes</b>
+ * <strong>Other notes</strong>
* <p>
* If your {@link Collection} fails one of these tests by design,
* you may still use this base set of cases. Simply override the
diff --git a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
index 5ac36b7c7..d2714fba3 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
@@ -62,7 +62,7 @@ import org.junit.jupiter.api.Test;
* On the other hand, if your map implementation is weird, you may have to override one or more of the other protected methods. They're described below.
* </p>
* <p>
- * <b>Entry Population Methods</b>
+ * <strong>Entry Population Methods</strong>
* </p>
* <p>
* Override these methods if your map requires special entries:
@@ -76,7 +76,7 @@ import org.junit.jupiter.api.Test;
* <li>{@link #getOtherValues()}
* </ul>
*
- * <b>Indicate Map Behaviour</b>
+ * <strong>Indicate Map Behaviour</strong>
* <p>
* Override these if your map makes specific behavior guarantees:
* </p>
@@ -84,7 +84,7 @@ import org.junit.jupiter.api.Test;
* <li>{@link #getIterationBehaviour()}</li>
* </ul>
*
- * <b>Supported Operation Methods</b>
+ * <strong>Supported Operation Methods</strong>
* <p>
* Override these methods if your map doesn't support certain operations:
* </p>
@@ -100,7 +100,7 @@ import org.junit.jupiter.api.Test;
* <li>{@link #isAllowNullValue()}
* </ul>
*
- * <b>Fixture Methods</b>
+ * <strong>Fixture Methods</strong>
* <p>
* For tests on modification operations (puts and removes), fixtures are used to verify that that operation results in correct state for the map and its
* collection views. Basically, the modification is performed against your map implementation, and an identical modification is performed against a
@@ -125,7 +125,7 @@ import org.junit.jupiter.api.Test;
* instance, TestDoubleOrderedMap would want override its {@link #verifyValues()} method to verify that the values are unique and in ascending order.
* </p>
*
- * <b>Other Notes</b>
+ * <strong>Other Notes</strong>
* <p>
* If your {@link Map} fails one of these tests by design, you may still use this base set of cases. Simply override the test case (method) your map fails
* and/or the methods that define the assumptions used by the test cases. For example, if your map does not allow duplicate values, override
(commons-collections) 01/02: [COLLECTIONS-857] Update documentation to match bloomfilter implementation
Posted by gg...@apache.org.
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
commit 45cd71153959904562fd95be31b440923c770354
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Nov 15 10:11:32 2024 -0500
[COLLECTIONS-857] Update documentation to match bloomfilter
implementation
---
.../org/apache/commons/collections4/bloomfilter/package-info.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
index 2abf993bf..94abbc280 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
@@ -37,8 +37,8 @@
*
* <h3>BloomFilter</h3>
*
- * <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@code merge}, {@code remove},
- * {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.
+ * <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}'s
+ * {@code merge}, {@code remove}, {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.
* The choice to use not use atomic transactions was made to achieve maximum performance under correct usage.</p>
*
* <h4>Nomenclature</h4>