com.spotify.sparkey

Class Sparkey

java.lang.Object

com.spotify.sparkey.Sparkey

public final class Sparkey
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static SparkeyWriter	append(File file) Opens an existing file for append.
static SparkeyWriter	appendOrCreate(File file, CompressionType compressionType, int compressionBlockSize) Opens an existing file for append, or create a new one if it doesn't exist.
static SparkeyWriter	createNew(File file) Creates a new sparkey writer without any compression.
static SparkeyWriter	createNew(File file, CompressionType compressionType, int compressionBlockSize) Creates a new sparkey writer with the specified compression This is not a thread-safe class, only use it from one thread.
static File	getIndexFile(File file) Sets the file ending of the file to .spi (the index filename convention)
static IndexHeader	getIndexHeader(File file) Extract the header information from the index file.
static File	getLogFile(File file) Sets the file ending of the file to .spl (the log filename convention)
static LogHeader	getLogHeader(File file) Extract the header information from the log file.
static SparkeyReader	open(File file) Open a new sparkey reader This is not a thread-safe class, only use it from one thread.
static void	writeHash(File file) Write (or rewrite) the index file for a given sparkey file.
static void	writeHash(File file, HashType hashType) Write (or rewrite) the index file for a given sparkey file.

Methods inherited from class java.lang.Object

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

Method Detail

createNew

public static SparkeyWriter createNew(File file)
                               throws IOException

Creates a new sparkey writer without any compression. This is not a thread-safe class, only use it from one thread.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

Returns:

a new writer,

Throws:

IOException

createNew

public static SparkeyWriter createNew(File file,
                      CompressionType compressionType,
                      int compressionBlockSize)
                               throws IOException

Creates a new sparkey writer with the specified compression This is not a thread-safe class, only use it from one thread.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

compressionType -

compressionBlockSize - The maximum compression block size in bytes

Returns:

a new writer,

Throws:

IOException

append

public static SparkeyWriter append(File file)
                            throws IOException

Opens an existing file for append. This is not a thread-safe class, only use it from one thread.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

Returns:

a new writer,

Throws:

IOException

appendOrCreate

public static SparkeyWriter appendOrCreate(File file,
                           CompressionType compressionType,
                           int compressionBlockSize)
                                    throws IOException

Opens an existing file for append, or create a new one if it doesn't exist. The compression settings will only apply for new files. This is not a thread-safe class, only use it from one thread.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

compressionType -

compressionBlockSize - The maximum compression block size in bytes

Returns:

a new writer,

Throws:

IOException

open

public static SparkeyReader open(File file)
                          throws IOException

Open a new sparkey reader This is not a thread-safe class, only use it from one thread.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

Returns:

a new reader,

Throws:

IOException

writeHash

public static void writeHash(File file)
                      throws IOException

Write (or rewrite) the index file for a given sparkey file.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

Throws:

IOException

writeHash

public static void writeHash(File file,
             HashType hashType)
                      throws IOException

Write (or rewrite) the index file for a given sparkey file.

Parameters:

file - File base to use, the actual file endings will be set to .spi and .spl

hashType - choice of hash type, can be 32 or 64 bits.

Throws:

IOException

getLogFile

public static File getLogFile(File file)

Sets the file ending of the file to .spl (the log filename convention)

Parameters:

file -

Returns:

a file object with .spl as file ending

getIndexFile

public static File getIndexFile(File file)

Sets the file ending of the file to .spi (the index filename convention)

Parameters:

file -

Returns:

a file object with .spi as file ending

getIndexHeader

public static IndexHeader getIndexHeader(File file)
                                  throws IOException

Extract the header information from the index file.

Parameters:

file -

Returns:

an index header

Throws:

IOException

getLogHeader

public static LogHeader getLogHeader(File file)
                              throws IOException

Extract the header information from the log file.

Parameters:

file -

Returns:

an index header

Throws:

IOException