From 32c68b7e8977785bc2b450a5ed5c8356ff21e4e7 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sat, 11 Nov 2023 16:12:11 -0500 Subject: [PATCH] Javadoc --- .../commons/collections4/FluentIterable.java | 2 +- .../comparators/ComparatorChain.java | 10 +++++----- .../collections4/iterators/ArrayIterator.java | 2 +- .../iterators/ArrayListIterator.java | 2 +- .../collections4/iterators/IteratorChain.java | 4 ++-- .../iterators/ObjectArrayIterator.java | 2 +- .../iterators/ObjectArrayListIterator.java | 2 +- .../collections4/map/PassiveExpiringMap.java | 16 ++++++++-------- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java b/src/main/java/org/apache/commons/collections4/FluentIterable.java index 0b6d28b81d..7f6d6552a7 100644 --- a/src/main/java/org/apache/commons/collections4/FluentIterable.java +++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java @@ -107,7 +107,7 @@ public static FluentIterable of(final T... elements) { } /** - * Construct a new FluentIterable from the provided iterable. If the + * Constructs a new FluentIterable from the provided iterable. If the * iterable is already an instance of FluentIterable, the instance * will be returned instead. *

diff --git a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java index 2d2cdf463c..237aacf61f 100644 --- a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java +++ b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java @@ -64,7 +64,7 @@ public class ComparatorChain implements Comparator, Serializable { private boolean isLocked; /** - * Construct a ComparatorChain with no Comparators. + * Constructs a ComparatorChain with no Comparators. * You must add at least one Comparator before calling * the compare(Object,Object) method, or an * UnsupportedOperationException is thrown @@ -74,7 +74,7 @@ public ComparatorChain() { } /** - * Construct a ComparatorChain with a single Comparator, + * Constructs a ComparatorChain with a single Comparator, * sorting in the forward order * * @param comparator First comparator in the Comparator chain @@ -84,7 +84,7 @@ public ComparatorChain(final Comparator comparator) { } /** - * Construct a Comparator chain with a single Comparator, + * Constructs a Comparator chain with a single Comparator, * sorting in the given order * * @param comparator First Comparator in the ComparatorChain @@ -100,7 +100,7 @@ public ComparatorChain(final Comparator comparator, final boolean reverse) { } /** - * Construct a ComparatorChain from the Comparators in the + * Constructs a ComparatorChain from the Comparators in the * List. All Comparators will default to the forward * sort order. * @@ -112,7 +112,7 @@ public ComparatorChain(final List> list) { } /** - * Construct a ComparatorChain from the Comparators in the + * Constructs a ComparatorChain from the Comparators in the * given List. The sort order of each column will be * drawn from the given BitSet. When determining the sort * order for Comparator at index i in the List, diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java index fa06ecdd10..37d3e4602d 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java @@ -73,7 +73,7 @@ public ArrayIterator(final Object array, final int startIndex) { } /** - * Construct an ArrayIterator that will iterate over a range of values + * Constructs an ArrayIterator that will iterate over a range of values * in the specified array. * * @param array the array to iterate over. 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 d605934812..fb4d4609bb 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java @@ -77,7 +77,7 @@ public ArrayListIterator(final Object array, final int startIndex) { } /** - * Construct an ArrayListIterator that will iterate over a range of values + * Constructs an ArrayListIterator that will iterate over a range of values * in the specified array. * * @param array the array to iterate over diff --git a/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java b/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java index 61b8ba8a94..1d50fb9fce 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java +++ b/src/main/java/org/apache/commons/collections4/iterators/IteratorChain.java @@ -70,7 +70,7 @@ public class IteratorChain implements Iterator { private boolean isLocked; /** - * Construct an IteratorChain with no Iterators. + * Constructs an IteratorChain with no Iterators. *

* You will normally use {@link #addIterator(Iterator)} to add some * iterators after using this constructor. @@ -79,7 +79,7 @@ public IteratorChain() { } /** - * Construct an IteratorChain with a single Iterator. + * Constructs an IteratorChain with a single Iterator. *

* This method takes one iterator. The newly constructed iterator will * iterate through that iterator. Thus calling this constructor on its own diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java index 25433eb29b..68b68e348b 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java @@ -68,7 +68,7 @@ public ObjectArrayIterator(final E[] array, final int start) { } /** - * Construct an ObjectArrayIterator that will iterate over a range of values + * Constructs an ObjectArrayIterator that will iterate over a range of values * in the specified array. * * @param array the array to iterate over 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 816d563638..11ed746397 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java @@ -72,7 +72,7 @@ public ObjectArrayListIterator(final E[] array, final int start) { } /** - * Construct an ObjectArrayListIterator that will iterate over a range of values + * Constructs an ObjectArrayListIterator that will iterate over a range of values * in the specified array. * * @param array the array to iterate over diff --git a/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java b/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java index b922e51859..53fa4ab4e2 100644 --- a/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java +++ b/src/main/java/org/apache/commons/collections4/map/PassiveExpiringMap.java @@ -91,7 +91,7 @@ public ConstantTimeToLiveExpirationPolicy() { } /** - * Construct a policy with the given time-to-live constant measured in + * Constructs a policy with the given time-to-live constant measured in * milliseconds. A negative time-to-live value indicates entries never * expire. A zero time-to-live value indicates entries expire (nearly) * immediately. @@ -106,7 +106,7 @@ public ConstantTimeToLiveExpirationPolicy(final long timeToLiveMillis) { } /** - * Construct a policy with the given time-to-live constant measured in + * Constructs a policy with the given time-to-live constant measured in * the given time unit of measure. * * @param timeToLive the constant amount of time an entry is available @@ -210,7 +210,7 @@ public PassiveExpiringMap() { } /** - * Construct a map decorator using the given expiration policy to determine + * Constructs a map decorator using the given expiration policy to determine * expiration times. * * @param expiringPolicy the policy used to determine expiration times of @@ -222,7 +222,7 @@ public PassiveExpiringMap(final ExpirationPolicy expiringPolicy) { } /** - * Construct a map decorator that decorates the given map and uses the given + * Constructs a map decorator that decorates the given map and uses the given * expiration policy to determine expiration times. If there are any * elements already in the map being decorated, they will NEVER expire * unless they are replaced. @@ -239,7 +239,7 @@ public PassiveExpiringMap(final ExpirationPolicy expiringPolicy, } /** - * Construct a map decorator that decorates the given map using the given + * Constructs a map decorator that decorates the given map using the given * time-to-live value measured in milliseconds to create and use a * {@link ConstantTimeToLiveExpirationPolicy} expiration policy. * @@ -254,7 +254,7 @@ public PassiveExpiringMap(final long timeToLiveMillis) { } /** - * Construct a map decorator using the given time-to-live value measured in + * Constructs a map decorator using the given time-to-live value measured in * milliseconds to create and use a * {@link ConstantTimeToLiveExpirationPolicy} expiration policy. If there * are any elements already in the map being decorated, they will NEVER @@ -273,7 +273,7 @@ public PassiveExpiringMap(final long timeToLiveMillis, final Map map) { } /** - * Construct a map decorator using the given time-to-live value measured in + * Constructs a map decorator using the given time-to-live value measured in * the given time units of measure to create and use a * {@link ConstantTimeToLiveExpirationPolicy} expiration policy. * @@ -289,7 +289,7 @@ public PassiveExpiringMap(final long timeToLive, final TimeUnit timeUnit) { } /** - * Construct a map decorator that decorates the given map using the given + * Constructs a map decorator that decorates the given map using the given * time-to-live value measured in the given time units of measure to create * {@link ConstantTimeToLiveExpirationPolicy} expiration policy. This policy * is used to determine expiration times. If there are any elements already