From 7c32ff7dafe0ea5b0421e86b0bc7739d7e4d724e Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sun, 23 Jun 2024 07:57:41 -0400 Subject: [PATCH] Update Javadoc since tags --- .../collections4/bloomfilter/ArrayCountingBloomFilter.java | 2 +- .../commons/collections4/bloomfilter/BitMapExtractor.java | 2 +- .../apache/commons/collections4/bloomfilter/BitMaps.java | 2 +- .../commons/collections4/bloomfilter/BloomFilter.java | 2 +- .../collections4/bloomfilter/BloomFilterExtractor.java | 2 +- .../commons/collections4/bloomfilter/CellExtractor.java | 2 +- .../collections4/bloomfilter/CountingBloomFilter.java | 2 +- .../collections4/bloomfilter/CountingLongPredicate.java | 2 +- .../commons/collections4/bloomfilter/CountingPredicate.java | 2 +- .../collections4/bloomfilter/EnhancedDoubleHasher.java | 2 +- .../org/apache/commons/collections4/bloomfilter/Hasher.java | 2 +- .../commons/collections4/bloomfilter/IndexExtractor.java | 2 +- .../commons/collections4/bloomfilter/IndexFilter.java | 6 +++--- .../commons/collections4/bloomfilter/LayerManager.java | 2 +- .../collections4/bloomfilter/LayeredBloomFilter.java | 2 +- .../commons/collections4/bloomfilter/LongBiPredicate.java | 2 +- .../commons/collections4/bloomfilter/SetOperations.java | 2 +- .../org/apache/commons/collections4/bloomfilter/Shape.java | 2 +- .../commons/collections4/bloomfilter/SimpleBloomFilter.java | 2 +- .../commons/collections4/bloomfilter/SparseBloomFilter.java | 2 +- .../collections4/bloomfilter/WrappedBloomFilter.java | 2 +- 21 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java index aac95f77e..128858c03 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java @@ -47,7 +47,7 @@ import java.util.stream.IntStream; * * @see Shape * @see CellExtractor - * @since 4.5 + * @since 4.5.0 */ public final class ArrayCountingBloomFilter implements CountingBloomFilter { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java index 84659fc1d..76cbc7395 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java @@ -33,7 +33,7 @@ import java.util.function.LongPredicate; * The default implementations of the {@code makePredicate()} and {@code asBitMapArray} methods * are slow and should be reimplemented in the implementing classes where possible.

* - * @since 4.5 + * @since 4.5.0 */ @FunctionalInterface public interface BitMapExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BitMaps.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BitMaps.java index f08d3ad19..d89894706 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/BitMaps.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BitMaps.java @@ -22,7 +22,7 @@ package org.apache.commons.collections4.bloomfilter; *

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.

* - * @since 4.5 + * @since 4.5.0 */ public class BitMaps { /** A bit shift to apply to an integer to divided by 64 (2^6). */ diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java index b963ff6ef..3a6fe7199 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java @@ -25,7 +25,7 @@ import java.util.Objects; *

* @see BitMapExtractor * @see IndexExtractor - * @since 4.5 + * @since 4.5.0 */ public interface BloomFilter extends IndexExtractor, BitMapExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java index 7ad82713e..18e1fa1d2 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java @@ -25,7 +25,7 @@ import java.util.function.Predicate; /** * Produces Bloom filters from a collection (e.g. LayeredBloomFilter). * - * @since 4.5 + * @since 4.5.0 */ @FunctionalInterface public interface BloomFilterExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java index 6ff79374e..64a8b6631 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java @@ -38,7 +38,7 @@ import java.util.function.IntPredicate; *
  • The IndexExtractor will not generate indices that have a zero count for the cell.
  • * * - * @since 4.5 + * @since 4.5.0 */ @FunctionalInterface public interface CellExtractor extends IndexExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java index af1ef4328..a9ca13325 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java @@ -52,7 +52,7 @@ import java.util.Objects; * partially updated or updated entirely before the exception is raised.

    * * @see CellExtractor - * @since 4.5 + * @since 4.5.0 */ public interface CountingBloomFilter extends BloomFilter, CellExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java index a9e5b31af..99440e843 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingLongPredicate.java @@ -23,7 +23,7 @@ import java.util.function.LongPredicate; * if the {@code ary} is exhausted, the subsequent calls to {@code test} are executed with a zero value. * If the calls to {@code test} do not exhaust the {@code ary} the {@code processRemaining} method can be called to * execute the @{code test} with a zero value for each remaining {@code idx} value. - * @since 4.5 + * @since 4.5.0 */ class CountingLongPredicate implements LongPredicate { private int idx; diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingPredicate.java b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingPredicate.java index ba8049da7..d2594bd6d 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingPredicate.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingPredicate.java @@ -28,7 +28,7 @@ import java.util.function.Predicate; * {@code null} value for each remaining {@code idx} value. * * @param the type of object being compared. - * @since 4.5 + * @since 4.5.0 */ class CountingPredicate implements Predicate { private int idx; diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/EnhancedDoubleHasher.java b/src/main/java/org/apache/commons/collections4/bloomfilter/EnhancedDoubleHasher.java index 230187fda..830cea498 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/EnhancedDoubleHasher.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/EnhancedDoubleHasher.java @@ -42,7 +42,7 @@ import java.util.function.IntPredicate; * than the number of bits then the modulus will create a 'random' position and increment within the size. *

    * - * @since 4.5 + * @since 4.5.0 */ public class EnhancedDoubleHasher implements Hasher { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java index dcc13c711..4de30d0d6 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java @@ -20,7 +20,7 @@ package org.apache.commons.collections4.bloomfilter; * A Hasher creates IndexExtractor based on the hash implementation and the * provided Shape. * - * @since 4.5 + * @since 4.5.0 */ public interface Hasher { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexExtractor.java index d6a33537e..27e1c656c 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexExtractor.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexExtractor.java @@ -28,7 +28,7 @@ import java.util.function.LongPredicate; * The default implementation of {@code asIndexArray} is slow. Implementers should reimplement the * method where possible.

    * - * @since 4.5 + * @since 4.5.0 */ @FunctionalInterface public interface IndexExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java index 070a49fda..a6c7c5b0d 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java @@ -24,13 +24,13 @@ import java.util.function.IntPredicate; *

    If the index is negative the behavior is not defined.

    * *

    This is conceptually a unique filter implemented as an {@code IntPredicate}.

    - * @since 4.5 + * @since 4.5.0 */ public final class IndexFilter { /** * An IndexTracker implementation that uses an array of integers to track whether or not a * number has been seen. Suitable for Shapes that have few hash functions. - * @since 4.5 + * @since 4.5.0 */ static class ArrayTracker implements IntPredicate { private final int[] seen; @@ -61,7 +61,7 @@ public final class IndexFilter { /** * An IndexTracker implementation that uses an array of bit maps to track whether or not a * number has been seen. - * @since 4.5 + * @since 4.5.0 */ static class BitMapTracker implements IntPredicate { private final long[] bits; diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java index baa53ead0..2491e08b1 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java @@ -49,7 +49,7 @@ import java.util.function.Supplier; * the {@code target} filter. * * - * @since 4.5 + * @since 4.5.0 */ public class LayerManager implements BloomFilterExtractor { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java index ee39bae65..ecb18ec3a 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilter.java @@ -60,7 +60,7 @@ import java.util.function.Predicate; * it and sets the {@code target} before the operation. * * @param The type of Bloom Filter that is used for the layers. - * @since 4.5 + * @since 4.5.0 */ public class LayeredBloomFilter implements BloomFilter, BloomFilterExtractor { /** diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LongBiPredicate.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LongBiPredicate.java index 9b45a09af..6372da6bd 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/LongBiPredicate.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LongBiPredicate.java @@ -22,7 +22,7 @@ package org.apache.commons.collections4.bloomfilter; * * This is a functional interface whose functional method is {@code test(long,long)}. * - * @since 4.5 + * @since 4.5.0 */ @FunctionalInterface public interface LongBiPredicate { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/SetOperations.java b/src/main/java/org/apache/commons/collections4/bloomfilter/SetOperations.java index 54f4598fd..85040ff45 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/SetOperations.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/SetOperations.java @@ -21,7 +21,7 @@ import java.util.function.LongBinaryOperator; /** * Implementations of set operations on BitMapExtractors. * - * @since 4.5 + * @since 4.5.0 */ public final class SetOperations { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java b/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java index 2be155d8d..d490ba0e1 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java @@ -81,7 +81,7 @@ package org.apache.commons.collections4.bloomfilter; * @see Bloom Filter calculator * @see Bloom filter * [Wikipedia] - * @since 4.5 + * @since 4.5.0 */ public final class Shape { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/SimpleBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/SimpleBloomFilter.java index c5f55405e..0668ede93 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/SimpleBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/SimpleBloomFilter.java @@ -24,7 +24,7 @@ import java.util.function.LongPredicate; /** * A bloom filter using an array of bit maps to track enabled bits. This is a standard * implementation and should work well for most Bloom filters. - * @since 4.5 + * @since 4.5.0 */ public final class SimpleBloomFilter implements BloomFilter { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java index 6c0a3d147..0df154e70 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java @@ -24,7 +24,7 @@ import java.util.function.LongPredicate; /** * A bloom filter using a TreeSet of integers to track enabled bits. This is a standard * implementation and should work well for most low cardinality Bloom filters. - * @since 4.5 + * @since 4.5.0 */ public final class SparseBloomFilter implements BloomFilter { diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java index d989ceca5..bd4435f22 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java @@ -22,7 +22,7 @@ import java.util.function.LongPredicate; /** * An abstract class to assist in implementing Bloom filter decorators. * - * @since 4.5 + * @since 4.5.0 */ public abstract class WrappedBloomFilter implements BloomFilter { private final BloomFilter wrapped;