diff --git a/src/main/java/org/apache/commons/collections4/BagUtils.java b/src/main/java/org/apache/commons/collections4/BagUtils.java index 8b42374913..9e5066d13a 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 static SortedBag transformingSortedBag(final SortedBag bag, } /** - * Get an empty {@code Bag}. + * Gets an empty {@code Bag}. * * @param the element type * @return an empty Bag @@ -255,7 +255,7 @@ public static Bag emptyBag() { } /** - * Get an empty {@code SortedBag}. + * Gets an empty {@code SortedBag}. * * @param 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 caf178164b..97e187b71e 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 static boolean isFull(final Collection collection) { } /** - * Get the maximum number of elements that the Collection can contain. + * Gets the maximum number of elements that the Collection can contain. *

* 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 f1b9b8133b..abfb518a8a 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 static boolean isNotEmpty(final Map map) { } /** - * Get the specified {@link Map} as an {@link IterableMap}. + * Gets the specified {@link Map} as an {@link IterableMap}. * * @param the key type * @param the value type @@ -1237,7 +1237,7 @@ public static IterableMap iterableMap(final Map map) { } /** - * Get the specified {@link SortedMap} as an {@link IterableSortedMap}. + * Gets the specified {@link SortedMap} as an {@link IterableSortedMap}. * * @param the key type * @param 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 ba81ac2726..3e879d30e6 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 static MultiSet predicatedMultiSet(final MultiSet multiset, } /** - * Get an empty {@code MultiSet}. + * Gets an empty {@code MultiSet}. * * @param 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 8012a6c9a8..79ed44dccc 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 static Queue transformingQueue(final Queue queue, } /** - * Get an empty {@code Queue}. + * Gets an empty {@code Queue}. * * @param 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 42d09adcfb..70b81461bb 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 static Set emptyIfNull(final Set set) { /** - * Get a typed empty unmodifiable Set. + * Gets a typed empty unmodifiable Set. * @param the element type * @return an empty Set */ @@ -209,7 +209,7 @@ public static Set emptySet() { } /** - * Get a typed empty unmodifiable sorted set. + * Gets a typed empty unmodifiable sorted set. * @param 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 e2254ea8e6..f338b96af9 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 extends OrderedBidiMap, SortedMap 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 valueComparator(); diff --git a/src/main/java/org/apache/commons/collections4/SplitMapUtils.java b/src/main/java/org/apache/commons/collections4/SplitMapUtils.java index 0fe2ffc045..b1bf9bcafe 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 Collection values() { /** - * 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 static IterableMap readableMap(final Get get) { } /** - * 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 write-only {@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 fb06720e98..07998b79f8 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 List> getCollections() { } /** - * 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 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 e88012663a..97544b51c8 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 boolean containsAll(final Collection coll) { } /** - * Get the element associated with the given key. + * Gets the element associated with the given key. *

* 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 C get(final K key) { } /** - * 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 3f600d72eb..4c68c681e8 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 implements Transformer, Serializabl private final O iConstant; /** - * Get a typed null instance. + * Gets a typed null instance. * * @param the input type * @param 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 fc5562df0b..3f0246b5c0 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 implements Predicate, Serializable { public static final Predicate INSTANCE = new FalsePredicate<>(); /** - * Get a typed instance. + * Gets a typed instance. * * @param 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 135831adea..eaae079a89 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 implements Transformer private final Object[] iArgs; /** - * Get a typed no-arg instance. + * Gets a typed no-arg instance. * * @param 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 00663588ca..777f15ad3b 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 extends AbstractEmptyIterator implements Resett public static final Iterator INSTANCE = RESETTABLE_INSTANCE; /** - * Get a typed resettable empty iterator instance. + * Gets a typed resettable empty iterator instance. * @param the element type * @return ResettableIterator<E> */ @@ -56,7 +56,7 @@ public static ResettableIterator resettableEmptyIterator() { } /** - * Get a typed empty iterator instance. + * Gets a typed empty iterator instance. * @param 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 8a67dee781..4052097f51 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 extends AbstractEmptyIterator implements public static final ListIterator INSTANCE = RESETTABLE_INSTANCE; /** - * Get a typed instance of the iterator. + * Gets a typed instance of the iterator. * @param the element type * @return {@link ResettableListIterator}<E> */ @@ -57,7 +57,7 @@ public static ResettableListIterator resettableEmptyListIterator() { } /** - * Get a typed instance of the iterator. + * Gets a typed instance of the iterator. * @param 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 32102be37a..d26fae801d 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 extends AbstractEmptyMapIterator imple public static final MapIterator INSTANCE = new EmptyMapIterator<>(); /** - * Get a typed instance of the iterator. + * Gets a typed instance of the iterator. * @param the key type * @param 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 a6ee5cc043..f47ea0da98 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 extends AbstractEmptyMapIterator(); /** - * Get a typed instance of the iterator. + * Gets a typed instance of the iterator. * @param the key type * @param 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 3d8a89f401..d660489ef8 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 boolean hasNext() { } /** - * Get the next object from the iterator. + * Gets the next object from the iterator. *

* 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 128d402976..77cba9423c 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 int previousIndex() { } /** - * Get the next object from the iterator. + * Gets the next object from the iterator. *

* This returns the single object if it hasn't been returned yet. * @@ -110,7 +110,7 @@ public E next() { } /** - * Get the previous object from the iterator. + * Gets the previous object from the iterator. *

* 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 ebb902c84d..3e375a0987 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 void remove() { } /** - * Get the currently active entry. + * Gets the currently active entry. * @return Map.Entry<K, V> */ protected synchronized Map.Entry 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 3a0f55e41b..28f84182e8 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 void visit(final CommandVisitor visitor) { } /** - * 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 int getLCSLength() { } /** - * 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 89d940d99e..4ada1916e6 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 SequencesComparator(final List sequence1, final List sequence2, fin } /** - * Get the {@link EditScript} object. + * Gets the {@link EditScript} object. *

* 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 @@ private Snake buildSnake(final int start, final int diag, final int end1, final } /** - * Get the middle snake corresponding to two subsequences of the + * Gets the middle snake corresponding to two subsequences of the * main sequences. *

* The snake is found using the MYERS Algorithm (this algorithm has @@ -317,7 +317,7 @@ private static final class Snake { } /** - * 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 int getStart() { } /** - * 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 int getEnd() { } /** - * 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 9ab5b2f1f6..26c78003c8 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 Collection values() { } /** - * 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 d0ee12ad86..09aaa0fe57 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 void testCanonicalFullCollectionExists() { // 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 06866838c7..5d19ce181e 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 void tearDown() throws Exception { } /** - * Get the map. + * Gets the map. * @return Map */ public Map getMap() { @@ -2098,7 +2098,7 @@ public Map getMap() { } /** - * Get the confirmed. + * Gets the confirmed. * @return Map */ public Map getConfirmed() {