diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java b/src/main/java/org/apache/commons/collections4/CollectionUtils.java index 136c183cd4..e73af345d2 100644 --- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java +++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java @@ -168,7 +168,7 @@ public int hashCode() { } /** - * Helper class for set-related operations, e.g. union, subtract, intersection. + * Helper class for set-related operations, for example union, subtract, intersection. * @param the element type */ private static final class SetOperationCardinalityHelper extends CardinalityHelper implements Iterable { @@ -1216,7 +1216,7 @@ public static boolean isEqualCollection(final Collection a, final Collection< *

* 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) + * Providing incompatible arguments (for example by casting to their rawtypes) * will result in a {@code ClassCastException} thrown at runtime. *

* @@ -1404,7 +1404,7 @@ public static int maxSize(final Collection collection) { *

* 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 (for example 10! = 3628800, 15! = 1307674368000). *

*

* For larger collections it is advised to use a {@link PermutationIterator} to @@ -1462,7 +1462,7 @@ public static Collection predicatedCollection(final Collection collect * This implementation iterates over {@code collection}, checking each element in * turn to see if it's contained in {@code remove}. If it's not contained, it's added * to the returned list. As a consequence, it is advised to use a collection type for - * {@code remove} that provides a fast (e.g. O(1)) implementation of + * {@code remove} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. *

* @@ -1600,7 +1600,7 @@ public static Collection removeRange(final Collection input, final int * This implementation iterates over {@code collection}, checking each element in * turn to see if it's contained in {@code retain}. If it's contained, it's added * to the returned list. As a consequence, it is advised to use a collection type for - * {@code retain} that provides a fast (e.g. O(1)) implementation of + * {@code retain} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. *

* diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java b/src/main/java/org/apache/commons/collections4/FluentIterable.java index 85d3cbf3b6..6525862a8d 100644 --- a/src/main/java/org/apache/commons/collections4/FluentIterable.java +++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java @@ -35,11 +35,11 @@ *

*
    *
  • fluent methods which return a new {@code FluentIterable} instance, - * providing a view of the original iterable (e.g. filter(Predicate)); + * providing a view of the original iterable (for example filter(Predicate)); *
  • conversion methods which copy the FluentIterable's contents into a - * new collection or array (e.g. toList()); + * new collection or array (for example toList()); *
  • utility methods which answer questions about the FluentIterable's - * contents (e.g. size(), anyMatch(Predicate)). + * contents (for example size(), anyMatch(Predicate)). *
  • *
*

diff --git a/src/main/java/org/apache/commons/collections4/ListUtils.java b/src/main/java/org/apache/commons/collections4/ListUtils.java index d22609f4f1..18149924c5 100644 --- a/src/main/java/org/apache/commons/collections4/ListUtils.java +++ b/src/main/java/org/apache/commons/collections4/ListUtils.java @@ -536,7 +536,7 @@ public static List predicatedList(final List list, final Predicate * This implementation iterates over {@code collection}, checking each element in * turn to see if it's contained in {@code remove}. If it's not contained, it's added * to the returned list. As a consequence, it is advised to use a collection type for - * {@code remove} that provides a fast (e.g. O(1)) implementation of + * {@code remove} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. *

* @@ -571,7 +571,7 @@ public static List removeAll(final Collection collection, final Collec * This implementation iterates over {@code collection}, checking each element in * turn to see if it's contained in {@code retain}. If it's contained, it's added * to the returned list. As a consequence, it is advised to use a collection type for - * {@code retain} that provides a fast (e.g. O(1)) implementation of + * {@code retain} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. *

* diff --git a/src/main/java/org/apache/commons/collections4/MapUtils.java b/src/main/java/org/apache/commons/collections4/MapUtils.java index f9b2eb842f..3f99a47ed7 100644 --- a/src/main/java/org/apache/commons/collections4/MapUtils.java +++ b/src/main/java/org/apache/commons/collections4/MapUtils.java @@ -1945,7 +1945,7 @@ public static void verbosePrint(final PrintStream out, final Object label, final * given map with nice line breaks. If the debug flag is true, it additionally prints the type of the object value. * If the contents of a map include the map itself, then the text (this Map) is printed out. If the * contents include a parent container of the map, the text (ancestor[i] Map) is printed, where it actually - * indicates the number of levels which must be traversed in the sequential list of ancestors (e.g. father, + * indicates the number of levels which must be traversed in the sequential list of ancestors (for example father, * grandfather, great-grandfather, etc.). * * @param out the stream to print to diff --git a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java index 7fd138b35f..5b2d49616b 100644 --- a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java +++ b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java @@ -210,9 +210,9 @@ public interface MultiValuedMap { * @param value the value to add to the collection at the key * @return true if the map changed as a result of this put operation, or false * if the map already contained the key-value mapping and the collection - * type does not allow duplicate values, e.g. when using a Set + * type does not allow duplicate values, for example when using a Set * @throws UnsupportedOperationException if the put operation is not supported by - * this multivalued map, e.g. if it is unmodifiable + * this multivalued map, for example if it is unmodifiable * @throws NullPointerException if the key or value is null and null is invalid (optional) * @throws IllegalArgumentException if some aspect of the specified key or value prevents * it from being stored in this multivalued map 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 2f6bcbfbd6..c8b4c86d8f 100644 --- a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java @@ -189,7 +189,7 @@ public boolean removeAll(final Collection coll) { * each element in turn to see if it's contained in {@code coll}. * If it's not contained, it's removed from this bag. As a consequence, * it is advised to use a collection type for {@code coll} that provides - * a fast (e.g. O(1)) implementation of {@link Collection#contains(Object)}. + * a fast (for example O(1)) implementation of {@link Collection#contains(Object)}. *

* * @param coll the collection to retain diff --git a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java index 3f48ffe3f5..c99878d044 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java @@ -109,7 +109,7 @@ public void remove() { if (!canRemove) { throw new IllegalStateException("Iterator remove() can only be called once after next()"); } - // store value as remove may change the entry in the decorator (e.g. TreeMap) + // store value as remove may change the entry in the decorator (for example TreeMap) final V value = last.getValue(); iterator.remove(); parent.reverseMap.remove(value); @@ -230,7 +230,7 @@ public void remove() { if (!canRemove) { throw new IllegalStateException("Iterator remove() can only be called once after next()"); } - // store value as remove may change the entry in the decorator (e.g. TreeMap) + // store value as remove may change the entry in the decorator (for example TreeMap) final Object value = last.getValue(); super.remove(); parent.reverseMap.remove(value); @@ -527,7 +527,7 @@ public boolean removeIf(final Predicate filter) { * This implementation iterates over the elements of this bidi map, checking each element in * turn to see if it's contained in {@code coll}. If it's not contained, it's removed * from this bidi map. As a consequence, it is advised to use a collection type for - * {@code coll} that provides a fast (e.g. O(1)) implementation of + * {@code coll} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java index 45d3e6cfa8..70797c1fc0 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java @@ -54,7 +54,7 @@ *

*

* While that goal could be accomplished by taking a pair of TreeMaps - * and redirecting requests to the appropriate TreeMap (e.g., + * and redirecting requests to the appropriate TreeMap (for example, * containsKey would be directed to the TreeMap that maps values to * keys, containsValue would be directed to the TreeMap that maps keys * to values), there are problems with that implementation. diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java index f68cddc9e3..bda36ea2f1 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java @@ -160,7 +160,7 @@ public static > Consumer> onMaxSize(final int /** * Removes the last added target if it is empty. Useful as the first in a chain - * of cleanup consumers. (e.g. {@code Cleanup.removeEmptyTarget.andThen( otherConsumer )}) + * of cleanup consumers. (for example {@code Cleanup.removeEmptyTarget.andThen( otherConsumer )}) * * @param Type of BloomFilter. * @return A Consumer suitable for the LayerManager {@code cleanup} parameter. 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 94abbc2806..ad41d5b9d2 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 @@ -32,7 +32,7 @@ * list. There are lots of other uses, and in most cases the reason is to perform a fast check as a gateway for a longer * operation.

* - *

Some Bloom filters (e.g. {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}) use counters rather than bits. In this case each counter + *

Some Bloom filters (for example {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}) use counters rather than bits. In this case each counter * is called a cell.

* *

BloomFilter

@@ -51,7 +51,7 @@ *
  • index - In the {@code bloomfilter} package an Index is a logical collection of {@code int}s specifying the enabled * bits in the bit map.
    • * - *
  • cell - Some Bloom filters (e.g. {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}) use counters rather than bits. In the {@code bloomfilter} package + *
  • cell - Some Bloom filters (for example {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}) use counters rather than bits. In the {@code bloomfilter} package * Cells are pairs of ints representing an index and a value. They are not the standard Java {@code Pair} objects, * nor the Apache Commons Lang version either.
    • * @@ -61,7 +61,7 @@ * {@link org.apache.commons.collections4.bloomfilter.IndexExtractor} and have a {@code processXs} methods that take a * type specialization of {@link java.util.function.Predicate}. * {@code Predicate} type argument. - * (e.g. {@link org.apache.commons.collections4.bloomfilter.BitMapExtractor#processBitMaps(java.util.function.LongPredicate)}, + * (for example {@link org.apache.commons.collections4.bloomfilter.BitMapExtractor#processBitMaps(java.util.function.LongPredicate)}, * {@link org.apache.commons.collections4.bloomfilter.IndexExtractor#processIndices(java.util.function.IntPredicate)}, * and {@link org.apache.commons.collections4.bloomfilter.CellExtractor#processCells(org.apache.commons.collections4.bloomfilter.CellExtractor.CellPredicate)}). * The predicate is expected to process each of the Xs in turn and return {@code true} if the processing should continue diff --git a/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java b/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java index 7e326dc642..0e5e1e352a 100644 --- a/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/AbstractQuantifierPredicate.java @@ -21,7 +21,7 @@ import org.apache.commons.collections4.Predicate; /** - * Abstract base class for quantification predicates, e.g. All, Any, None. + * Abstract base class for quantification predicates, for example All, Any, None. * * @param the type of the input to the predicate. * @since 4.0 diff --git a/src/main/java/org/apache/commons/collections4/iterators/ExtendedIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ExtendedIterator.java index 5e8771ea4a..d393b7b117 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ExtendedIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ExtendedIterator.java @@ -26,7 +26,7 @@ import org.apache.commons.collections4.IteratorUtils; /** - * Extends Iterator functionality to include operations commonly found on streams (e.g. filtering, concatenating, mapping). It also provides convenience methods + * Extends Iterator functionality to include operations commonly found on streams (for example filtering, concatenating, mapping). It also provides convenience methods * for common operations. * * @param The type of object returned from the iterator. diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java index 334b08bb0a..a2f6aeef93 100644 --- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java @@ -963,7 +963,7 @@ public boolean remove(final Object value) { * This implementation iterates over the elements of this list, checking each element in * turn to see if it's contained in {@code coll}. If it's contained, it's removed * from this list. As a consequence, it is advised to use a collection type for - * {@code coll} that provides a fast (e.g. O(1)) implementation of + * {@code coll} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. */ @Override @@ -1039,7 +1039,7 @@ protected void removeNode(final Node node) { * This implementation iterates over the elements of this list, checking each element in * turn to see if it's contained in {@code coll}. If it's not contained, it's removed * from this list. As a consequence, it is advised to use a collection type for - * {@code coll} that provides a fast (e.g. O(1)) implementation of + * {@code coll} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java index a744fd21ae..eceb70944d 100644 --- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java +++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java @@ -950,7 +950,7 @@ public boolean remove(final Object value) { * This implementation iterates over the elements of this list, checking each element in * turn to see if it's contained in {@code coll}. If it's contained, it's removed * from this list. As a consequence, it is advised to use a collection type for - * {@code coll} that provides a fast (e.g. O(1)) implementation of + * {@code coll} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. */ @Override @@ -1022,7 +1022,7 @@ protected void removeNode(final Node node) { * This implementation iterates over the elements of this list, checking each element in * turn to see if it's contained in {@code coll}. If it's not contained, it's removed * from this list. As a consequence, it is advised to use a collection type for - * {@code coll} that provides a fast (e.g. O(1)) implementation of + * {@code coll} that provides a fast (for example O(1)) implementation of * {@link Collection#contains(Object)}. */ @Override diff --git a/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java b/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java index 0b75ccce4d..aaec1e4ec5 100644 --- a/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java +++ b/src/main/java/org/apache/commons/collections4/list/SetUniqueList.java @@ -369,7 +369,7 @@ public boolean removeIf(final Predicate filter) { * each element in turn to see if it's contained in {@code coll}. * If it's not contained, it's removed from this list. As a consequence, * it is advised to use a collection type for {@code coll} that provides - * a fast (e.g. O(1)) implementation of {@link Collection#contains(Object)}. + * a fast (for example O(1)) implementation of {@link Collection#contains(Object)}. */ @Override public boolean retainAll(final Collection coll) { diff --git a/src/main/java/org/apache/commons/collections4/queue/AbstractQueueDecorator.java b/src/main/java/org/apache/commons/collections4/queue/AbstractQueueDecorator.java index 7635947bc0..7ee112a72f 100644 --- a/src/main/java/org/apache/commons/collections4/queue/AbstractQueueDecorator.java +++ b/src/main/java/org/apache/commons/collections4/queue/AbstractQueueDecorator.java @@ -28,7 +28,7 @@ *

    * This implementation does not forward the hashCode and equals methods through * to the backing object, but relies on Object's implementation. This is - * necessary as some Queue implementations, e.g. LinkedList, have a custom + * necessary as some Queue implementations, for example LinkedList, have a custom * equals implementation for which symmetry cannot be preserved. * See class Javadoc of AbstractCollectionDecorator for more information. *

    diff --git a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java index 512de7fe38..57c5ee02a5 100644 --- a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java +++ b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java @@ -368,7 +368,7 @@ public boolean removeIf(final Predicate filter) { * each element in turn to see if it's contained in {@code coll}. * If it's not contained, it's removed from this set. As a consequence, * it is advised to use a collection type for {@code coll} that provides - * a fast (e.g. O(1)) implementation of {@link Collection#contains(Object)}. + * a fast (for example O(1)) implementation of {@link Collection#contains(Object)}. */ @Override public boolean retainAll(final Collection coll) { diff --git a/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java b/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java index 9ebbed282a..5cbb9ff674 100644 --- a/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java +++ b/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java @@ -172,7 +172,7 @@ protected boolean skipSerializedCanonicalTests() { /** * Override this method if a subclass is testing an object * that cannot serialize an "empty" Collection. - * (e.g. Comparators have no contents) + * (for example Comparators have no contents) * * @return true */ @@ -183,7 +183,7 @@ public boolean supportsEmptyCollections() { /** * Override this method if a subclass is testing an object * that cannot serialize a "full" Collection. - * (e.g. Comparators have no contents) + * (for example Comparators have no contents) * * @return true */ diff --git a/src/test/java/org/apache/commons/collections4/CollectionUtilsTest.java b/src/test/java/org/apache/commons/collections4/CollectionUtilsTest.java index 6dc10d321a..ac9a83152c 100644 --- a/src/test/java/org/apache/commons/collections4/CollectionUtilsTest.java +++ b/src/test/java/org/apache/commons/collections4/CollectionUtilsTest.java @@ -147,7 +147,7 @@ public void cardinality() { // Ensure that generic bounds accept valid parameters, but return // expected results - // e.g. no longs in the "int" Iterable, and vice versa. + // for example no longs in the "int" Iterable, and vice versa. assertEquals(0, CollectionUtils.cardinality(2L, iterableA2)); assertEquals(0, CollectionUtils.cardinality(2, iterableB2)); @@ -1048,7 +1048,7 @@ public void testGetFromLinkedHashMap() { } /** - * Tests that {@link List}s are handled correctly - e.g. using + * Tests that {@link List}s are handled correctly - for example using * {@link List#get(int)}. */ @Test diff --git a/src/test/java/org/apache/commons/collections4/IterableUtilsTest.java b/src/test/java/org/apache/commons/collections4/IterableUtilsTest.java index 7a3c793046..ab8995b91f 100644 --- a/src/test/java/org/apache/commons/collections4/IterableUtilsTest.java +++ b/src/test/java/org/apache/commons/collections4/IterableUtilsTest.java @@ -399,7 +399,7 @@ public void testFrequency() { // Ensure that generic bounds accept valid parameters, but return // expected results - // e.g. no longs in the "int" Iterable, and vice versa. + // for example no longs in the "int" Iterable, and vice versa. final Iterable iterableIntAsNumber = Arrays.asList(1, 2, 3, 4, 5); final Iterable iterableLongAsNumber = Arrays.asList(1L, 2L, 3L, 4L, 5L); assertEquals(0, IterableUtils.frequency(iterableIntAsNumber, 2L)); diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java index 455885014a..44fcb55514 100644 --- a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java +++ b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java @@ -66,10 +66,10 @@ int[] toArray() { private static final IntPredicate TRUE_PREDICATE = i -> true; private static final IntPredicate FALSE_PREDICATE = i -> false; - /** Flag to indicate the indices are ordered, e.g. from {@link IndexExtractor#processIndices(IntPredicate)}. */ + /** Flag to indicate the indices are ordered, for example from {@link IndexExtractor#processIndices(IntPredicate)}. */ protected static final int ORDERED = 0x1; - /** Flag to indicate the indices are distinct, e.g. from {@link IndexExtractor#processIndices(IntPredicate)}. */ + /** Flag to indicate the indices are distinct, for example from {@link IndexExtractor#processIndices(IntPredicate)}. */ protected static final int DISTINCT = 0x2; /** 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 d2714fba31..612086c747 100644 --- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java +++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java @@ -2538,7 +2538,7 @@ public void verifyMap() { assertEquals(empty, getMap().isEmpty(), "Map should be empty if HashMap is"); assertEquals(getConfirmed().hashCode(), getMap().hashCode(), "hashCodes should be the same"); // changing the order of the assertion below fails for LRUMap because confirmed is - // another collection (e.g. treemap) and confirmed.equals() creates a normal iterator (not + // another collection (for example treemap) and confirmed.equals() creates a normal iterator (not // #mapIterator()), which modifies the parent expected modCount of the map object, causing // concurrent modification exceptions. // Because of this we have assertEquals(map, confirmed), and not the other way around.