org.mapdb

Class DB

org.mapdb.DB

All Implemented Interfaces:

ConcurrencyAware

public class DB
implements ConcurrencyAware

A database with easy access to named maps and other collections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DB.AtomicBooleanMaker
static class	DB.AtomicIntegerMaker
static class	DB.AtomicLongMaker
static class	DB.AtomicStringMaker
static class	DB.AtomicVarMaker<E>
static class	DB.CatVal
static class	DB.Companion
static class	DB.HashMapMaker<K,V>
static class	DB.HashSetMaker<E>
static class	DB.IndexTreeListMaker<E>
static class	DB.IndexTreeLongLongMapMaker
static class	DB.Keys
static class	DB.Maker<E>
static class	DB.TreeMapMaker<K,V>
static class	DB.TreeMapSink<K,V>
static class	DB.TreeSetMaker<E>

Nested classes/interfaces inherited from interface org.mapdb.ConcurrencyAware

ConcurrencyAware.DefaultImpls

Field Summary

Fields

Modifier and Type	Field and Description
static DB.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
DB(Store store, boolean storeOpened, boolean isThreadSafe, java.lang.ClassLoader classLoader, int shutdownHook) A database with easy access to named maps and other collections.

Method Summary

Modifier and Type	Method and Description
DB.AtomicBooleanMaker	atomicBoolean(java.lang.String name)
DB.AtomicBooleanMaker	atomicBoolean(java.lang.String name, boolean value)
DB.AtomicIntegerMaker	atomicInteger(java.lang.String name)
DB.AtomicIntegerMaker	atomicInteger(java.lang.String name, int value)
DB.AtomicLongMaker	atomicLong(java.lang.String name)
DB.AtomicLongMaker	atomicLong(java.lang.String name, long value)
DB.AtomicStringMaker	atomicString(java.lang.String name)
DB.AtomicStringMaker	atomicString(java.lang.String name, java.lang.String value)
DB.AtomicVarMaker<java.lang.Object>	atomicVar(java.lang.String name)
<E> DB.AtomicVarMaker<E>	atomicVar(java.lang.String name, Serializer<E> serializer)
<E> DB.AtomicVarMaker<E>	atomicVar(java.lang.String name, Serializer<E> serializer, E value)
void	checkName(java.lang.String name)
void	checkNotClosed()
void	checkThreadSafe() checks all subcomponents, if this component is really thread safe, and throws an exception if not thread safe
void	close()
void	commit()
void	defaultSerializerRegisterClass(java.lang.Class<?> clazz) Register Class with default POJO serializer. Class structure will be stored in store, and will save space for collections which do not use specialized serializer.
boolean	exists(java.lang.String name)
<E> E	get(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getAll()
java.lang.Iterable<java.lang.String>	getAllNames()
Serializer<kotlin.Array[]>	getClassInfoSerializer()
java.lang.ClassLoader	getClassLoader()
GroupSerializerObjectArray<java.lang.Object>	getDefaultSerializer() Default serializer used if collection does not specify specialized serializer. It uses Elsa Serializer.
java.util.Set<java.util.concurrent.ExecutorService>	getExecutors() List of executors associated with this database. Those will be terminated on close()
java.util.concurrent.locks.ReentrantReadWriteLock	getLock()
java.lang.String	getNameForObject(java.lang.Object e)
NonExistentClass	getNamesInstanciated() Already loaded named collections. Values are weakly referenced. We need singletons for locking
int	getShutdownHook() type of shutdown hook,
Store	getStore()
boolean	getStoreOpened() True if store existed before and was opened,
DB.HashMapMaker<?,?>	hashMap(java.lang.String name)
<K,V> DB.HashMapMaker<K,V>	hashMap(java.lang.String name, Serializer<K> keySerializer, Serializer<V> valueSerializer)
DB.HashSetMaker<?>	hashSet(java.lang.String name)
<E> DB.HashSetMaker<E>	hashSet(java.lang.String name, Serializer<E> serializer)
<E> DB.IndexTreeListMaker<E>	indexTreeList(java.lang.String name, Serializer<E> serializer)
DB.IndexTreeListMaker<java.lang.Object>	indexTreeList(java.lang.String name)
boolean	isClosed()
boolean	isThreadSafe() returns true if this is configured to be thread safe
java.lang.String	nameCatalogGet(java.lang.String name)
<E> E	nameCatalogGetClass(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog, java.lang.String key)
java.util.SortedMap<java.lang.String,java.lang.String>	nameCatalogLoad()
java.util.SortedMap<java.lang.String,java.lang.String>	nameCatalogLoadLocked()
java.util.Map<java.lang.String,java.lang.String>	nameCatalogParamsFor(java.lang.String name)
void	nameCatalogPutClass(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog, java.lang.String key, java.lang.Object obj)
void	nameCatalogSave(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog)
void	nameCatalogSaveLocked(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog)
java.lang.Iterable<java.lang.String>	nameCatalogVerifyGetMessages() verifies name catalog is valid (all parameters are known and have required values). If there are problems, it return list of messages
void	rollback()
void	setNamesInstanciated(NonExistentClass p) Already loaded named collections. Values are weakly referenced. We need singletons for locking
DB.TreeMapMaker<?,?>	treeMap(java.lang.String name)
<K,V> DB.TreeMapMaker<K,V>	treeMap(java.lang.String name, GroupSerializer<K> keySerializer, GroupSerializer<V> valueSerializer)
DB.TreeSetMaker<?>	treeSet(java.lang.String name)
<E> DB.TreeSetMaker<E>	treeSet(java.lang.String name, GroupSerializer<E> serializer)

Methods inherited from interface org.mapdb.ConcurrencyAware

checkThreadSafe, isThreadSafe

Field Detail

Companion

public static DB.Companion Companion

Constructor Detail

DB

public DB(Store store,
          boolean storeOpened,
          boolean isThreadSafe,
          java.lang.ClassLoader classLoader,
          int shutdownHook)

A database with easy access to named maps and other collections.

Parameters:

store - Stores all underlying data

storeOpened - True if store existed before and was opened,false if store was created and is completely empty

isThreadSafe - returns true if this is configured to be thread safe

shutdownHook - type of shutdown hook,0 is disabled,1 is hard ref,2 is weak ref

Method Detail

getStore

public Store getStore()

getLock

public java.util.concurrent.locks.ReentrantReadWriteLock getLock()

checkNotClosed

public void checkNotClosed()

getNamesInstanciated

public NonExistentClass getNamesInstanciated()

Already loaded named collections. Values are weakly referenced. We need singletons for locking

setNamesInstanciated

public void setNamesInstanciated(NonExistentClass p)

Already loaded named collections. Values are weakly referenced. We need singletons for locking

getDefaultSerializer

public GroupSerializerObjectArray<java.lang.Object> getDefaultSerializer()

Default serializer used if collection does not specify specialized serializer. It uses Elsa Serializer.

getClassInfoSerializer

public Serializer<kotlin.Array[]> getClassInfoSerializer()

getExecutors

public java.util.Set<java.util.concurrent.ExecutorService> getExecutors()

List of executors associated with this database. Those will be terminated on close()

nameCatalogLoad

public java.util.SortedMap<java.lang.String,java.lang.String> nameCatalogLoad()

nameCatalogLoadLocked

public java.util.SortedMap<java.lang.String,java.lang.String> nameCatalogLoadLocked()

nameCatalogSave

public void nameCatalogSave(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog)

nameCatalogSaveLocked

public void nameCatalogSaveLocked(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog)

checkName

public void checkName(java.lang.String name)

nameCatalogGet

public java.lang.String nameCatalogGet(java.lang.String name)

nameCatalogPutClass

public void nameCatalogPutClass(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog,
                                java.lang.String key,
                                java.lang.Object obj)

nameCatalogGetClass

public <E> E nameCatalogGetClass(java.util.SortedMap<java.lang.String,java.lang.String> nameCatalog,
                                 java.lang.String key)

nameCatalogParamsFor

public java.util.Map<java.lang.String,java.lang.String> nameCatalogParamsFor(java.lang.String name)

commit

public void commit()

rollback

public void rollback()

isClosed

public boolean isClosed()

close

public void close()

get

public <E> E get(java.lang.String name)

getNameForObject

public java.lang.String getNameForObject(java.lang.Object e)

exists

public boolean exists(java.lang.String name)

getAllNames

public java.lang.Iterable<java.lang.String> getAllNames()

getAll

public java.util.Map<java.lang.String,java.lang.Object> getAll()

hashMap

public DB.HashMapMaker<?,?> hashMap(java.lang.String name)

hashMap

public <K,V> DB.HashMapMaker<K,V> hashMap(java.lang.String name,
                                          Serializer<K> keySerializer,
                                          Serializer<V> valueSerializer)

treeMap

public DB.TreeMapMaker<?,?> treeMap(java.lang.String name)

treeMap

public <K,V> DB.TreeMapMaker<K,V> treeMap(java.lang.String name,
                                          GroupSerializer<K> keySerializer,
                                          GroupSerializer<V> valueSerializer)

treeSet

public DB.TreeSetMaker<?> treeSet(java.lang.String name)

treeSet

public <E> DB.TreeSetMaker<E> treeSet(java.lang.String name,
                                      GroupSerializer<E> serializer)

hashSet

public DB.HashSetMaker<?> hashSet(java.lang.String name)

hashSet

public <E> DB.HashSetMaker<E> hashSet(java.lang.String name,
                                      Serializer<E> serializer)

atomicInteger

public DB.AtomicIntegerMaker atomicInteger(java.lang.String name)

atomicInteger

public DB.AtomicIntegerMaker atomicInteger(java.lang.String name,
                                           int value)

atomicLong

public DB.AtomicLongMaker atomicLong(java.lang.String name)

atomicLong

public DB.AtomicLongMaker atomicLong(java.lang.String name,
                                     long value)

atomicBoolean

public DB.AtomicBooleanMaker atomicBoolean(java.lang.String name)

atomicBoolean

public DB.AtomicBooleanMaker atomicBoolean(java.lang.String name,
                                           boolean value)

atomicString

public DB.AtomicStringMaker atomicString(java.lang.String name)

atomicString

public DB.AtomicStringMaker atomicString(java.lang.String name,
                                         java.lang.String value)

atomicVar

public DB.AtomicVarMaker<java.lang.Object> atomicVar(java.lang.String name)

atomicVar

public <E> DB.AtomicVarMaker<E> atomicVar(java.lang.String name,
                                          Serializer<E> serializer)

atomicVar

public <E> DB.AtomicVarMaker<E> atomicVar(java.lang.String name,
                                          Serializer<E> serializer,
                                          E value)

indexTreeList

public <E> DB.IndexTreeListMaker<E> indexTreeList(java.lang.String name,
                                                  Serializer<E> serializer)

indexTreeList

public DB.IndexTreeListMaker<java.lang.Object> indexTreeList(java.lang.String name)

checkThreadSafe

public void checkThreadSafe()

checks all subcomponents, if this component is really thread safe, and throws an exception if not thread safe

defaultSerializerRegisterClass

public void defaultSerializerRegisterClass(java.lang.Class<?> clazz)

Register Class with default POJO serializer. Class structure will be stored in store, and will save space for collections which do not use specialized serializer.

nameCatalogVerifyGetMessages

public java.lang.Iterable<java.lang.String> nameCatalogVerifyGetMessages()

verifies name catalog is valid (all parameters are known and have required values). If there are problems, it return list of messages

getStoreOpened

public boolean getStoreOpened()

True if store existed before and was opened,

false if store was created and is completely empty

isThreadSafe

public boolean isThreadSafe()

returns true if this is configured to be thread safe

getClassLoader

public java.lang.ClassLoader getClassLoader()

getShutdownHook

public int getShutdownHook()

type of shutdown hook,

0 is disabled,1 is hard ref,2 is weak ref