jetbrains.exodus.env

Enum StoreConfig

java.lang.Object

java.lang.Enum<StoreConfig>

jetbrains.exodus.env.StoreConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StoreConfig>

public enum StoreConfig
extends java.lang.Enum<StoreConfig>

Specifies the attributes of a Store. There are two attributes that can vary independently: duplicates and prefixing. If duplicates is true, then the Store can save several values for a single key. If prefixing is true, then the Store uses Patricia trie as a search tree, rather than B+Tree. Patricia tries tend to perform better and save physical space of the database if the keys tend to have common prefixes. Also these types of search tree differ in performance characteristics: stores with key prefixing has better random key access, whereas stores without key prefixing are preferable for sequential access in order of keys.

	With duplicates	Without duplicates
With key prefixing	WITH_DUPLICATES_WITH_PREFIXING	WITH_DUPLICATES_WITH_PREFIXING
Without key prefixing	WITH_DUPLICATES	WITHOUT_DUPLICATES

Enum Constant Summary

Enum Constants

Enum Constant and Description
TEMPORARY_EMPTY Please don't use it in your applications.
USE_EXISTING If it is known that a Store definitely exists it can be opened with the StoreConfig.USE_EXISTING configuration.
WITH_DUPLICATES Store with this config has key duplicates and doesn't support key prefixing.
WITH_DUPLICATES_WITH_PREFIXING Store with this config has no key duplicates and supports key prefixing.
WITHOUT_DUPLICATES Store with this config has no key duplicates and doesn't support key prefixing.
WITHOUT_DUPLICATES_WITH_PREFIXING Store with this config has no key duplicates and supports key prefixing.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	duplicates
int	id
boolean	prefixing
boolean	temporaryEmpty
boolean	useExisting

Method Summary

Modifier and Type	Method and Description
static StoreConfig	getStoreConfig(boolean duplicates, boolean prefixing) Returns StoreConfig value corresponding to the specified Store attributes.
java.lang.String	toString()
static StoreConfig	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StoreConfig[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WITHOUT_DUPLICATES

public static final StoreConfig WITHOUT_DUPLICATES

Store with this config has no key duplicates and doesn't support key prefixing.

WITH_DUPLICATES

public static final StoreConfig WITH_DUPLICATES

Store with this config has key duplicates and doesn't support key prefixing.

WITHOUT_DUPLICATES_WITH_PREFIXING

public static final StoreConfig WITHOUT_DUPLICATES_WITH_PREFIXING

Store with this config has no key duplicates and supports key prefixing.

WITH_DUPLICATES_WITH_PREFIXING

public static final StoreConfig WITH_DUPLICATES_WITH_PREFIXING

Store with this config has no key duplicates and supports key prefixing.

TEMPORARY_EMPTY

public static final StoreConfig TEMPORARY_EMPTY

Please don't use it in your applications.

USE_EXISTING

public static final StoreConfig USE_EXISTING

If it is known that a Store definitely exists it can be opened with the StoreConfig.USE_EXISTING configuration. In that case, you don't need to know whether the Store can have duplicate keys or was it created with key prefixing.

Field Detail

id

public final int id

duplicates

public final boolean duplicates

prefixing

public final boolean prefixing

temporaryEmpty

public final boolean temporaryEmpty

useExisting

public final boolean useExisting

Method Detail

values

public static StoreConfig[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StoreConfig c : StoreConfig.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StoreConfig valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<StoreConfig>

getStoreConfig

public static StoreConfig getStoreConfig(boolean duplicates,
                                         boolean prefixing)

Returns StoreConfig value corresponding to the specified Store attributes.

	With duplicates	Without duplicates
With key prefixing	WITH_DUPLICATES_WITH_PREFIXING	WITH_DUPLICATES_WITH_PREFIXING
Without key prefixing	WITH_DUPLICATES	WITHOUT_DUPLICATES

Parameters:

duplicates - true if key duplicates are allowed

prefixing - true if key prefixing is desired

Returns:

StoreConfig value corresponding to the specified Store attributes