Skip to content

Commit

Permalink
Javadoc: Match since tags to past releases and the next one
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Oct 20, 2024
1 parent b5f662e commit 8a9e5e5
Show file tree
Hide file tree
Showing 31 changed files with 57 additions and 57 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -222,35 +222,35 @@ public void setCardinality(final O obj, final int count) {
/**
* The index value when an element is not found in a collection or array: {@code -1}.
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public static final int INDEX_NOT_FOUND = -1;

/**
* Default prefix used while converting an Iterator to its String representation.
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public static final String DEFAULT_TOSTRING_PREFIX = "[";

/**
* Default suffix used while converting an Iterator to its String representation.
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public static final String DEFAULT_TOSTRING_SUFFIX = "]";

/**
* A String for Colon (":").
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public static final String COLON = ":";

/**
* A String for Comma (",").
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public static final String COMMA = ",";

Expand Down Expand Up @@ -1130,7 +1130,7 @@ public static <O> Map<O, Integer> getCardinalityMap(final Iterable<? extends O>
* @param equator the equator used for generate hashCode
* @return the hash code of the input collection using the hash method of an equator
* @throws NullPointerException if the equator is {@code null}
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <E> int hashCode(final Collection<? extends E> collection,
final Equator<? super E> equator) {
Expand Down Expand Up @@ -1536,7 +1536,7 @@ public static <E> Collection<E> removeAll(final Iterable<E> collection,
* @param count the specified number to remove, can't be less than 1
* @return collection of elements that removed from the input collection
* @throws NullPointerException if input is null
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <E> Collection<E> removeCount(final Collection<E> input, int startIndex, int count) {
Objects.requireNonNull(input, "input");
Expand Down Expand Up @@ -1577,7 +1577,7 @@ public static <E> Collection<E> removeCount(final Collection<E> input, int start
* @param endIndex the end index (exclusive) to remove, must not be less than startIndex
* @return collection of elements that removed from the input collection
* @throws NullPointerException if input is null
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <E> Collection<E> removeRange(final Collection<E> input, final int startIndex, final int endIndex) {
Objects.requireNonNull(input, "input");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public class EnumerationUtils {
* @param <T> the element type
* @param enumeration the enumeration to use, may not be null
* @return a new, single use {@link Iterable}
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <T> Iterable<T> asIterable(final Enumeration<T> enumeration) {
return new IteratorIterable<>(new EnumerationIterator<>(enumeration));
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/apache/commons/collections4/ListUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ public static <E> List<E> fixedSizeList(final List<E> list) {
* @param list The list.
* @return the first element of a list.
* @see List#get(int)
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <T> T getFirst(final List<T> list) {
return Objects.requireNonNull(list, "list").get(0);
Expand All @@ -200,7 +200,7 @@ public static <T> T getFirst(final List<T> list) {
* @param list The list.
* @return the last element of a list.
* @see List#get(int)
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <T> T getLast(final List<T> list) {
return Objects.requireNonNull(list, "list").get(list.size() - 1);
Expand Down
34 changes: 17 additions & 17 deletions src/main/java/org/apache/commons/collections4/MapUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ public static <K> Boolean getBoolean(final Map<? super K, ?> map, final K key, f
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a boolean, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the boolean conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Boolean getBoolean(final Map<? super K, ?> map, final K key,
final Function<K, Boolean> defaultFunction) {
Expand Down Expand Up @@ -327,7 +327,7 @@ public static <K> boolean getBooleanValue(final Map<? super K, ?> map, final K k
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a Boolean, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> boolean getBooleanValue(final Map<? super K, ?> map, final K key,
final Function<K, Boolean> defaultFunction) {
Expand Down Expand Up @@ -381,7 +381,7 @@ public static <K> Byte getByte(final Map<? super K, ?> map, final K key, final B
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Byte getByte(final Map<? super K, ?> map, final K key, final Function<K, Byte> defaultFunction) {
return applyDefaultFunction(map, key, MapUtils::getByte, defaultFunction);
Expand Down Expand Up @@ -431,7 +431,7 @@ public static <K> byte getByteValue(final Map<? super K, ?> map, final K key, fi
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a byte, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> byte getByteValue(final Map<? super K, ?> map, final K key,
final Function<K, Byte> defaultFunction) {
Expand Down Expand Up @@ -485,7 +485,7 @@ public static <K> Double getDouble(final Map<? super K, ?> map, final K key, fin
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Double getDouble(final Map<? super K, ?> map, final K key,
final Function<K, Double> defaultFunction) {
Expand Down Expand Up @@ -536,7 +536,7 @@ public static <K> double getDoubleValue(final Map<? super K, ?> map, final K key
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a double, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> double getDoubleValue(final Map<? super K, ?> map, final K key,
final Function<K, Double> defaultFunction) {
Expand Down Expand Up @@ -590,7 +590,7 @@ public static <K> Float getFloat(final Map<? super K, ?> map, final K key, final
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Float getFloat(final Map<? super K, ?> map, final K key,
final Function<K, Float> defaultFunction) {
Expand Down Expand Up @@ -641,7 +641,7 @@ public static <K> float getFloatValue(final Map<? super K, ?> map, final K key,
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a float, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> float getFloatValue(final Map<? super K, ?> map, final K key,
final Function<K, Float> defaultFunction) {
Expand Down Expand Up @@ -680,7 +680,7 @@ public static <K> Integer getInteger(final Map<? super K, ?> map, final K key) {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Integer getInteger(final Map<? super K, ?> map, final K key,
final Function<K, Integer> defaultFunction) {
Expand Down Expand Up @@ -730,7 +730,7 @@ public static <K> int getIntValue(final Map<? super K, ?> map, final K key) {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as an int, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> int getIntValue(final Map<? super K, ?> map, final K key,
final Function<K, Integer> defaultFunction) {
Expand Down Expand Up @@ -785,7 +785,7 @@ public static <K> Long getLong(final Map<? super K, ?> map, final K key) {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Long getLong(final Map<? super K, ?> map, final K key, final Function<K, Long> defaultFunction) {
return applyDefaultFunction(map, key, MapUtils::getLong, defaultFunction);
Expand Down Expand Up @@ -834,7 +834,7 @@ public static <K> long getLongValue(final Map<? super K, ?> map, final K key) {
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a long, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> long getLongValue(final Map<? super K, ?> map, final K key,
final Function<K, Long> defaultFunction) {
Expand Down Expand Up @@ -888,7 +888,7 @@ public static <K> long getLongValue(final Map<? super K, ?> map, final K key, fi
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the map conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Map<?, ?> getMap(final Map<? super K, ?> map, final K key,
final Function<K, Map<?, ?>> defaultFunction) {
Expand Down Expand Up @@ -953,7 +953,7 @@ public static <K> Number getNumber(final Map<? super K, ?> map, final K key) {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Number getNumber(final Map<? super K, ?> map, final K key,
final Function<K, Number> defaultFunction) {
Expand Down Expand Up @@ -1043,7 +1043,7 @@ public static <K> Short getShort(final Map<? super K, ?> map, final K key) {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a number, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the number conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> Short getShort(final Map<? super K, ?> map, final K key,
final Function<K, Short> defaultFunction) {
Expand Down Expand Up @@ -1093,7 +1093,7 @@ public static <K> short getShortValue(final Map<? super K, ?> map, final K key)
* @param defaultFunction produce the default value to return if the value is null or if the conversion fails
* @return the value in the Map as a short, default value produced by the {@code defaultFunction} if null map
* input
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> short getShortValue(final Map<? super K, ?> map, final K key,
final Function<K, Short> defaultFunction) {
Expand Down Expand Up @@ -1147,7 +1147,7 @@ public static <K> String getString(final Map<? super K, ?> map, final K key) {
* @param defaultFunction what to produce the default value if the value is null or if the conversion fails
* @return the value in the map as a string, or defaultValue produced by the defaultFunction if the original value
* is null, the map is null or the string conversion fails
* @since 4.5.0
* @since 4.5.0-M1
*/
public static <K> String getString(final Map<? super K, ?> map, final K key,
final Function<K, String> defaultFunction) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
*
* @see Shape
* @see CellExtractor
* @since 4.5.0
* @since 4.5.0-M1
*/
public final class ArrayCountingBloomFilter implements CountingBloomFilter {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* classes where possible.</em>
* </p>
*
* @since 4.5.0
* @since 4.5.0-M2
*/
@FunctionalInterface
public interface BitMapExtractor {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* <p>The functions view an array of longs as a collection of bit maps each containing 64 bits. The bits are arranged
* in memory as a little-endian long value. This matches the requirements of the BitMapExtractor interface.</p>
*
* @since 4.5.0
* @since 4.5.0-M2
*/
public class BitMaps {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* @param <T> The BloomFilter type.
* @see BitMapExtractor
* @see IndexExtractor
* @since 4.5.0
* @since 4.5.0-M1
*/
public interface BloomFilter<T extends BloomFilter<T>> extends IndexExtractor, BitMapExtractor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* Produces Bloom filters from a collection (for example, {@link LayeredBloomFilter}).
*
* @since 4.5.0
* @since 4.5.0-M2
*/
@FunctionalInterface
public interface BloomFilterExtractor {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* <li>The IndexExtractor will not generate indices that have a zero count for the cell.</li>
* </ul>
*
* @since 4.5.0
* @since 4.5.0-M2
*/
@FunctionalInterface
public interface CellExtractor extends IndexExtractor {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
* partially updated or updated entirely before the exception is raised.</p>
*
* @see CellExtractor
* @since 4.5.0
* @since 4.5.0-M1
*/
public interface CountingBloomFilter extends BloomFilter<CountingBloomFilter>, CellExtractor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* than the number of bits then the modulus will create a 'random' position and increment within the size.
* </p>
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public class EnhancedDoubleHasher implements Hasher {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/**
* A Hasher creates {@link IndexExtractor}s based on the hash implementation and the provided {@link Shape}.
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public interface Hasher {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* The default implementation of {@code asIndexArray} is slow. Implementers should reimplement the
* method where possible.</em></p>
*
* @since 4.5.0
* @since 4.5.0-M2
*/
@FunctionalInterface
public interface IndexExtractor {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
*
* <p>This is conceptually a unique filter implemented as an {@link IntPredicate}.</p>
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public final class IndexFilter {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
*
*
* @param <T> the {@link BloomFilter} type.
* @since 4.5.0
* @since 4.5.0-M1
*/
public class LayerManager<T extends BloomFilter<T>> implements BloomFilterExtractor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
* </ul>
*
* @param <T> The type of Bloom Filter that is used for the layers.
* @since 4.5.0
* @since 4.5.0-M2
*/
public class LayeredBloomFilter<T extends BloomFilter<T>> implements BloomFilter<LayeredBloomFilter<T>>, BloomFilterExtractor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* This is a functional interface whose functional method is {@code test(long,long)}.
* </p>
*
* @since 4.5.0
* @since 4.5.0-M1
*/
@FunctionalInterface
public interface LongBiPredicate {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* Implementations of set operations on BitMapExtractors.
*
* @since 4.5.0
* @since 4.5.0-M1
*/
public final class SetOperations {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
* @see <a href="https://hur.st/bloomfilter">Bloom Filter calculator</a>
* @see <a href="https://en.wikipedia.org/wiki/Bloom_filter">Bloom filter
* [Wikipedia]</a>
* @since 4.5.0
* @since 4.5.0-M1
*/
public final class Shape {

Expand Down
Loading

0 comments on commit 8a9e5e5

Please sign in to comment.