io.github.bucket4j

Class VerboseResult<T extends Serializable>

java.lang.Object

io.github.bucket4j.VerboseResult<T>

All Implemented Interfaces:

Serializable

public class VerboseResult<T extends Serializable>
extends Object
implements Serializable

Intention of this class is to provide wrapper around results returned by any method of VerboseBucket and AsyncVerboseBucket.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SerializationHandle<VerboseResult<?>>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor and Description
VerboseResult(long operationTimeNanos, T value, BucketConfiguration configuration, BucketState state)

Method Summary

Modifier and Type	Method and Description
BucketConfiguration	getConfiguration()
long	getOperationTimeNanos()
BucketState	getState()
T	getValue()
<R extends Serializable> VerboseResult<R>	map(Function<T,R> mapper)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<VerboseResult<?>> SERIALIZATION_HANDLE

Constructor Detail

VerboseResult

public VerboseResult(long operationTimeNanos,
                     T value,
                     BucketConfiguration configuration,
                     BucketState state)

Method Detail

getValue

public T getValue()

Returns:

result of operation with bucket

getConfiguration

public BucketConfiguration getConfiguration()

Returns:

snapshot of configuration which was actual at operation time

getState

public BucketState getState()

Returns:

snapshot of internal bucket state which was actual at operation time

getOperationTimeNanos

public long getOperationTimeNanos()

Returns:

time which was used by the bucket at the moment of handling a request

map

public <R extends Serializable> VerboseResult<R> map(Function<T,R> mapper)