io.lettuce.core.probabilistic.arguments

Class BfInsertArgs

java.lang.Object

io.lettuce.core.probabilistic.arguments.BfInsertArgs

All Implemented Interfaces:

CompositeArgument

public class BfInsertArgs
extends Object
implements CompositeArgument

Argument list builder for the Redis BF.INSERT command.

BfInsertArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

7.7

Author:

Yordan Tsintsov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BfInsertArgs.Builder Builder entry points for BfInsertArgs.

Constructor Summary

Constructors

Constructor and Description
BfInsertArgs()

Method Summary

Modifier and Type	Method and Description
<K,V> void	build(CommandArgs<K,V> args) Build command arguments and contribute arguments to CommandArgs.
BfInsertArgs	capacity(long capacity) Set the desired capacity of the filter.
BfInsertArgs	defaults() Set the default settings.
BfInsertArgs	error(double error) Set the desired error rate of the filter.
BfInsertArgs	expansion(long expansion) Set the expansion rate of the filter.
BfInsertArgs	noCreate() Set the no create flag.
BfInsertArgs	nonScaling() Set the non scaling flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

BfInsertArgs

public BfInsertArgs()

Method Detail

capacity

public BfInsertArgs capacity(long capacity)

Set the desired capacity of the filter.

Returns:

this BfInsertArgs.

error

public BfInsertArgs error(double error)

Set the desired error rate of the filter.

Returns:

this BfInsertArgs.

expansion

public BfInsertArgs expansion(long expansion)

Set the expansion rate of the filter.

Returns:

this BfInsertArgs.

noCreate

public BfInsertArgs noCreate()

Set the no create flag.

Returns:

this BfInsertArgs.

nonScaling

public BfInsertArgs nonScaling()

Set the non scaling flag.

Returns:

this BfInsertArgs.

defaults

public BfInsertArgs defaults()

Set the default settings.

Returns:

this BfInsertArgs.

build

public <K,V> void build(CommandArgs<K,V> args)

Description copied from interface: CompositeArgument

Build command arguments and contribute arguments to CommandArgs.

Implementing classes are required to implement this method. Depending on the command nature and configured arguments, this method may contribute arguments but is not required to add arguments if none are specified.

Specified by:

build in interface CompositeArgument

Type Parameters:

K - Key type.

V - Value type.

Parameters:

args - the command arguments, must not be null.