StorageLiveDataFile (MicroStream API)

All Superinterfaces:

StorageBackupableFile, StorageChannelFile, StorageClosableFile, StorageCreatableFile, StorageDataFile, StorageFile, StorageHashChannelPart, StorageLiveChannelFile<StorageLiveDataFile>, StorageLiveFile<StorageLiveDataFile>, StorageTruncatableChannelFile

All Known Implementing Classes:

StorageLiveDataFile.Default
```
public interface StorageLiveDataFile
extends StorageDataFile, StorageLiveChannelFile<StorageLiveDataFile>, StorageCreatableFile
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class StorageLiveDataFile.Default
- Nested classes/interfaces inherited from interface one.microstream.storage.types.StorageChannelFile
  StorageChannelFile.Abstract
- Nested classes/interfaces inherited from interface one.microstream.storage.types.StorageDataFile
  StorageDataFile.Abstract, StorageDataFile.Creator<F extends StorageDataFile>
- Nested classes/interfaces inherited from interface one.microstream.storage.types.StorageFile
  StorageFile.Abstract
- Nested classes/interfaces inherited from interface one.microstream.storage.types.StorageLiveFile
  StorageLiveFile.Abstract<S extends StorageLiveFile<S>>

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`double`	`dataFillRatio()`
`long`	`dataLength()`
`default StorageBackupDataFile`	`ensureBackupFile(StorageBackupInventory backupInventory)`
`boolean`	`hasSingleEntity()`	Querying method to check if a storage file consists of only one singular live entity.
`boolean`	`isHeadFile()`
`static StorageLiveDataFile.Default`	`New(StorageFileManager.Default parent, StorageDataInventoryFile inventoryFile)`
`long`	`totalLength()`

Methods inherited from interface one.microstream.storage.types.StorageClosableFile
close, isOpen

Methods inherited from interface one.microstream.storage.types.StorageCreatableFile
ensure

Methods inherited from interface one.microstream.storage.types.StorageDataFile
channelIndex, number

Methods inherited from interface one.microstream.storage.types.StorageFile
copyFrom, copyFrom, copyFrom, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, delete, exists, file, identifier, moveTo, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, size, writeBytes

Methods inherited from interface one.microstream.storage.types.StorageLiveFile
clearUsages, executeIfUnsued, hasUsers, registerUsage, unregisterUsage, unregisterUsageClosing

Methods inherited from interface one.microstream.storage.types.StorageTruncatableChannelFile
truncate

- Method Detail
  - totalLength
```
long totalLength()
```
  - dataLength
```
long dataLength()
```
  - dataFillRatio
```
double dataFillRatio()
```
  - isHeadFile
```
boolean isHeadFile()
```
  - hasSingleEntity
```
boolean hasSingleEntity()
```
    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.
    
    Returns:
    
    true if the file contains exactly one live entity.
  - ensureBackupFile
```
default StorageBackupDataFile ensureBackupFile(StorageBackupInventory backupInventory)
```
    Specified by:
    
    ensureBackupFile in interface StorageBackupableFile
    
    Specified by:
    
    ensureBackupFile in interface StorageDataFile
    
    Specified by:
    
    ensureBackupFile in interface StorageLiveChannelFile<StorageLiveDataFile>
  - New
```
static StorageLiveDataFile.Default New(StorageFileManager.Default parent,
                                       StorageDataInventoryFile inventoryFile)
```