Package org.forgerock.bloomfilter

Class BloomFilters

java.lang.Object

org.forgerock.bloomfilter.BloomFilters

public final class BloomFilters
extends Object

Factory methods for creating bloom filters with various requirements.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BloomFilters.BloomFilterBuilder<T>	Builder for constructing and configuring Bloom Filter implementations.
static final class	BloomFilters.RollingBloomFilterBuilder<T>	Builder pattern for Rolling Bloom Filters, which are Scalable Bloom Filters whose elements can expire allowing space to be reclaimed over time.
static class	BloomFilters.ScalableBloomFilterBuilder<T>	Builder pattern for Scalable Bloom Filters.

Method Summary

Modifier and Type	Method	Description
static <T> BloomFilters.BloomFilterBuilder<T>	create(com.google.common.hash.Funnel<? super T> funnel)	Creates a BloomFilters.BloomFilterBuilder to begin configuration of a particular bloom filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static <T>
BloomFilters.BloomFilterBuilder<T> create(com.google.common.hash.Funnel<? super T> funnel)

Creates a BloomFilters.BloomFilterBuilder to begin configuration of a particular bloom filter.

Type Parameters:

T - the type of elements to be contained in the bloom filter.

Parameters:

funnel - the funnel to use to hash elements of the bloom filter.

Returns:

a builder object to continue configuration of the bloom filter.

See Also:

• Funnels