From f42bac45854b149735e8338f25c19c91ca4ecd0f Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sun, 23 Jun 2024 14:15:32 -0400 Subject: [PATCH] Javadoc --- .../bloomfilter/package-info.java | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java index 9305fbcfb..d251fc525 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java @@ -56,8 +56,8 @@ * *
  • extractor - The extractors are {@link FunctionalInterface}s that are conceptually iterators on a bit map, an index, or a * collection of cells, with an early termination switch. Extractors have - * names like {@link BitMapExtractor} or {@link IndexExtractor} and have a {@code processXs} methods that take a - * {@code Predicate} argument (e.g. {@link BitMapExtractor#processBitMaps()} or {@code processIndicies(IntPredicate)}). + * names like {@link org.apache.commons.collections4.bloomfilter.BitMapExtractor} or {@link org.apache.commons.collections4.bloomfilter.IndexExtractor} and have a {@code processXs} methods that take a + * {@code Predicate} argument (e.g. {@link org.apache.commons.collections4.bloomfilter.BitMapExtractor#processBitMaps(java.util.function.LongPredicate)} or {@code processIndicies(IntPredicate)}). * That predicate is expected to process each of the Xs in turn and return {@code true} if the processing should continue * or {@code false} to stop it.
  • * @@ -69,13 +69,13 @@ *

    Implementation Notes

    * *

    The architecture is designed so that the implementation of the storage of bits is abstracted. Rather than specifying a - * specific state representation we require that all Bloom filters implement the {@link BitMapExtractor} and {@link IndexExtractor} interfaces, - * Counting-based Bloom filters implement {@link CellExtractor} as well. There are static + * specific state representation we require that all Bloom filters implement the {@link org.apache.commons.collections4.bloomfilter.BitMapExtractor} and {@link org.apache.commons.collections4.bloomfilter.IndexExtractor} interfaces, + * Counting-based Bloom filters implement {@link org.apache.commons.collections4.bloomfilter.CellExtractor} as well. There are static * methods in the various Extractor interfaces to convert from one type to another.

    * - *

    Programs that utilize the Bloom filters may use the {@link BitMapExtractor} or {@link IndexExtractor} to retrieve + *

    Programs that utilize the Bloom filters may use the {@link org.apache.commons.collections4.bloomfilter.BitMapExtractor} or {@link org.apache.commons.collections4.bloomfilter.IndexExtractor} to retrieve * or process a representation of the internal structure. - * Additional methods are available in the {@link BitMaps} class to assist in manipulation of bit map representations.

    + * Additional methods are available in the {@link org.apache.commons.collections4.bloomfilter.BitMaps} class to assist in manipulation of bit map representations.

    * *

    The Bloom filter is an interface that requires implementation of 9 methods:

    *