alluxio.master.journalv0

Interface JournalFormatter

All Known Implementing Classes:

ProtoBufJournalFormatter

public interface JournalFormatter

This describes the interface for serializing and de-serializing entries in the journal.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JournalFormatter.Factory Factory for JournalFormatter.

Method Summary

Modifier and Type	Method and Description
JournalInputStream	deserialize(InputStream inputStream) Returns a JournalInputStream from the given input stream.
void	serialize(Journal.JournalEntry entry, OutputStream outputStream) Serializes the given entry and writes it to the given output stream.

Method Detail

serialize

void serialize(Journal.JournalEntry entry,
               OutputStream outputStream)
        throws IOException

Serializes the given entry and writes it to the given output stream.

Parameters:

entry - The journal entry to serialize

outputStream - the output stream to serialize the entry to

Throws:

IOException

deserialize

JournalInputStream deserialize(InputStream inputStream)
                        throws IOException

Returns a JournalInputStream from the given input stream. The returned input stream produces a stream of Journal.JournalEntry objects.

Parameters:

inputStream - The input stream to deserialize

Returns:

a JournalInputStream for reading all the journal entries in the given input stream.

Throws:

IOException