Module io.github.bucket4j.core

Package io.github.bucket4j.distributed.serialization

Interface SerializationHandle<T>

public interface SerializationHandle<T>

Method Summary

Modifier and Type	Method	Description
<I> T	deserialize(DeserializationAdapter<I> adapter, I input)
T	fromJsonCompatibleSnapshot(Map<String,Object> snapshot)
Class<T>	getSerializedType()
int	getTypeId()
String	getTypeName()
default double[]	readDoubleArray(Map<String,Object> snapshot, String fieldName)
default int	readIntValue(Map<String,Object> snapshot, String fieldName)
default long[]	readLongArray(Map<String,Object> snapshot, String fieldName)
default Long	readLongValue(Map<String,Object> snapshot, String fieldName)
default Integer	readOptionalIntValue(Map<String,Object> snapshot, String fieldName)
default Long	readOptionalLongValue(Map<String,Object> snapshot, String fieldName)
<O> void	serialize(SerializationAdapter<O> adapter, O output, T serializableObject, Version backwardCompatibilityVersion, Scope scope)
Map<String,Object>	toJsonCompatibleSnapshot(T serializableObject, Version backwardCompatibilityVersion, Scope scope)

Method Detail

deserialize

<I> T deserialize(DeserializationAdapter<I> adapter,
                  I input)
           throws IOException

Throws:

IOException

serialize

<O> void serialize(SerializationAdapter<O> adapter,
                   O output,
                   T serializableObject,
                   Version backwardCompatibilityVersion,
                   Scope scope)
            throws IOException

Throws:

IOException

getTypeId

int getTypeId()

Returns:

the type identifier that is unique across all Bucket4j classes

getSerializedType

Class<T> getSerializedType()

fromJsonCompatibleSnapshot

T fromJsonCompatibleSnapshot(Map<String,Object> snapshot)
                      throws IOException

Throws:

IOException

toJsonCompatibleSnapshot

Map<String,Object> toJsonCompatibleSnapshot(T serializableObject,
                                                  Version backwardCompatibilityVersion,
                                                  Scope scope)
                                           throws IOException

Throws:

IOException

getTypeName

String getTypeName()

Returns:

the type identifier that is unique across all Bucket4j classes

readDoubleArray

default double[] readDoubleArray(Map<String,Object> snapshot,
                                 String fieldName)

readLongArray

default long[] readLongArray(Map<String,Object> snapshot,
                             String fieldName)

readLongValue

default Long readLongValue(Map<String,Object> snapshot,
                           String fieldName)

readOptionalLongValue

default Long readOptionalLongValue(Map<String,Object> snapshot,
                                   String fieldName)

readOptionalIntValue

default Integer readOptionalIntValue(Map<String,Object> snapshot,
                                     String fieldName)

readIntValue

default int readIntValue(Map<String,Object> snapshot,
                         String fieldName)