Skip to content

Commit

Permalink
Normalize getter Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Oct 31, 2023
1 parent 78a83e6 commit cbb98b0
Show file tree
Hide file tree
Showing 25 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/collections4/BagUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ public static <E> SortedBag<E> transformingSortedBag(final SortedBag<E> bag,
}

/**
* Get an empty {@code Bag}.
* Gets an empty {@code Bag}.
*
* @param <E> the element type
* @return an empty Bag
Expand All @@ -255,7 +255,7 @@ public static <E> Bag<E> emptyBag() {
}

/**
* Get an empty {@code SortedBag}.
* Gets an empty {@code SortedBag}.
*
* @param <E> the element type
* @return an empty sorted Bag
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1657,7 +1657,7 @@ public static boolean isFull(final Collection<? extends Object> collection) {
}

/**
* 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
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/collections4/MapUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 <K> the key type
* @param <V> the value type
Expand All @@ -1237,7 +1237,7 @@ public static <K, V> IterableMap<K, V> iterableMap(final Map<K, V> map) {
}

/**
* 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public static <E> MultiSet<E> predicatedMultiSet(final MultiSet<E> multiset,
}

/**
* Get an empty {@code MultiSet}.
* Gets an empty {@code MultiSet}.
*
* @param <E> the element type
* @return an empty MultiSet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public static <E> Queue<E> transformingQueue(final Queue<E> queue,
}

/**
* 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}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/collections4/SetUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ public static <T> Set<T> emptyIfNull(final Set<T> set) {


/**
* Get a typed empty unmodifiable Set.
* Gets a typed empty unmodifiable Set.
* @param <E> the element type
* @return an empty Set
*/
Expand All @@ -209,7 +209,7 @@ public static <E> Set<E> emptySet() {
}

/**
* Get a typed empty unmodifiable sorted set.
* Gets a typed empty unmodifiable sorted set.
* @param <E> the element type
* @return an empty sorted Set
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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&lt;? super V&gt;
*/
Comparator<? super V> valueComparator();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ public Collection<V> 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.
Expand All @@ -242,7 +242,7 @@ public static <K, V> IterableMap<K, V> readableMap(final Get<K, V> 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 <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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ public List<Collection<E>> getCollections() {
}

/**
* Get the collection mutator to be used for this CompositeCollection.
* Gets the collection mutator to be used for this CompositeCollection.
* @return CollectionMutator&lt;E&gt;
*/
protected CollectionMutator<E> getMutator() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* <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
Expand All @@ -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}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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&lt;Class&lt;? extends T&gt;, T&gt;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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&lt;E&gt;
*/
Expand All @@ -56,7 +56,7 @@ public static <E> ResettableIterator<E> resettableEmptyIterator() {
}

/**
* Get a typed empty iterator instance.
* Gets a typed empty iterator instance.
* @param <E> the element type
* @return Iterator&lt;E&gt;
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}&lt;E&gt;
*/
Expand All @@ -57,7 +57,7 @@ public static <E> ResettableListIterator<E> resettableEmptyListIterator() {
}

/**
* Get a typed instance of the iterator.
* Gets a typed instance of the iterator.
* @param <E> the element type
* @return {@link ListIterator}&lt;E&gt;
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}&lt;K, V&gt;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}&lt;K, V&gt;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public boolean hasNext() {
}

/**
* 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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public int previousIndex() {
}

/**
* 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.
*
Expand All @@ -110,7 +110,7 @@ public E next() {
}

/**
* 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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public void remove() {
}

/**
* Get the currently active entry.
* Gets the currently active entry.
* @return Map.Entry&lt;K, V&gt;
*/
protected synchronized Map.Entry<K, V> current() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public void visit(final CommandVisitor<T> 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.
*
Expand All @@ -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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public SequencesComparator(final List<T> sequence1, final List<T> sequence2, fin
}

/**
* 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
Expand Down Expand Up @@ -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.
* <p>
* The snake is found using the MYERS Algorithm (this algorithm has
Expand Down Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public Collection<V> values() {
}

/**
* Get a MapIterator over this Get.
* Gets a MapIterator over this Get.
* @return MapIterator&lt;K, V&gt;
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2090,15 +2090,15 @@ public void tearDown() throws Exception {
}

/**
* Get the map.
* Gets the map.
* @return Map<K, V>
*/
public Map<K, V> getMap() {
return map;
}

/**
* Get the confirmed.
* Gets the confirmed.
* @return Map<K, V>
*/
public Map<K, V> getConfirmed() {
Expand Down

0 comments on commit cbb98b0

Please sign in to comment.