io.github.bucket4j

Class VerboseResult<T>

java.lang.Object

io.github.bucket4j.VerboseResult<T>

All Implemented Interfaces:

ComparableByContent<VerboseResult<?>>

public class VerboseResult<T>
extends Object
implements ComparableByContent<VerboseResult<?>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VerboseResult.Diagnostics Describer of internal bucket state

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equalsByContent(VerboseResult<?> other)
BucketConfiguration	getConfiguration()
VerboseResult.Diagnostics	getDiagnostics()
long	getOperationTimeNanos()
BucketState	getState()
T	getValue()
<R> 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

Methods inherited from interface io.github.bucket4j.util.ComparableByContent

equals

Constructor Detail

VerboseResult

public VerboseResult(long operationTimeNanos,
                     T value,
                     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

getDiagnostics

public VerboseResult.Diagnostics getDiagnostics()

Returns:

internal state describer

map

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

equalsByContent

public boolean equalsByContent(VerboseResult<?> other)

Specified by:

equalsByContent in interface ComparableByContent<VerboseResult<?>>