org.bluedb.api

Interface BlueDb

All Known Implementing Classes:

BlueDbOnDisk

public interface BlueDb

BlueDb is a set of BlueCollection instances. Each collection must have a different name and can be of a different type.

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 path) Creates a backup of the entire database
<K extends BlueKey,V extends java.io.Serializable> BlueCollectionBuilder<K,V>	collectionBuilder(java.lang.String name, java.lang.Class<K> keyType, java.lang.Class<V> valueType) Creates a BlueCollectionBuilder object for this BlueDb
<V extends java.io.Serializable> BlueCollection<V>	getCollection(java.lang.String name, java.lang.Class<V> valueType) Gets an existing BlueCollection
<V extends java.io.Serializable> BlueCollection<V>	initializeCollection(java.lang.String name, java.lang.Class<? extends BlueKey> keyType, java.lang.Class<V> valueType, java.lang.Class<? extends java.io.Serializable>... additionalClassesToRegister) Creates a BlueCollection, or returns the existing one of the same name, if one exists
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.

Method Detail

initializeCollection

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

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

Type Parameters:

V - 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

collectionBuilder

<K extends BlueKey,V extends java.io.Serializable> BlueCollectionBuilder<K,V> collectionBuilder(java.lang.String name,
                                                                                                java.lang.Class<K> keyType,
                                                                                                java.lang.Class<V> valueType)

Creates a BlueCollectionBuilder object for this BlueDb

Type Parameters:

K - the key type of the collection

V - 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

getCollection

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

Gets an existing BlueCollection

Type Parameters:

V - 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

backup

void backup(java.nio.file.Path path)
     throws BlueDbException

Creates a backup of the entire database

Parameters:

path - where the backup will be created

Throws:

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

shutdown

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. Use awaitTermination to do that.

shutdownNow

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. Use awaitTermination to do that.

awaitTermination

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

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

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