Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.proxy.optimization

Interface Optimization

All Known Implementing Classes:

BatchingOptimization, DelayOptimization, ManuallySyncingOptimization, PredictiveOptimization, SkipSyncOnZeroOptimization

public interface Optimization

Specifies request optimization strategy for BucketProxy and AsyncBucketProxy. By default an interaction with BucketProxy and AsyncBucketProxy leads to immediately request to remote storage, various implementations of Optimization interface can optimize this behavior.

See Also:

Optimizations, OptimizationListener

Field Summary

Fields

Modifier and Type	Field	Description
static Optimization	NONE_OPTIMIZED

Method Summary

Modifier and Type	Method	Description
AsyncCommandExecutor	apply(AsyncCommandExecutor originalExecutor)	Decorates command executor in order to apply optimization strategy.
CommandExecutor	apply(CommandExecutor originalExecutor)	Decorates command executor in order to apply optimization strategy.
Optimization	withListener(OptimizationListener listener)	Specifies the listener for optimization events

Field Detail

NONE_OPTIMIZED

static final Optimization NONE_OPTIMIZED

Method Detail

withListener

Optimization withListener(OptimizationListener listener)

Specifies the listener for optimization events

Parameters:

listener - the listener for optimization events

Returns:

the new instance of Optimization with configured listener

apply

CommandExecutor apply(CommandExecutor originalExecutor)

Decorates command executor in order to apply optimization strategy.

Parameters:

originalExecutor - command executor that need to be optimized

Returns:

decorated command executor

apply

AsyncCommandExecutor apply(AsyncCommandExecutor originalExecutor)

Decorates command executor in order to apply optimization strategy.

Parameters:

originalExecutor - command executor that need to be optimized

Returns:

decorated command executor