EstimationProbe (bucket4j-core 8.1.1 API)

java.lang.Object
- io.github.bucket4j.EstimationProbe

All Implemented Interfaces:

ComparableByContent<EstimationProbe>
```
public class EstimationProbe
extends Object
implements ComparableByContent<EstimationProbe>
```
Describes the estimation result.

See Also:

Bucket.estimateAbilityToConsume(long), DefaultAsyncBucketProxy.estimateAbilityToConsume(long)

Field Summary

Fields
Modifier and Type Field Description

static SerializationHandle<EstimationProbe> SERIALIZATION_HANDLE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canBeConsumed()`	Flag describes result of consumption operation.
`static EstimationProbe`	`canBeConsumed(long remainingTokens)`
`static EstimationProbe`	`canNotBeConsumed(long remainingTokens, long nanosToWaitForRefill)`
`boolean`	`equalsByContent(EstimationProbe other)`
`long`	`getNanosToWaitForRefill()`	Returns zero if `canBeConsumed()` returns true, else time in nanos which need to wait until requested amount of tokens will be refilled
`long`	`getRemainingTokens()`	Return the tokens remaining in the bucket
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZATION_HANDLE
```
public static final SerializationHandle<EstimationProbe> SERIALIZATION_HANDLE
```
- Method Detail
  - canBeConsumed
```
public static EstimationProbe canBeConsumed(long remainingTokens)
```
  - canNotBeConsumed
```
public static EstimationProbe canNotBeConsumed(long remainingTokens,
                                               long nanosToWaitForRefill)
```
  - canBeConsumed
```
public boolean canBeConsumed()
```
    Flag describes result of consumption operation.
    
    Returns:
    
    true if requested tokens can be consumed
  - getRemainingTokens
```
public long getRemainingTokens()
```
    Return the tokens remaining in the bucket
    
    Returns:
    
    the tokens remaining in the bucket
  - getNanosToWaitForRefill
```
public long getNanosToWaitForRefill()
```
    Returns zero if canBeConsumed() returns true, else time in nanos which need to wait until requested amount of tokens will be refilled
    
    Returns:
    
    Zero if canBeConsumed() returns true, else time in nanos which need to wait until requested amount of tokens will be refilled
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equalsByContent
```
public boolean equalsByContent(EstimationProbe other)
```
    Specified by:
    
    equalsByContent in interface ComparableByContent<EstimationProbe>