org.redisson.api

Interface RBloomFilter<T>

Type Parameters:

T - - type of object

All Superinterfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync

All Known Implementing Classes:

RedissonBloomFilter

public interface RBloomFilter<T>
extends RExpirable

Bloom filter based on Highway 128-bit hash.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
boolean	add(T object)
boolean	contains(T object)
long	count() Calculates probabilistic number of elements already added to Bloom filter.
long	getExpectedInsertions()
double	getFalseProbability()
int	getHashIterations()
long	getSize() Returns number of bits in Redis memory required by this instance
boolean	tryInit(long expectedInsertions, double falseProbability) Initializes Bloom filter params (size and hashIterations) calculated from expectedInsertions and falseProbability Stores config to Redis server.

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

copy, delete, getCodec, getName, isExists, migrate, move, rename, renamenx, touch, unlink

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, touchAsync, unlinkAsync

Method Detail

add

boolean add(T object)

contains

boolean contains(T object)

tryInit

boolean tryInit(long expectedInsertions,
                double falseProbability)

Initializes Bloom filter params (size and hashIterations) calculated from expectedInsertions and falseProbability Stores config to Redis server.

Parameters:

expectedInsertions - - expected amount of insertions

falseProbability - - expected false probability

Returns:

true if Bloom filter initialized false if Bloom filter already has been initialized

getExpectedInsertions

long getExpectedInsertions()

getFalseProbability

double getFalseProbability()

getSize

long getSize()

Returns number of bits in Redis memory required by this instance

Returns:

number of bits

getHashIterations

int getHashIterations()

count

long count()

Calculates probabilistic number of elements already added to Bloom filter.

Returns:

probabilistic number of elements