Package one.microstream.storage.types

Class StorageDataFile.Default

java.lang.Object

one.microstream.storage.types.StorageDataFile.Default

All Implemented Interfaces:

StorageChannelFile, StorageDataFile<StorageEntity.Default>, StorageFile, StorageHashChannelPart, StorageInventoryFile, StorageLockedFile, StorageNumberedFile

Enclosing interface:

StorageDataFile<I extends StorageEntityCacheItem<I>>

public static final class StorageDataFile.Default
extends Object
implements StorageDataFile<StorageEntity.Default>

Nested Class Summary

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

StorageDataFile.Default

Constructor Summary

Constructors

Constructor	Description
Default()

Method Summary

Modifier and Type	Method	Description
void	appendEntry(StorageEntity.Default entry)
int	channelIndex()
boolean	clearUsages(StorageFileUser fileUser)
void	close()
double	dataFillRatio()
long	dataLength()
boolean	delete()
static StorageDataFile.Default	Dummy()
boolean	executeIfUnsued(Consumer<? super StorageLockedFile> action)
boolean	executeIfUnsuedData(Consumer<? super StorageDataFile.Default> action)
boolean	exists()
long	exportTo(StorageLockedFile file)
long	exportTo(StorageLockedFile file, long sourceOffset, long length)
FileChannel	fileChannel()
boolean	hasSingleEntity()	Querying method to check if a storage file consists of only one singular live entity.
boolean	hasUsers()
String	identifier()	Returns a string uniquely identifying the file represented by this instance.
boolean	isHeadFile()
void	loadEntityData(StorageEntity.Default entity, long length, long cacheChange)
String	name()	Return a compact string containing a specific, but not necessarily unique name of the file represented by this instance.
static StorageDataFile.Default	New(StorageFileManager.Default parent, StorageInventoryFile file)
long	number()
void	prependEntry(StorageEntity.Default entry)
String	qualifier()	Returns a string that gives StorageFile.name() a unique identity.
boolean	registerUsage(StorageFileUser fileUser)
void	remove(StorageEntity.Default entity)
String	toString()
long	totalLength()
boolean	tryClose()
boolean	unregisterUsage(StorageFileUser fileUser)
boolean	unregisterUsageClosing(StorageFileUser fileUser, Consumer<? super StorageLockedFile> closingAction)
boolean	unregisterUsageClosingData(StorageFileUser fileUser, Consumer<? super StorageDataFile.Default> closingAction)

Methods inherited from class java.lang.Object

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

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

flush, isEmpty, isOpen

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

inventorize

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

length

Constructor Detail

Default

public Default()

Method Detail

Dummy

public static final StorageDataFile.Default Dummy()

New

public static final StorageDataFile.Default New(StorageFileManager.Default parent,
                                                StorageInventoryFile file)

exportTo

public final long exportTo(StorageLockedFile file)

Specified by:

exportTo in interface StorageDataFile<StorageEntity.Default>

exportTo

public final long exportTo(StorageLockedFile file,
                           long sourceOffset,
                           long length)

Specified by:

exportTo in interface StorageDataFile<StorageEntity.Default>

number

public final long number()

Specified by:

number in interface StorageNumberedFile

totalLength

public final long totalLength()

Specified by:

totalLength in interface StorageDataFile<StorageEntity.Default>

dataLength

public final long dataLength()

Specified by:

dataLength in interface StorageDataFile<StorageEntity.Default>

dataFillRatio

public final double dataFillRatio()

Specified by:

dataFillRatio in interface StorageDataFile<StorageEntity.Default>

hasSingleEntity

public final boolean hasSingleEntity()

Description copied from interface: StorageDataFile

Querying method to check if a storage file consists of only one singular live entity. This is necessary to avoid dissolving files that are oversized because of one single oversized entity.

Specified by:

hasSingleEntity in interface StorageDataFile<StorageEntity.Default>

Returns:

true if the file containts exactely one live entity.

remove

public void remove(StorageEntity.Default entity)

Specified by:

remove in interface StorageDataFile<StorageEntity.Default>

prependEntry

public final void prependEntry(StorageEntity.Default entry)

Specified by:

prependEntry in interface StorageDataFile<StorageEntity.Default>

appendEntry

public final void appendEntry(StorageEntity.Default entry)

Specified by:

appendEntry in interface StorageDataFile<StorageEntity.Default>

loadEntityData

public final void loadEntityData(StorageEntity.Default entity,
                                 long length,
                                 long cacheChange)

Specified by:

loadEntityData in interface StorageDataFile<StorageEntity.Default>

hasUsers

public boolean hasUsers()

Specified by:

hasUsers in interface StorageLockedFile

executeIfUnsued

public boolean executeIfUnsued(Consumer<? super StorageLockedFile> action)

Specified by:

executeIfUnsued in interface StorageLockedFile

registerUsage

public boolean registerUsage(StorageFileUser fileUser)

Specified by:

registerUsage in interface StorageLockedFile

clearUsages

public boolean clearUsages(StorageFileUser fileUser)

Specified by:

clearUsages in interface StorageLockedFile

unregisterUsage

public boolean unregisterUsage(StorageFileUser fileUser)

Specified by:

unregisterUsage in interface StorageLockedFile

unregisterUsageClosing

public boolean unregisterUsageClosing(StorageFileUser fileUser,
                                      Consumer<? super StorageLockedFile> closingAction)

Specified by:

unregisterUsageClosing in interface StorageLockedFile

unregisterUsageClosingData

public final boolean unregisterUsageClosingData(StorageFileUser fileUser,
                                                Consumer<? super StorageDataFile.Default> closingAction)

executeIfUnsuedData

public boolean executeIfUnsuedData(Consumer<? super StorageDataFile.Default> action)

close

public void close()

Specified by:

close in interface StorageFile

Specified by:

close in interface StorageLockedFile

tryClose

public boolean tryClose()

Specified by:

tryClose in interface StorageLockedFile

isHeadFile

public boolean isHeadFile()

Specified by:

isHeadFile in interface StorageDataFile<StorageEntity.Default>

channelIndex

public int channelIndex()

Specified by:

channelIndex in interface StorageHashChannelPart

qualifier

public String qualifier()

Description copied from interface: StorageFile

Returns a string that gives StorageFile.name() a unique identity. Example: The parent directory path of a file.

Specified by:

qualifier in interface StorageFile

identifier

public String identifier()

Description copied from interface: StorageFile

Returns a string uniquely identifying the file represented by this instance.

Specified by:

identifier in interface StorageFile

Returns:

this file's unique identifier.

See Also:

StorageFile.name()

name

public String name()

Description copied from interface: StorageFile

Return a compact string containing a specific, but not necessarily unique name of the file represented by this instance. Might be the same string returned by StorageFile.identifier().

Specified by:

name in interface StorageFile

Returns:

this file's name.

See Also:

StorageFile.identifier()

delete

public boolean delete()

Specified by:

delete in interface StorageFile

exists

public boolean exists()

Specified by:

exists in interface StorageFile

fileChannel

public FileChannel fileChannel()

Specified by:

fileChannel in interface StorageFile

toString

public final String toString()

Overrides:

toString in class Object