org.apache.kafka.server.common

Class CheckpointFile<T>

java.lang.Object

org.apache.kafka.server.common.CheckpointFile<T>

Type Parameters:

T - entry type.

public class CheckpointFile<T>
extends Object

This class represents a utility to capture a checkpoint in a file. It writes down to the file in the below format. ========= File beginning ========= version: int entries-count: int entry-as-string-on-each-line ========= File end =============== Each entry is represented as a string on each line in the checkpoint file. CheckpointFile.EntryFormatter is used to convert the entry into a string and vice versa.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckpointFile.CheckpointReadBuffer<T>
static interface	CheckpointFile.EntryFormatter<T> This is used to convert the given entry of type T into a string and vice versa.

Constructor Summary

Constructors

Constructor and Description
CheckpointFile(File file, int version, CheckpointFile.EntryFormatter<T> formatter)

Method Summary

Modifier and Type	Method and Description
List<T>	read()
void	write(Collection<T> entries)
byte[]	writeToByteArray(Collection<T> entries)
void	writeToWriter(Collection<T> entries, BufferedWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckpointFile

public CheckpointFile(File file,
                      int version,
                      CheckpointFile.EntryFormatter<T> formatter)
               throws IOException

Throws:

IOException

Method Detail

write

public void write(Collection<T> entries)
           throws IOException

Throws:

IOException

writeToByteArray

public byte[] writeToByteArray(Collection<T> entries)
                        throws IOException

Throws:

IOException

writeToWriter

public void writeToWriter(Collection<T> entries,
                          BufferedWriter writer)
                   throws IOException

Throws:

IOException

read

public List<T> read()
             throws IOException

Throws:

IOException