Package one.microstream.storage.types

Interface StorageLiveFileProvider

All Superinterfaces:

one.microstream.persistence.types.PersistenceTypeDictionaryIoHandler.Provider, StorageFileProvider

All Known Implementing Classes:

StorageLiveFileProvider.Default

public interface StorageLiveFileProvider
extends StorageFileProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	StorageLiveFileProvider.Builder<B extends StorageLiveFileProvider.Builder<?>>
static class	StorageLiveFileProvider.Default
static interface	StorageLiveFileProvider.Defaults

Nested classes/interfaces inherited from interface one.microstream.storage.types.StorageFileProvider

StorageFileProvider.Abstract

Method Summary

Modifier and Type	Method	Description
static StorageLiveFileProvider.Builder<?>	Builder()	Pseudo-constructor method to create a new StorageLiveFileProvider.Builder instance with the default file system.
static StorageLiveFileProvider.Builder<?>	Builder(one.microstream.afs.types.AFileSystem fileSystem)	Pseudo-constructor method to create a new StorageLiveFileProvider.Builder instance.
String	getStorageLocationIdentifier()	Returns a String that uniquely identifies the storage location.
static StorageLiveFileProvider	New()	Pseudo-constructor method to create a new StorageLiveFileProvider instance with default values provided by StorageLiveFileProvider.Defaults.
static StorageLiveFileProvider	New(one.microstream.afs.types.ADirectory storageDirectory)	Pseudo-constructor method to create a new StorageLiveFileProvider instance with the passed file as the storage directory and defaults provided by StorageLiveFileProvider.Defaults.
static StorageLiveFileProvider.Default	New(one.microstream.afs.types.ADirectory baseDirectory, one.microstream.afs.types.ADirectory deletionDirectory, one.microstream.afs.types.ADirectory truncationDirectory, StorageDirectoryStructureProvider structureProvider, StorageFileNameProvider fileNameProvider, one.microstream.persistence.internal.PersistenceTypeDictionaryFileHandler.Creator fileHandlerCreator)
one.microstream.afs.types.AFile	provideDataFile(int channelIndex, long fileNumber)
one.microstream.afs.types.AFile	provideLockFile()
one.microstream.afs.types.AFile	provideTransactionsFile(int channelIndex)

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDictionaryIoHandler.Provider

provideTypeDictionaryIoHandler, provideTypeDictionaryIoHandler

Methods inherited from interface one.microstream.storage.types.StorageFileProvider

baseDirectory, collectDataFiles, deletionDirectory, fileNameProvider, fileSystem, provideDeletionTargetFile, provideTruncationTargetFile, truncationDirectory

Method Detail

getStorageLocationIdentifier

String getStorageLocationIdentifier()

Returns a String that uniquely identifies the storage location.

Returns:

a String that uniquely identifies the storage location.

provideDataFile

one.microstream.afs.types.AFile provideDataFile(int channelIndex,
                                                long fileNumber)

provideTransactionsFile

one.microstream.afs.types.AFile provideTransactionsFile(int channelIndex)

provideLockFile

one.microstream.afs.types.AFile provideLockFile()

New

static StorageLiveFileProvider New()

Pseudo-constructor method to create a new StorageLiveFileProvider instance with default values provided by StorageLiveFileProvider.Defaults.

For explanations and customizing values, see StorageLiveFileProvider.Builder.

Returns:

a new StorageLiveFileProvider instance.

See Also:

New(ADirectory), StorageLiveFileProvider.Builder, StorageLiveFileProvider.Defaults

New

static StorageLiveFileProvider New(one.microstream.afs.types.ADirectory storageDirectory)

Pseudo-constructor method to create a new StorageLiveFileProvider instance with the passed file as the storage directory and defaults provided by StorageLiveFileProvider.Defaults.

For explanations and customizing values, see StorageLiveFileProvider.Builder.

Parameters:

storageDirectory - the directory where the storage will be located.

Returns:

a new StorageLiveFileProvider instance.

See Also:

New(), StorageLiveFileProvider.Builder, StorageLiveFileProvider.Defaults

New

static StorageLiveFileProvider.Default New(one.microstream.afs.types.ADirectory baseDirectory,
                                           one.microstream.afs.types.ADirectory deletionDirectory,
                                           one.microstream.afs.types.ADirectory truncationDirectory,
                                           StorageDirectoryStructureProvider structureProvider,
                                           StorageFileNameProvider fileNameProvider,
                                           one.microstream.persistence.internal.PersistenceTypeDictionaryFileHandler.Creator fileHandlerCreator)

Parameters:

baseDirectory - may not be null.

fileHandlerCreator - may not be null.

deletionDirectory - may be null.

truncationDirectory - may be null.

structureProvider - may not be null.

fileNameProvider - may not be null.

Returns:

a new StorageLiveFileProvider instance

Builder

static StorageLiveFileProvider.Builder<?> Builder()

Pseudo-constructor method to create a new StorageLiveFileProvider.Builder instance with the default file system.

For explanations and customizing values, see StorageLiveFileProvider.Builder.

Returns:

a new StorageLiveFileProvider.Builder instance.

See Also:

Storage.DefaultFileSystem()

Builder

static StorageLiveFileProvider.Builder<?> Builder(one.microstream.afs.types.AFileSystem fileSystem)

Pseudo-constructor method to create a new StorageLiveFileProvider.Builder instance.

For explanations and customizing values, see StorageLiveFileProvider.Builder.

Parameters:

fileSystem - the file system to use

Returns:

a new StorageLiveFileProvider.Builder instance.