com.ibm.cos.v2.retries.internal

Class DefaultRetryToken

java.lang.Object

com.ibm.cos.v2.retries.internal.DefaultRetryToken

All Implemented Interfaces:

RetryToken, ToCopyableBuilder<DefaultRetryToken.Builder,DefaultRetryToken>

public final class DefaultRetryToken
extends Object
implements RetryToken, ToCopyableBuilder<DefaultRetryToken.Builder,DefaultRetryToken>

A data rich RetryToken implementation. The data contained in this class is not part of the interface but is needed for the calling code to test and generate meaningful logs using its current state.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultRetryToken.Builder A builder class to create DefaultRetryToken instances or to mutate them.
static class	DefaultRetryToken.TokenState Set of possibles states on which the RetryToken can be, in-progress, succeeded and all the possible failure modes.

Method Summary

Modifier and Type	Method and Description
int	attempt() Returns the latest attempt count.
static DefaultRetryToken.Builder	builder() Returns a new builder to create new instances of the DefaultRetryToken class.
int	capacityAcquired() Returns the latest capacity acquired from the token bucket.
int	capacityRemaining() Returns the capacity remaining in the token bucket when the last acquire request was done.
String	scope() Returns the token scope.
DefaultRetryToken.TokenState	state() Returns the state of the token.
DefaultRetryToken.Builder	toBuilder() Creates a new builder to mutate the current instance.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

attempt

public int attempt()

Returns the latest attempt count.

scope

public String scope()

Returns the token scope.

capacityAcquired

public int capacityAcquired()

Returns the latest capacity acquired from the token bucket.

capacityRemaining

public int capacityRemaining()

Returns the capacity remaining in the token bucket when the last acquire request was done.

state

public DefaultRetryToken.TokenState state()

Returns the state of the token.

toBuilder

public DefaultRetryToken.Builder toBuilder()

Creates a new builder to mutate the current instance.

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultRetryToken.Builder,DefaultRetryToken>

Returns:

a builder for type T

toString

public String toString()

Overrides:

toString in class Object

builder

public static DefaultRetryToken.Builder builder()

Returns a new builder to create new instances of the DefaultRetryToken class.