From 95673e47cefd2d01e073369616c969c19a282176 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Fri, 15 Nov 2024 10:11:52 -0500 Subject: [PATCH] Javadoc: Use semantic tag instead of style tag --- .../org/apache/commons/collections4/ArrayStack.java | 2 +- .../apache/commons/collections4/CollectionUtils.java | 8 ++++---- .../org/apache/commons/collections4/IterableUtils.java | 6 +++--- .../org/apache/commons/collections4/ListUtils.java | 4 ++-- .../org/apache/commons/collections4/ListValuedMap.java | 2 +- .../apache/commons/collections4/MultiValuedMap.java | 2 +- .../java/org/apache/commons/collections4/SetUtils.java | 10 +++++----- .../apache/commons/collections4/bag/CollectionBag.java | 4 ++-- .../collection/AbstractCollectionDecorator.java | 2 +- .../collections4/comparators/ReverseComparator.java | 2 +- .../collections4/functors/CloneTransformer.java | 2 +- .../collections4/functors/ComparatorPredicate.java | 2 +- .../commons/collections4/functors/ForClosure.java | 2 +- .../collections4/functors/InstantiateFactory.java | 2 +- .../collections4/functors/InstantiateTransformer.java | 2 +- .../collections4/functors/InvokerTransformer.java | 2 +- .../collections4/functors/PrototypeFactory.java | 4 ++-- .../commons/collections4/functors/WhileClosure.java | 2 +- .../commons/collections4/functors/package-info.java | 2 +- .../collections4/iterators/ArrayListIterator.java | 2 +- .../collections4/iterators/LazyIteratorChain.java | 2 +- .../iterators/ObjectArrayListIterator.java | 2 +- .../apache/commons/collections4/keyvalue/MultiKey.java | 2 +- .../collections4/list/CursorableLinkedList.java | 8 ++++---- .../collections4/list/NodeCachingLinkedList.java | 2 +- .../commons/collections4/map/StaticBucketMap.java | 4 ++-- .../collections4/multimap/AbstractMultiValuedMap.java | 4 ++-- .../collections4/multiset/AbstractMapMultiSet.java | 2 +- .../commons/collections4/bag/AbstractBagTest.java | 2 +- .../collection/AbstractCollectionTest.java | 10 +++++----- .../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; *

* Unlike {@code Stack}, {@code ArrayStack} accepts null entries. *

- * Note: From version 4.0 onwards, this class does not implement the + * Note: From version 4.0 onwards, this class does not implement the * removed {@code Buffer} interface anymore. *

* 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 e in a or b. *

*

