jetbrains.exodus.env

Interface ContextualEnvironment

All Superinterfaces:

java.lang.AutoCloseable, Backupable, java.io.Closeable, Environment

public interface ContextualEnvironment
extends Environment

ContextualEnvironment is always aware of transaction started in current thread. Its openStore() methods return ContextualStore instances.

See Also:

Environment, ContextualStore

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<java.lang.String>	getAllStoreNames() This method is equivalent to Environment.getAllStoreNames(Transaction):
@NotNull Transaction	getAndCheckCurrentTransaction()
@Nullable Transaction	getCurrentTransaction()
@NotNull ContextualBitmap	openBitmap(@NotNull java.lang.String name, @NotNull StoreConfig config) Opens existing or creates new instance of Bitmap.
@NotNull ContextualStore	openStore(@NotNull java.lang.String name, @NotNull StoreConfig config) Opens existing or creates new store with specified name and config inside transaction started in current thread.
@Nullable ContextualStore	openStore(@NotNull java.lang.String name, @NotNull StoreConfig config, boolean creationRequired) Opens existing or creates new store with specified name and config inside transaction started in current thread.
@NotNull ContextualStore	openStore(@NotNull java.lang.String name, @NotNull StoreConfig config, @NotNull Transaction transaction) Opens existing or creates new store with specified name and config inside a transaction.
@Nullable ContextualStore	openStore(@NotNull java.lang.String name, @NotNull StoreConfig config, @NotNull Transaction transaction, boolean creationRequired) Opens existing or creates new store with specified name and config inside a transaction.

Methods inherited from interface jetbrains.exodus.env.Environment

beginExclusiveTransaction, beginExclusiveTransaction, beginReadonlyTransaction, beginReadonlyTransaction, beginTransaction, beginTransaction, clear, close, computeInExclusiveTransaction, computeInReadonlyTransaction, computeInTransaction, executeBeforeGc, executeInExclusiveTransaction, executeInReadonlyTransaction, executeInTransaction, executeTransactionSafeTask, gc, getAllStoreNames, getCipherBasicIV, getCipherKey, getCipherProvider, getCreated, getEnvironmentConfig, getLocation, getStatistics, isOpen, openBitmap, removeStore, resumeGC, storeExists, suspendGC, truncateStore

Methods inherited from interface jetbrains.exodus.backup.Backupable

getBackupStrategy

Method Detail

openBitmap

@NotNull
@NotNull ContextualBitmap openBitmap(@NotNull
                                              @NotNull java.lang.String name,
                                              @NotNull
                                              @NotNull StoreConfig config)

Opens existing or creates new instance of Bitmap. Internally opens existing or creates new store with specific name and config = StoreConfig.WITHOUT_DUPLICATES inside a transaction started in current thread.

Parameters:

name - the name of opened store is formed from specified name and suffix "#bitmap".

Returns:

Bitmap instance

openStore

@NotNull
@NotNull ContextualStore openStore(@NotNull
                                            @NotNull java.lang.String name,
                                            @NotNull
                                            @NotNull StoreConfig config)

Opens existing or creates new store with specified name and config inside transaction started in current thread. Internally, it calls getAndCheckCurrentTransaction() to ensure that transaction started in current thread exists. StoreConfig provides meta-information used to create store. If it is known that the store with specified name exists, then StoreConfig.USE_EXISTING can be used.

Parameters:

name - name of store

config - StoreConfig used to create store

Returns:

ContextualStore instance

See Also:

ContextualStore, StoreConfig

openStore

@Nullable
@Nullable ContextualStore openStore(@NotNull
                                              @NotNull java.lang.String name,
                                              @NotNull
                                              @NotNull StoreConfig config,
                                              boolean creationRequired)

Opens existing or creates new store with specified name and config inside transaction started in current thread. Internally, it calls getAndCheckCurrentTransaction() to ensure that transaction started in current thread exists. StoreConfig provides meta-information used to create store. If it is known that the store with specified name exists, then StoreConfig.USE_EXISTING can be used.

Pass true as creationRequired if creating new store is required or allowed. In that case, the method will do the same as openStore(String, StoreConfig). If you pass false the method will return null for non-existing store.

Parameters:

name - name of store

config - StoreConfig used to create store

creationRequired - pass false if you wish to get null for non-existing store rather than create it.

Returns:

ContextualStore instance

See Also:

ContextualStore, StoreConfig

openStore

@NotNull
@NotNull ContextualStore openStore(@NotNull
                                            @NotNull java.lang.String name,
                                            @NotNull
                                            @NotNull StoreConfig config,
                                            @NotNull
                                            @NotNull Transaction transaction)

Description copied from interface: Environment

Opens existing or creates new store with specified name and config inside a transaction. StoreConfig provides meta-information used to create store. If it is known that the store with specified name exists, then StoreConfig.USE_EXISTING can be used.

Specified by:

openStore in interface Environment

Parameters:

name - name of store

config - StoreConfig used to create store

transaction - Transaction used to create store

Returns:

Store instance

openStore

@Nullable
@Nullable ContextualStore openStore(@NotNull
                                              @NotNull java.lang.String name,
                                              @NotNull
                                              @NotNull StoreConfig config,
                                              @NotNull
                                              @NotNull Transaction transaction,
                                              boolean creationRequired)

Description copied from interface: Environment

Opens existing or creates new store with specified name and config inside a transaction. StoreConfig provides meta-information used to create the store. If it is known that the store with specified name exists, then StoreConfig.USE_EXISTING can be used.

Pass true as creationRequired if creating new store is required or allowed. In that case, the method will do the same as Environment.openStore(String, StoreConfig, Transaction). If you pass false the method will return null for non-existing store.

Specified by:

openStore in interface Environment

Parameters:

name - name of store

config - StoreConfig used to create store

transaction - Transaction used to create store

creationRequired - pass false if you wish to get null for non-existing store rather than create it

Returns:

Store instance

getCurrentTransaction

@Nullable
@Nullable Transaction getCurrentTransaction()

Returns:

transaction instance or null if no transaction is started in current thread

See Also:

Transaction

getAndCheckCurrentTransaction

@NotNull
@NotNull Transaction getAndCheckCurrentTransaction()

Returns:

transaction instance started in current thread

Throws:

ExodusException - if there is no transaction started in current thread

See Also:

Transaction

getAllStoreNames

@NotNull
@NotNull java.util.List<java.lang.String> getAllStoreNames()

This method is equivalent to Environment.getAllStoreNames(Transaction):

     List stores = getAllStoreNames(getAndCheckCurrentTransaction());
 

Returns:

the list of names of all stores created in the environment.

See Also:

Environment.getAllStoreNames(Transaction)