This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new cbb98b0f2 Normalize getter Javadoc
cbb98b0f2 is described below
commit cbb98b0f29082a9f1626317ddd5c9edbfe202692
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 06:48:09 2023 -0400
Normalize getter Javadoc
---
src/main/java/org/apache/commons/collections4/BagUtils.java | 4 ++--
.../java/org/apache/commons/collections4/CollectionUtils.java | 2 +-
src/main/java/org/apache/commons/collections4/MapUtils.java | 4 ++--
.../java/org/apache/commons/collections4/MultiSetUtils.java | 2 +-
src/main/java/org/apache/commons/collections4/QueueUtils.java | 2 +-
src/main/java/org/apache/commons/collections4/SetUtils.java | 4 ++--
.../java/org/apache/commons/collections4/SortedBidiMap.java | 2 +-
.../java/org/apache/commons/collections4/SplitMapUtils.java | 4 ++--
.../commons/collections4/collection/CompositeCollection.java | 2 +-
.../commons/collections4/collection/IndexedCollection.java | 4 ++--
.../commons/collections4/functors/ConstantTransformer.java | 2 +-
.../apache/commons/collections4/functors/FalsePredicate.java | 2 +-
.../commons/collections4/functors/InstantiateTransformer.java | 2 +-
.../apache/commons/collections4/iterators/EmptyIterator.java | 4 ++--
.../commons/collections4/iterators/EmptyListIterator.java | 4 ++--
.../commons/collections4/iterators/EmptyMapIterator.java | 2 +-
.../collections4/iterators/EmptyOrderedMapIterator.java | 2 +-
.../commons/collections4/iterators/SingletonIterator.java | 2 +-
.../commons/collections4/iterators/SingletonListIterator.java | 4 ++--
.../commons/collections4/map/EntrySetToMapIteratorAdapter.java | 2 +-
.../org/apache/commons/collections4/sequence/EditScript.java | 4 ++--
.../commons/collections4/sequence/SequencesComparator.java | 10 +++++-----
.../collections4/splitmap/AbstractIterableGetMapDecorator.java | 2 +-
.../org/apache/commons/collections4/AbstractObjectTest.java | 2 +-
.../org/apache/commons/collections4/map/AbstractMapTest.java | 4 ++--
25 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/BagUtils.java
b/src/main/java/org/apache/commons/collections4/BagUtils.java
index 8b4237491..9e5066d13 100644
--- a/src/main/java/org/apache/commons/collections4/BagUtils.java
+++ b/src/main/java/org/apache/commons/collections4/BagUtils.java
@@ -244,7 +244,7 @@ public class BagUtils {
}
/**
- * Get an empty {@code Bag}.
+ * Gets an empty {@code Bag}.
*
* @param <E> the element type
* @return an empty Bag
@@ -255,7 +255,7 @@ public class BagUtils {
}
/**
- * Get an empty {@code SortedBag}.
+ * Gets an empty {@code SortedBag}.
*
* @param <E> the element type
* @return an empty sorted Bag
diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
index caf178164..97e187b71 100644
--- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
+++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
@@ -1657,7 +1657,7 @@ public class CollectionUtils {
}
/**
- * Get the maximum number of elements that the Collection can contain.
+ * Gets the maximum number of elements that the Collection can contain.
* <p>
* This method uses the {@link BoundedCollection} interface to determine
the
* maximum size. If the collection does not implement this interface then
diff --git a/src/main/java/org/apache/commons/collections4/MapUtils.java
b/src/main/java/org/apache/commons/collections4/MapUtils.java
index f1b9b8133..abfb518a8 100644
--- a/src/main/java/org/apache/commons/collections4/MapUtils.java
+++ b/src/main/java/org/apache/commons/collections4/MapUtils.java
@@ -1220,7 +1220,7 @@ public class MapUtils {
}
/**
- * Get the specified {@link Map} as an {@link IterableMap}.
+ * Gets the specified {@link Map} as an {@link IterableMap}.
*
* @param <K> the key type
* @param <V> the value type
@@ -1237,7 +1237,7 @@ public class MapUtils {
}
/**
- * Get the specified {@link SortedMap} as an {@link IterableSortedMap}.
+ * Gets the specified {@link SortedMap} as an {@link IterableSortedMap}.
*
* @param <K> the key type
* @param <V> the value type
diff --git a/src/main/java/org/apache/commons/collections4/MultiSetUtils.java
b/src/main/java/org/apache/commons/collections4/MultiSetUtils.java
index ba81ac272..3e879d30e 100644
--- a/src/main/java/org/apache/commons/collections4/MultiSetUtils.java
+++ b/src/main/java/org/apache/commons/collections4/MultiSetUtils.java
@@ -104,7 +104,7 @@ public class MultiSetUtils {
}
/**
- * Get an empty {@code MultiSet}.
+ * Gets an empty {@code MultiSet}.
*
* @param <E> the element type
* @return an empty MultiSet
diff --git a/src/main/java/org/apache/commons/collections4/QueueUtils.java
b/src/main/java/org/apache/commons/collections4/QueueUtils.java
index 8012a6c9a..79ed44dcc 100644
--- a/src/main/java/org/apache/commons/collections4/QueueUtils.java
+++ b/src/main/java/org/apache/commons/collections4/QueueUtils.java
@@ -126,7 +126,7 @@ public class QueueUtils {
}
/**
- * Get an empty {@code Queue}.
+ * Gets an empty {@code Queue}.
*
* @param <E> the type of the elements in the queue
* @return an empty {@link Queue}
diff --git a/src/main/java/org/apache/commons/collections4/SetUtils.java
b/src/main/java/org/apache/commons/collections4/SetUtils.java
index 42d09adcf..70b81461b 100644
--- a/src/main/java/org/apache/commons/collections4/SetUtils.java
+++ b/src/main/java/org/apache/commons/collections4/SetUtils.java
@@ -200,7 +200,7 @@ public class SetUtils {
/**
- * Get a typed empty unmodifiable Set.
+ * Gets a typed empty unmodifiable Set.
* @param <E> the element type
* @return an empty Set
*/
@@ -209,7 +209,7 @@ public class SetUtils {
}
/**
- * Get a typed empty unmodifiable sorted set.
+ * Gets a typed empty unmodifiable sorted set.
* @param <E> the element type
* @return an empty sorted Set
*/
diff --git a/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
b/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
index e2254ea8e..f338b96af 100644
--- a/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
@@ -52,7 +52,7 @@ public interface SortedBidiMap<K, V> extends
OrderedBidiMap<K, V>, SortedMap<K,
SortedBidiMap<V, K> inverseBidiMap();
/**
- * Get the comparator used for the values in the value-to-key map aspect.
+ * Gets the comparator used for the values in the value-to-key map aspect.
* @return Comparator<? super V>
*/
Comparator<? super V> valueComparator();
diff --git a/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
b/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
index 0fe2ffc04..b1bf9bcaf 100644
--- a/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
+++ b/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
@@ -220,7 +220,7 @@ public class SplitMapUtils {
/**
- * Get the specified {@link Get} as an instance of {@link IterableMap}.
+ * Gets the specified {@link Get} as an instance of {@link IterableMap}.
* If {@code get} implements {@link IterableMap} directly, no conversion
will take place.
* If {@code get} implements {@link Map} but not {@link IterableMap} it
will be decorated.
* Otherwise, an {@link Unmodifiable} {@link IterableMap} will be returned.
@@ -242,7 +242,7 @@ public class SplitMapUtils {
}
/**
- * Get the specified {@link Put} as an instanceof {@link Map}.
+ * Gets the specified {@link Put} as an instanceof {@link Map}.
* If {@code put} implements {@link Map} directly, no conversion will take
place.
* Otherwise, a <em>write-only</em> {@link Map} will be returned. On such
a {@link Map}
* it is recommended that the result of #put(K, V) be discarded as it
likely will not
diff --git
a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
index fb06720e9..07998b79f 100644
---
a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
+++
b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
@@ -443,7 +443,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
}
/**
- * Get the collection mutator to be used for this CompositeCollection.
+ * Gets the collection mutator to be used for this CompositeCollection.
* @return CollectionMutator<E>
*/
protected CollectionMutator<E> getMutator() {
diff --git
a/src/main/java/org/apache/commons/collections4/collection/IndexedCollection.java
b/src/main/java/org/apache/commons/collections4/collection/IndexedCollection.java
index e88012663..97544b51c 100644
---
a/src/main/java/org/apache/commons/collections4/collection/IndexedCollection.java
+++
b/src/main/java/org/apache/commons/collections4/collection/IndexedCollection.java
@@ -170,7 +170,7 @@ public class IndexedCollection<K, C> extends
AbstractCollectionDecorator<C> {
}
/**
- * Get the element associated with the given key.
+ * Gets the element associated with the given key.
* <p>
* In case of a non-unique index, this method will return the first
* value associated with the given key. To retrieve all elements associated
@@ -187,7 +187,7 @@ public class IndexedCollection<K, C> extends
AbstractCollectionDecorator<C> {
}
/**
- * Get all elements associated with the given key.
+ * Gets all elements associated with the given key.
*
* @param key key to look up
* @return a collection of elements found, or null if {@code contains(key)
== false}
diff --git
a/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java
b/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java
index 3f600d72e..4c68c681e 100644
---
a/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java
+++
b/src/main/java/org/apache/commons/collections4/functors/ConstantTransformer.java
@@ -43,7 +43,7 @@ public class ConstantTransformer<I, O> implements
Transformer<I, O>, Serializabl
private final O iConstant;
/**
- * Get a typed null instance.
+ * Gets a typed null instance.
*
* @param <I> the input type
* @param <O> the output type
diff --git
a/src/main/java/org/apache/commons/collections4/functors/FalsePredicate.java
b/src/main/java/org/apache/commons/collections4/functors/FalsePredicate.java
index fc5562df0..3f0246b5c 100644
--- a/src/main/java/org/apache/commons/collections4/functors/FalsePredicate.java
+++ b/src/main/java/org/apache/commons/collections4/functors/FalsePredicate.java
@@ -35,7 +35,7 @@ public final class FalsePredicate<T> implements Predicate<T>,
Serializable {
public static final Predicate INSTANCE = new FalsePredicate<>();
/**
- * Get a typed instance.
+ * Gets a typed instance.
*
* @param <T> the type that the predicate queries
* @return the singleton instance
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 135831ade..eaae079a8 100644
---
a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java
+++
b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java
@@ -45,7 +45,7 @@ public class InstantiateTransformer<T> implements
Transformer<Class<? extends T>
private final Object[] iArgs;
/**
- * Get a typed no-arg instance.
+ * Gets a typed no-arg instance.
*
* @param <T> the type of the objects to be created
* @return Transformer<Class<? extends T>, T>
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java
index 00663588c..777f15ad3 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java
@@ -47,7 +47,7 @@ public class EmptyIterator<E> extends
AbstractEmptyIterator<E> implements Resett
public static final Iterator INSTANCE = RESETTABLE_INSTANCE;
/**
- * Get a typed resettable empty iterator instance.
+ * Gets a typed resettable empty iterator instance.
* @param <E> the element type
* @return ResettableIterator<E>
*/
@@ -56,7 +56,7 @@ public class EmptyIterator<E> extends
AbstractEmptyIterator<E> implements Resett
}
/**
- * Get a typed empty iterator instance.
+ * Gets a typed empty iterator instance.
* @param <E> the element type
* @return Iterator<E>
*/
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java
index 8a67dee78..4052097f5 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java
@@ -48,7 +48,7 @@ public class EmptyListIterator<E> extends
AbstractEmptyIterator<E> implements
public static final ListIterator INSTANCE = RESETTABLE_INSTANCE;
/**
- * Get a typed instance of the iterator.
+ * Gets a typed instance of the iterator.
* @param <E> the element type
* @return {@link ResettableListIterator}<E>
*/
@@ -57,7 +57,7 @@ public class EmptyListIterator<E> extends
AbstractEmptyIterator<E> implements
}
/**
- * Get a typed instance of the iterator.
+ * Gets a typed instance of the iterator.
* @param <E> the element type
* @return {@link ListIterator}<E>
*/
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
index 32102be37..d26fae801 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
@@ -37,7 +37,7 @@ public class EmptyMapIterator<K, V> extends
AbstractEmptyMapIterator<K, V> imple
public static final MapIterator INSTANCE = new EmptyMapIterator<>();
/**
- * Get a typed instance of the iterator.
+ * Gets a typed instance of the iterator.
* @param <K> the key type
* @param <V> the value type
* @return {@link MapIterator}<K, V>
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
index a6ee5cc04..f47ea0da9 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
@@ -37,7 +37,7 @@ public class EmptyOrderedMapIterator<K, V> extends
AbstractEmptyMapIterator<K, V
public static final OrderedMapIterator INSTANCE = new
EmptyOrderedMapIterator<>();
/**
- * Get a typed instance of the iterator.
+ * Gets a typed instance of the iterator.
* @param <K> the key type
* @param <V> the value type
* @return {@link OrderedMapIterator}<K, V>
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java
index 3d8a89f40..d660489ef 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java
@@ -75,7 +75,7 @@ public class SingletonIterator<E>
}
/**
- * Get the next object from the iterator.
+ * Gets the next object from the iterator.
* <p>
* This returns the single object if it hasn't been returned yet.
*
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
index 128d40297..77cba9423 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
@@ -91,7 +91,7 @@ public class SingletonListIterator<E> implements
ResettableListIterator<E> {
}
/**
- * Get the next object from the iterator.
+ * Gets the next object from the iterator.
* <p>
* This returns the single object if it hasn't been returned yet.
*
@@ -110,7 +110,7 @@ public class SingletonListIterator<E> implements
ResettableListIterator<E> {
}
/**
- * Get the previous object from the iterator.
+ * Gets the previous object from the iterator.
* <p>
* This returns the single object if it has been returned.
*
diff --git
a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
index ebb902c84..3e375a098 100644
---
a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
+++
b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
@@ -110,7 +110,7 @@ public class EntrySetToMapIteratorAdapter<K, V> implements
MapIterator<K, V>, Re
}
/**
- * Get the currently active entry.
+ * Gets the currently active entry.
* @return Map.Entry<K, V>
*/
protected synchronized Map.Entry<K, V> current() {
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
b/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
index 3a0f55e41..28f84182e 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/EditScript.java
@@ -110,7 +110,7 @@ public class EditScript<T> {
}
/**
- * Get the length of the Longest Common Subsequence (LCS). The length of
the
+ * Gets the length of the Longest Common Subsequence (LCS). The length of
the
* longest common subsequence is the number of {@link KeepCommand keep
* commands} in the script.
*
@@ -121,7 +121,7 @@ public class EditScript<T> {
}
/**
- * Get the number of effective modifications. The number of effective
+ * Gets the number of effective modifications. The number of effective
* modification is the number of {@link DeleteCommand delete} and
* {@link InsertCommand insert} commands in the script.
*
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
b/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
index 89d940d99..4ada1916e 100644
---
a/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
+++
b/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java
@@ -115,7 +115,7 @@ public class SequencesComparator<T> {
}
/**
- * Get the {@link EditScript} object.
+ * Gets the {@link EditScript} object.
* <p>
* It is guaranteed that the objects embedded in the {@link InsertCommand
* insert commands} come from the second sequence and that the objects
@@ -153,7 +153,7 @@ public class SequencesComparator<T> {
}
/**
- * Get the middle snake corresponding to two subsequences of the
+ * Gets the middle snake corresponding to two subsequences of the
* main sequences.
* <p>
* The snake is found using the MYERS Algorithm (this algorithm has
@@ -317,7 +317,7 @@ public class SequencesComparator<T> {
}
/**
- * Get the start index of the snake.
+ * Gets the start index of the snake.
*
* @return start index of the snake
*/
@@ -326,7 +326,7 @@ public class SequencesComparator<T> {
}
/**
- * Get the end index of the snake.
+ * Gets the end index of the snake.
*
* @return end index of the snake
*/
@@ -335,7 +335,7 @@ public class SequencesComparator<T> {
}
/**
- * Get the diagonal number of the snake.
+ * Gets the diagonal number of the snake.
*
* @return diagonal number of the snake
*/
diff --git
a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
index 9ab5b2f1f..26c78003c 100644
---
a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
@@ -108,7 +108,7 @@ public class AbstractIterableGetMapDecorator<K, V>
implements IterableGet<K, V>
}
/**
- * Get a MapIterator over this Get.
+ * Gets a MapIterator over this Get.
* @return MapIterator<K, V>
*/
@Override
diff --git
a/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java
b/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java
index d0ee12ad8..09aaa0fe5 100644
--- a/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java
+++ b/src/test/java/org/apache/commons/collections4/AbstractObjectTest.java
@@ -215,7 +215,7 @@ public abstract class AbstractObjectTest extends BulkTest {
// protected implementation
/**
- * Get the version of Collections that this object tries to
+ * Gets the version of Collections that this object tries to
* maintain serialization compatibility with. Defaults to 4, due to
* the package change to collections4 introduced in version 4.
*
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 06866838c..5d19ce181 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
@@ -2090,7 +2090,7 @@ public abstract class AbstractMapTest<K, V> extends
AbstractObjectTest {
}
/**
- * Get the map.
+ * Gets the map.
* @return Map<K, V>
*/
public Map<K, V> getMap() {
@@ -2098,7 +2098,7 @@ public abstract class AbstractMapTest<K, V> extends
AbstractObjectTest {
}
/**
- * Get the confirmed.
+ * Gets the confirmed.
* @return Map<K, V>
*/
public Map<K, V> getConfirmed() {
