com.linkedin.paldb.api

Class Configuration

java.lang.Object

com.linkedin.paldb.api.Configuration

All Implemented Interfaces:

java.io.Serializable

public class Configuration
extends java.lang.Object
implements java.io.Serializable

Store configuration.

This class recognizes the following property keys:

mmap.segment.size - memory map segment size (bytes) [default: 1GB]

mmap.data.enabled - enable memory mapping for data (boolean) [default: true]

load.factor - index load factor (double) [default: 0.75]

cache.enabled - LRU cache enabled (boolean) [default: false]

cache.bytes - cache limit (bytes) [default: Xmx - 100MB]

cache.initial.capacity - cache initial capacity (int) [default: 1000]

cache.load.factor - cache load factor (double) [default: 0.75]

compression.enabled - enable compression (boolean) [default: false]

Default values can be set by setting properties to the JVM (ex: -Dpaldb.mmap.data.enabled=false). All property names should be prefixed with paldb.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_BYTES
static java.lang.String	CACHE_ENABLED
static java.lang.String	CACHE_INITIAL_CAPACITY
static java.lang.String	CACHE_LOAD_FACTOR
static java.lang.String	COMPRESSION_ENABLED
static java.lang.String	LOAD_FACTOR
static java.lang.String	MMAP_DATA_ENABLED
static java.lang.String	MMAP_SEGMENT_SIZE
protected java.util.Map<java.lang.String,java.lang.String>	properties
protected boolean	readOnly
protected Serializers	serializers

Constructor Summary

Constructors

Constructor and Description
Configuration() Default constructor that initializes default values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	get(java.lang.String key, java.lang.String defaultString) Gets the value for key or defaultString if not found.
boolean	getBoolean(java.lang.String key) Gets the boolean value key.
boolean	getBoolean(java.lang.String key, boolean defaultValue) Gets the boolean value for key or defaultValue if not found.
<T> java.lang.Class<T>	getClass(java.lang.String key) Gets the class value key.
double	getDouble(java.lang.String key) Gets the double value key.
double	getDouble(java.lang.String key, double defaultValue) Gets the double value for key or defaultValue if not found.
float	getFloat(java.lang.String key) Gets the float value key.
float	getFloat(java.lang.String key, float defaultValue) Gets the float value for key or defaultValue if not found.
int	getInt(java.lang.String key) Gets the int value key.
int	getInt(java.lang.String key, int defaultValue) Gets the int value for key or defaultValue if not found.
java.util.List<java.lang.String>	getList(java.lang.String key) Gets the string list value key.
java.util.List<java.lang.String>	getList(java.lang.String key, java.util.List<java.lang.String> defaultValue) Gets the string list value for key or defaultValue if not found.
long	getLong(java.lang.String key) Gets the long value key.
long	getLong(java.lang.String key, long defaultValue) Gets the long value for key or defaultValue if not found.
Serializer	getSerializer(java.lang.Class cls) Gets the serializer for the given class or null if not found.
Serializers	getSerializers()
short	getShort(java.lang.String key) Gets the short value key.
short	getShort(java.lang.String key, short defaultValue) Gets the short value for key or defaultValue if not found.
int	hashCode()
void	registerSerializer(Serializer serializer) Register serializer.
Configuration	set(java.lang.String key, java.lang.String value) Sets the value for key.

Methods inherited from class java.lang.Object

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

Field Detail

MMAP_SEGMENT_SIZE

public static final java.lang.String MMAP_SEGMENT_SIZE

See Also:

Constant Field Values

MMAP_DATA_ENABLED

public static final java.lang.String MMAP_DATA_ENABLED

See Also:

Constant Field Values

LOAD_FACTOR

public static final java.lang.String LOAD_FACTOR

See Also:

Constant Field Values

CACHE_ENABLED

public static final java.lang.String CACHE_ENABLED

See Also:

Constant Field Values

CACHE_BYTES

public static final java.lang.String CACHE_BYTES

See Also:

Constant Field Values

CACHE_INITIAL_CAPACITY

public static final java.lang.String CACHE_INITIAL_CAPACITY

See Also:

Constant Field Values

CACHE_LOAD_FACTOR

public static final java.lang.String CACHE_LOAD_FACTOR

See Also:

Constant Field Values

COMPRESSION_ENABLED

public static final java.lang.String COMPRESSION_ENABLED

See Also:

Constant Field Values

properties

protected final java.util.Map<java.lang.String,java.lang.String> properties

readOnly

protected final boolean readOnly

serializers

protected final Serializers serializers

Constructor Detail

Configuration

public Configuration()

Default constructor that initializes default values.

Method Detail

get

public java.lang.String get(java.lang.String key,
                            java.lang.String defaultString)

Gets the value for key or defaultString if not found.

Parameters:

key - key to get value for

defaultString - default string if key not found

Returns:

value of defaultString if not found

set

public Configuration set(java.lang.String key,
                         java.lang.String value)

Sets the value for key.

Parameters:

key - key to set value for

value - value

Returns:

this configuration

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Gets the boolean value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getBoolean

public boolean getBoolean(java.lang.String key)

Gets the boolean value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getShort

public short getShort(java.lang.String key,
                      short defaultValue)

Gets the short value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getShort

public short getShort(java.lang.String key)

Gets the short value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Gets the long value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getLong

public long getLong(java.lang.String key)

Gets the long value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Gets the int value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getInt

public int getInt(java.lang.String key)

Gets the int value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Gets the double value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getDouble

public double getDouble(java.lang.String key)

Gets the double value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Gets the float value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getFloat

public float getFloat(java.lang.String key)

Gets the float value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getList

public java.util.List<java.lang.String> getList(java.lang.String key,
                                                java.util.List<java.lang.String> defaultValue)

Gets the string list value for key or defaultValue if not found.

Parameters:

key - key to get value for

defaultValue - default value if key not found

Returns:

value or defaultValue if not found

getList

public java.util.List<java.lang.String> getList(java.lang.String key)

Gets the string list value key.

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

getClass

public <T> java.lang.Class<T> getClass(java.lang.String key)
                                throws java.lang.ClassNotFoundException

Gets the class value key.

Type Parameters:

T - return type

Parameters:

key - key to get value for

Returns:

value

Throws:

java.lang.IllegalArgumentException - if the key is not found

java.lang.ClassNotFoundException - if the class can't be found

registerSerializer

public void registerSerializer(Serializer serializer)

Register serializer.

The class for with the serializer is being registered is directly extracted from the class definition.

Parameters:

serializer - serializer to register

getSerializer

public Serializer getSerializer(java.lang.Class cls)

Gets the serializer for the given class or null if not found.

Parameters:

cls - object class

Returns:

serializer or null if not found

getSerializers

public Serializers getSerializers()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object