com.linkedin.paldb.api

Class PalDB

java.lang.Object

com.linkedin.paldb.api.PalDB

public final class PalDB
extends java.lang.Object

Factory for store readers and writers.

This class is the entry point to obtain StoreReader and StoreWriter interfaces.

Method Summary

Modifier and Type	Method and Description
static StoreReader	createReader(java.io.File file) Creates a store reader from the specified file with a default configuration.
static StoreReader	createReader(java.io.File file, Configuration config) Creates a store reader from the specified file.
static StoreReader	createReader(java.io.InputStream stream, Configuration config) Creates a store reader from the specified stream.
static StoreWriter	createWriter(java.io.File file) Creates a store writer with the specified file as destination with a default configuration.
static StoreWriter	createWriter(java.io.File file, Configuration config) Creates a store writer with the specified file as destination.
static StoreWriter	createWriter(java.io.OutputStream stream, Configuration config) Creates a store writer with the specified stream as destination.
static Configuration	newConfiguration() Creates new configuration with default values.

Methods inherited from class java.lang.Object

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

Method Detail

createReader

public static StoreReader createReader(java.io.File file)

Creates a store reader from the specified file with a default configuration.

The file must exists.

Parameters:

file - a PalDB store file

Returns:

a store reader

createReader

public static StoreReader createReader(java.io.File file,
                                       Configuration config)

Creates a store reader from the specified file.

The file must exists.

Parameters:

file - a PalDB store file

config - configuration

Returns:

a store reader

createReader

public static StoreReader createReader(java.io.InputStream stream,
                                       Configuration config)

Creates a store reader from the specified stream.

The reader will read the stream and write its content to a temporary file when this method is called. This is specifically suited for stream coming from the JAR as a resource. The stream will be closed by this method.

Parameters:

stream - an input stream on a PalDB store file

config - configuration

Returns:

a store reader

createWriter

public static StoreWriter createWriter(java.io.File file)

Creates a store writer with the specified file as destination with a default configuration.

The parent folder is created if missing.

Parameters:

file - location of the output file

Returns:

a store writer

createWriter

public static StoreWriter createWriter(java.io.File file,
                                       Configuration config)

Creates a store writer with the specified file as destination.

The parent folder is created if missing.

Parameters:

file - location of the output file

config - configuration

Returns:

a store writer

createWriter

public static StoreWriter createWriter(java.io.OutputStream stream,
                                       Configuration config)

Creates a store writer with the specified stream as destination.

The writer will only write bytes to the stream when StoreWriter.close() is called.

Parameters:

stream - output stream

config - configuration

Returns:

a store writer

newConfiguration

public static Configuration newConfiguration()

Creates new configuration with default values.

Returns:

new configuration