Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.remote

Class CommandResult<T>

java.lang.Object

io.github.bucket4j.distributed.remote.CommandResult<T>

All Implemented Interfaces:

ComparableByContent<CommandResult>

public class CommandResult<T>
extends Object
implements ComparableByContent<CommandResult>

Field Summary

Fields

Modifier and Type	Field	Description
static CommandResult<Boolean>	FALSE
static CommandResult<Long>	MAX_VALUE
static CommandResult<Nothing>	NOTHING
static SerializationHandle<CommandResult<?>>	SERIALIZATION_HANDLE
static CommandResult<Boolean>	TRUE
static CommandResult<Long>	ZERO

Constructor Summary

Constructors

Constructor	Description
CommandResult(T data, int resultTypeId)

Method Summary

Modifier and Type	Method	Description
static <R> CommandResult<R>	bucketNotFound()
static <R> CommandResult<R>	configurationNeedToBeReplaced()
static <R> CommandResult<R>	empty()
boolean	equalsByContent(CommandResult other)
T	getData()
int	getResultTypeId()
boolean	isBucketNotFound()
boolean	isConfigurationNeedToBeReplaced()
boolean	isError()
static <R> CommandResult<R>	success(R data, int resultTypeId)
static <R> CommandResult<R>	success(R data, SerializationHandle dataSerializer)
static CommandResult<?>	unsupportedNamedType(String typeName)
static CommandResult<?>	unsupportedType(int typeId)
static CommandResult<?>	usageOfObsoleteApiException(int requestedFormatNumber, int minSupportedFormatNumber)
static CommandResult<?>	usageOfUnsupportedApiException(int requestedFormatNumber, int maxSupportedFormatNumber)

Methods inherited from class java.lang.Object

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

Field Detail

NOTHING

public static final CommandResult<Nothing> NOTHING

ZERO

public static final CommandResult<Long> ZERO

MAX_VALUE

public static final CommandResult<Long> MAX_VALUE

TRUE

public static final CommandResult<Boolean> TRUE

FALSE

public static final CommandResult<Boolean> FALSE

SERIALIZATION_HANDLE

public static SerializationHandle<CommandResult<?>> SERIALIZATION_HANDLE

Constructor Detail

CommandResult

public CommandResult(T data,
                     int resultTypeId)

Method Detail

success

public static <R> CommandResult<R> success(R data,
                                           SerializationHandle dataSerializer)

success

public static <R> CommandResult<R> success(R data,
                                           int resultTypeId)

bucketNotFound

public static <R> CommandResult<R> bucketNotFound()

configurationNeedToBeReplaced

public static <R> CommandResult<R> configurationNeedToBeReplaced()

empty

public static <R> CommandResult<R> empty()

unsupportedType

public static CommandResult<?> unsupportedType(int typeId)

unsupportedNamedType

public static CommandResult<?> unsupportedNamedType(String typeName)

usageOfUnsupportedApiException

public static CommandResult<?> usageOfUnsupportedApiException(int requestedFormatNumber,
                                                              int maxSupportedFormatNumber)

usageOfObsoleteApiException

public static CommandResult<?> usageOfObsoleteApiException(int requestedFormatNumber,
                                                           int minSupportedFormatNumber)

getData

public T getData()

isBucketNotFound

public boolean isBucketNotFound()

isConfigurationNeedToBeReplaced

public boolean isConfigurationNeedToBeReplaced()

isError

public boolean isError()

getResultTypeId

public int getResultTypeId()

equalsByContent

public boolean equalsByContent(CommandResult other)

Specified by:

equalsByContent in interface ComparableByContent<T>