Normalize getter Javadoc
This commit is contained in:
parent
78a83e662b
commit
cbb98b0f29
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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
|
||||
*/
|
||||
|
|
|
@ -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();
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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() {
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
*/
|
||||
|
|
|
@ -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>
|
||||
*/
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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>
|
||||
|
|
|
@ -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.
|
||||
*
|
||||
|
|
|
@ -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.
|
||||
*
|
||||
|
|
|
@ -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() {
|
||||
|
|
|
@ -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.
|
||||
*
|
||||
|
|
|
@ -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
|
||||
*/
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
*
|
||||
|
|
|
@ -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() {
|
||||
|
|
Loading…
Reference in New Issue