- * Note: from version 4.1 onwards this method requires the input + * Note: 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 { *

* 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 - * very large for collections > 10 (e.g. 10! = 3628800, 15! = 1307674368000). + * very large for collections > 10 (e.g. 10! = 3628800, 15! = 1307674368000). *

*

* For larger collections it is advised to use a {@link PermutationIterator} to @@ -1792,7 +1792,7 @@ public class CollectionUtils { * @param 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 not matching the predicate (new list) + * @return the elements not matching the predicate (new list) */ public static Collection selectRejected(final Iterable inputCollection, final Predicate predicate) { @@ -1962,7 +1962,7 @@ public class CollectionUtils { * minus the cardinality of e in b, or zero, whichever is greater. *

*

- * The cardinality of each element e in the returned {@link Collection} that does not + * The cardinality of each element e in the returned {@link Collection} that does not * satisfy the predicate condition will be equal to the cardinality of e in a. *

* 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. *

- * Note: This utility class has been designed with fail-fast argument checking. + * Note: This utility class has been designed with fail-fast argument checking. *

*
    *
  • All decorator methods are not 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 * *

    - * Note: elements are only added to the output collection of the first matching + * Note: elements are only added to the output collection of the first matching * predicate, determined by the order of arguments. *

    *

    @@ -818,7 +818,7 @@ public class IterableUtils { * R = collection of elements rejected by all predicates * *

    - * Note: elements are only added to the output collection of the first matching + * Note: elements are only added to the output collection of the first matching * predicate, determined by the order of arguments. *

    *

    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. * *

    - * Note: The behavior of this method is undefined if the lists are + * Note: The behavior of this method is undefined if the lists are * modified during the equals comparison. *

    * @@ -625,7 +625,7 @@ public class ListUtils { * @param 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 not matching the predicate (new list) + * @return the elements not 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 extends MultiValuedMap { /** * Gets the list of values associated with the specified key. *

    - * This method will return an empty list if + * This method will return an empty 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 { /** * Returns a view collection of the values associated with the specified key. *

    - * This method will return an empty collection if {@link #containsKey(Object)} + * This method will return an empty collection if {@link #containsKey(Object)} * returns {@code false}. Changes to the returned collection will update the underlying * {@code MultiValuedMap} and vice-versa. *

    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 view of a set that may be backed by other sets. + * An unmodifiable view of a set that may be backed by other sets. *

    * 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 view containing the difference of the given + * Returns an unmodifiable view containing the difference of the given * {@link Set}s, denoted by {@code a \ b} (or {@code a - b}). *

    * The returned view contains all elements of {@code a} that are not a member @@ -142,7 +142,7 @@ public class SetUtils { } /** - * Returns an unmodifiable view of the symmetric difference of the given + * Returns an unmodifiable view of the symmetric difference of the given * {@link Set}s. *

    * The returned view contains all elements of {@code a} and {@code b} that are @@ -261,7 +261,7 @@ public class SetUtils { } /** - * Returns an unmodifiable view of the intersection of the given {@link Set}s. + * Returns an unmodifiable view of the intersection of the given {@link Set}s. *

    * 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 view of the union of the given {@link Set}s. + * Returns an unmodifiable view of the union of the given {@link Set}s. *

    * 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 extends AbstractBagDecorator { /** * (Change) * Returns {@code true} if the bag contains all elements in - * the given collection, not respecting cardinality. That is, + * the given collection, not 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 extends AbstractBagDecorator { /** * (Change) * Remove all elements represented in the given collection, - * not respecting cardinality. That is, remove all + * not respecting cardinality. That is, remove all * 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 /** * Sets the collection being decorated. *

    - * NOTE: this method should only be used during deserialization + * NOTE: 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 implements Comparator, 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.reverseOrder(). + * java.util.Collections.reverseOrder(). * * @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()}. *

    *

    - * WARNING: from v4.1 onwards this class will not be serializable anymore + * WARNING: from v4.1 onwards this class will not be serializable anymore * in order to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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.

    * * 
    - * ComparatorPredicate.comparatorPredicate(ONE, comparator,ComparatorPredicate.Criterion.GREATER).test(TWO);
+ * ComparatorPredicate.comparatorPredicate(ONE, comparator,ComparatorPredicate.Criterion.GREATER).test(TWO);
  *
    * *

    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. *

    - * WARNING: from v4.1 onwards this class will not be serializable anymore + * WARNING: from v4.1 onwards this class will not be serializable anymore * in order to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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. *

    - * WARNING: from v4.1 onwards this class will not be serializable anymore + * WARNING: from v4.1 onwards this class will not be serializable anymore * in order to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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. *

    - * WARNING: from v4.1 onwards this class will not be serializable anymore + * WARNING: from v4.1 onwards this class will not be serializable anymore * in order to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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. *

    - * WARNING: from v4.1 onwards this class will not be serializable anymore + * WARNING: from v4.1 onwards this class will not be serializable anymore * in order to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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. *

    - * WARNING: from v4.1 onwards {@link Factory} instances returned by - * {@link #prototypeFactory(Object)} will not be serializable anymore in order + * WARNING: from v4.1 onwards {@link Factory} instances returned by + * {@link #prototypeFactory(Object)} will not be serializable anymore in order * to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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. *

    - * WARNING: from v4.1 onwards this class will not be serializable anymore + * WARNING: from v4.1 onwards this class will not be serializable anymore * in order to prevent potential remote code execution exploits. Please refer to * COLLECTIONS-580 * 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. *

    - * WARNING: from v4.1 onwards several unsafe classes in this package + * WARNING: from v4.1 onwards several unsafe classes in this package * will not be serializable anymore in order to prevent potential remote * code execution exploits. *

    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 extends ArrayIterator * to {@link #next()} of {@link #previous()}. *

    *

    - * Note: {@link java.util.ListIterator} implementations that support + * Note: {@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 implements Iterator { /** * Gets the next iterator after the previous one has been exhausted. *

    - * This method MUST return null when there are no more iterators. + * This method MUST return null when there are no more iterators. *

    * * @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 extends ObjectArrayIterator * to {@link #next()} of {@link #previous()}. *

    *

    - * Note: {@link java.util.ListIterator} implementations that support {@code add()} + * Note: {@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 implements Serializable { /** * Constructor taking an array of keys, optionally choosing whether to clone. *

    - * If the array is not cloned, then it must not be modified. + * If the array is not cloned, then it must not be modified. *

    * 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 not provide this cursor behavior. + * sublists do not provide this cursor behavior. *

    *

    * The {@code Cursor} class is provided partly for backwards compatibility @@ -52,7 +52,7 @@ import java.util.ListIterator; * the garbage collector to the rest. *

    *

    - * Note that this implementation is not synchronized. + * Note that this implementation is not synchronized. *

    * * @param the type of the elements in the list. @@ -464,13 +464,13 @@ public class CursorableLinkedList extends AbstractLinkedList implements Se } /** - * Returns an iterator that does not support concurrent modification. + * Returns an iterator that does not support concurrent modification. *

    * 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 not support concurrent modification + * @return a new iterator that does not support concurrent modification */ @Override public Iterator 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. *

    *

    - * Note that this implementation is not synchronized. + * Note that this implementation is not synchronized. *

    * * @param 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 extends AbstractIterableMap { * }); * *

    - * Implementation note: This method requires a lot of time and a ton of stack space. Essentially a recursive algorithm is used to enter each bucket's + * Implementation note: 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. *

    * @@ -660,7 +660,7 @@ public final class StaticBucketMap extends AbstractIterableMap { /** * Puts all the entries from the specified map into this map. - * This operation is not atomic and may have undesired effects. + * This operation is not atomic 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 implements MultiValuedMap - * NOTE: this method should only be used during deserialization + * NOTE: this method should only be used during deserialization * * @param map the map to wrap */ @@ -885,7 +885,7 @@ public abstract class AbstractMultiValuedMap implements MultiValuedMap - * This implementation does not cache the total size + * This implementation does not 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 extends AbstractMultiSet { /** * Sets the map being wrapped. *

    - * Note: this method should only be used during deserialization + * Note: this method should only be used during deserialization *

    * * @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. *

    - * Note: The Bag interface does not conform to the Collection interface + * Note: 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: *

    - * Element Population Methods + * Element Population Methods *

    * 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; *

  • {@link #getOtherElements()} *
*

- * Supported Operation Methods + * Supported Operation Methods *

* Override these if your collection doesn't support certain operations: *

    @@ -78,14 +78,14 @@ import org.junit.jupiter.api.Test; *
  • {@link #isFailFastSupported()} *
*

- * Indicate Collection Behaviour + * Indicate Collection Behaviour *

* Override these if your collection makes specific behavior guarantees: *

    *
  • {@link #getIterationBehaviour()}
    • *
*

- * Fixture Methods + * Fixture Methods *

* 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.

*

- * Other notes + * Other notes *

* 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. *

*

- * Entry Population Methods + * Entry Population Methods *

*

* Override these methods if your map requires special entries: @@ -76,7 +76,7 @@ import org.junit.jupiter.api.Test; *

  • {@link #getOtherValues()} * * - * Indicate Map Behaviour + * Indicate Map Behaviour *

    * Override these if your map makes specific behavior guarantees: *

    @@ -84,7 +84,7 @@ import org.junit.jupiter.api.Test; *
  • {@link #getIterationBehaviour()}
    • * * - * Supported Operation Methods + * Supported Operation Methods *

    * Override these methods if your map doesn't support certain operations: *

    @@ -100,7 +100,7 @@ import org.junit.jupiter.api.Test; *
  • {@link #isAllowNullValue()} * * - * Fixture Methods + * Fixture Methods *

    * 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. *

    * - * Other Notes + * Other Notes *

    * 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