org.apache.tephra.snapshot

Interface SnapshotCodec

All Known Implementing Classes:

DefaultSnapshotCodec, SnapshotCodecProvider, SnapshotCodecV2, SnapshotCodecV3, SnapshotCodecV4

public interface SnapshotCodec

Interface to decode and encode a transaction snapshot. Each codec implements one version of the encoding. It need not include the version when encoding the snapshot.

Method Summary

Methods

Modifier and Type	Method and Description
TransactionSnapshot	decode(InputStream in) Decode a transaction snapshot from an input stream.
TransactionVisibilityState	decodeTransactionVisibilityState(InputStream in) Decode transaction visibility state from an input stream.
void	encode(OutputStream out, TransactionSnapshot snapshot) Encode a transaction snapshot into an output stream.
int	getVersion()

Method Detail

getVersion

int getVersion()

Returns:

the version of the encoding implemented by the codec.

encode

void encode(OutputStream out,
          TransactionSnapshot snapshot)

Encode a transaction snapshot into an output stream.

Parameters:

out - the output stream to write to

snapshot - the snapshot to encode

decode

TransactionSnapshot decode(InputStream in)

Decode a transaction snapshot from an input stream.

Parameters:

in - the input stream to read from

Returns:

the decoded snapshot

decodeTransactionVisibilityState

TransactionVisibilityState decodeTransactionVisibilityState(InputStream in)

Decode transaction visibility state from an input stream.

Parameters:

in - the input stream to read from

Returns:

TransactionVisibilityState