edu.iu.dsc.tws.api.checkpointing

Interface Snapshot

All Known Implementing Classes:

SnapshotImpl

public interface Snapshot

Represent a snapshot persisted

Method Summary

Modifier and Type	Method and Description
boolean	checkpointAvailable(java.lang.String key) Weater a checkpoint available for a kye
java.lang.Object	get(java.lang.String key) Get the value for a key
java.lang.Object	getOrDefault(java.lang.String key, java.lang.Object defaultValue) Get the value for key or the default
long	getVersion() Returns the current version of the snapshot
void	setPacker(java.lang.String key, DataPacker dataPacker) This method can be used to define packers.
void	setValue(java.lang.String key, java.lang.Object value) This method can be used to set/update values into the snapshot
default void	setValue(java.lang.String key, java.lang.Object value, DataPacker packer) Set a value along with the packer to use for serializing the value

Method Detail

setPacker

void setPacker(java.lang.String key,
               DataPacker dataPacker)

This method can be used to define packers. Packers will be used when deserializing values. If packer is not defined for a particular value, that value will be treated as an Object and serialized with ObjectPacker

Parameters:

key - key

dataPacker - the data packer to use for the key

setValue

void setValue(java.lang.String key,
              java.lang.Object value)

This method can be used to set/update values into the snapshot

Parameters:

key - key

value - value to add

setValue

default void setValue(java.lang.String key,
                      java.lang.Object value,
                      DataPacker packer)

Set a value along with the packer to use for serializing the value

Parameters:

key - key

value - value

packer - packer

getOrDefault

java.lang.Object getOrDefault(java.lang.String key,
                              java.lang.Object defaultValue)

Get the value for key or the default

Parameters:

key - key

defaultValue - default value

Returns:

value corresponding to key

get

java.lang.Object get(java.lang.String key)

Get the value for a key

Parameters:

key - key

Returns:

value

getVersion

long getVersion()

Returns the current version of the snapshot

checkpointAvailable

boolean checkpointAvailable(java.lang.String key)

Weater a checkpoint available for a kye

Parameters:

key - key

Returns:

true if a key is available