org.bluedb.disk

Class BlueDbOnDisk

java.lang.Object

org.bluedb.disk.BlueDbOnDisk

All Implemented Interfaces:

BlueDb

public class BlueDbOnDisk
extends java.lang.Object
implements BlueDb

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, java.util.concurrent.TimeUnit timeUnit) Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
void	backup(java.nio.file.Path zipPath) Creates a backup of the entire database
<K extends BlueKey,T extends java.io.Serializable> BlueCollectionOnDiskBuilder<K,T>	collectionBuilder(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<T> valueType) Creates a BlueCollectionBuilder object for this BlueDb
protected java.util.List<BlueCollectionOnDisk<?>>	getAllCollectionsFromDisk()
BackupManager	getBackupManager()
<T extends java.io.Serializable> BlueCollection<T>	getCollection(java.lang.String name, java.lang.Class<T> valueType) Gets an existing BlueCollection
java.nio.file.Path	getPath()
BlueExecutor	getSharedExecutor()
protected BlueCollectionOnDisk	getUntypedCollectionForBackup(java.lang.String folderName)
<T extends java.io.Serializable> BlueCollection<T>	initializeCollection(java.lang.String name, java.lang.Class<? extends BlueKey> keyType, java.lang.Class<T> valueType, java.lang.Class<? extends java.io.Serializable>... additionalClassesToRegister) Deprecated.
protected <T extends java.io.Serializable> BlueCollection<T>	initializeCollection(java.lang.String name, java.lang.Class<? extends BlueKey> keyType, java.lang.Class<T> valueType, java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalClassesToRegister)
protected <T extends java.io.Serializable> BlueCollection<T>	initializeCollection(java.lang.String name, java.lang.Class<? extends BlueKey> keyType, java.lang.Class<T> valueType, java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalClassesToRegister, SegmentSizeSetting segmentSize)
void	shutdown() Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. This method does not wait for previously submitted tasks to complete execution.
void	shutdownNow() Attempts to stop all actively executing tasks and halts the processing of waiting tasks. This method does not wait for actively executing tasks to terminate.

Methods inherited from class java.lang.Object

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

Method Detail

getCollection

public <T extends java.io.Serializable> BlueCollection<T> getCollection(java.lang.String name,
                                                                        java.lang.Class<T> valueType)
                                                                 throws BlueDbException

Description copied from interface: BlueDb

Gets an existing BlueCollection

Specified by:

getCollection in interface BlueDb

Type Parameters:

T - the object type of values to be serialized into the collection

Parameters:

name - The unique name of the collection

valueType - the class type of the values stored in the collection

Returns:

existing BlueCollection if it exists, else null

Throws:

BlueDbException - if any issues encountered, such as the existing collection having a different key type

collectionBuilder

public <K extends BlueKey,T extends java.io.Serializable> BlueCollectionOnDiskBuilder<K,T> collectionBuilder(java.lang.String name,
                                                                                                             java.lang.Class<K> keyType,
                                                                                                             java.lang.Class<T> valueType)

Description copied from interface: BlueDb

Creates a BlueCollectionBuilder object for this BlueDb

Specified by:

collectionBuilder in interface BlueDb

Type Parameters:

K - the key type of the collection

T - the object type of values to be serialized into the collection

Parameters:

name - The unique name of the collection

keyType - the class type of the collection's keys

valueType - the class type of the values stored in the collection

Returns:

a new BlueCollectionBuilder object for this BlueDb

initializeCollection

@Deprecated
public <T extends java.io.Serializable> BlueCollection<T> initializeCollection(java.lang.String name,
                                                                                            java.lang.Class<? extends BlueKey> keyType,
                                                                                            java.lang.Class<T> valueType,
                                                                                            java.lang.Class<? extends java.io.Serializable>... additionalClassesToRegister)
                                                                                     throws BlueDbException

Deprecated.

Description copied from interface: BlueDb

Creates a BlueCollection, or returns the existing one of the same name, if one exists

Specified by:

initializeCollection in interface BlueDb

Type Parameters:

T - the object type of values to be serialized into the collection

Parameters:

name - the unique name of the collection

keyType - the class type of the collection's keys

valueType - the class type of the values stored in the collection

additionalClassesToRegister - classes to optimize for in the serializer (should be classes that will be stored in collection keys or values)

Returns:

a new BlueCollection, or the existing one if it exists

Throws:

BlueDbException - if any problems are encountered, such as the collection already existing with a different type

initializeCollection

protected <T extends java.io.Serializable> BlueCollection<T> initializeCollection(java.lang.String name,
                                                                                  java.lang.Class<? extends BlueKey> keyType,
                                                                                  java.lang.Class<T> valueType,
                                                                                  java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalClassesToRegister)
                                                                           throws BlueDbException

Throws:

BlueDbException

initializeCollection

protected <T extends java.io.Serializable> BlueCollection<T> initializeCollection(java.lang.String name,
                                                                                  java.lang.Class<? extends BlueKey> keyType,
                                                                                  java.lang.Class<T> valueType,
                                                                                  java.util.List<java.lang.Class<? extends java.io.Serializable>> additionalClassesToRegister,
                                                                                  SegmentSizeSetting segmentSize)
                                                                           throws BlueDbException

Throws:

BlueDbException

backup

public void backup(java.nio.file.Path zipPath)
            throws BlueDbException

Description copied from interface: BlueDb

Creates a backup of the entire database

Specified by:

backup in interface BlueDb

Parameters:

zipPath - where the backup will be created

Throws:

BlueDbException - if any issues encountered, such as file system problems

shutdown

public void shutdown()

Description copied from interface: BlueDb

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

Specified by:

shutdown in interface BlueDb

shutdownNow

public void shutdownNow()

Description copied from interface: BlueDb

Attempts to stop all actively executing tasks and halts the processing of waiting tasks.

This method does not wait for actively executing tasks to terminate. Use awaitTermination to do that.

Specified by:

shutdownNow in interface BlueDb

awaitTermination

public boolean awaitTermination(long timeout,
                                java.util.concurrent.TimeUnit timeUnit)
                         throws BlueDbException

Description copied from interface: BlueDb

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Specified by:

awaitTermination in interface BlueDb

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if bluedb terminated and false if the timeout elapsed before termination

Throws:

BlueDbException - if any issues are encountered, such as being interrupted

getPath

public java.nio.file.Path getPath()

getBackupManager

public BackupManager getBackupManager()

getSharedExecutor

public BlueExecutor getSharedExecutor()

getAllCollectionsFromDisk

protected java.util.List<BlueCollectionOnDisk<?>> getAllCollectionsFromDisk()
                                                                     throws BlueDbException

Throws:

BlueDbException

getUntypedCollectionForBackup

protected BlueCollectionOnDisk getUntypedCollectionForBackup(java.lang.String folderName)
                                                      throws BlueDbException

Throws:

BlueDbException