one.microstream.storage.types

Class StorageEntity.Default

java.lang.Object

one.microstream.storage.types.StorageEntity.Default

All Implemented Interfaces:

StorageEntity

Enclosing interface:

StorageEntity

public static final class StorageEntity.Default
extends Object
implements StorageEntity

Nested Class Summary

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

StorageEntity.Default, StorageEntity.MaxObjectId, StorageEntity.MinObjectId

Method Summary

Modifier and Type	Method and Description
long	cachedDataLength() The length this entity occupies in the cache.
long	clearCache()
void	copyCachedData(MemoryRangeReader entityDataCollector)
long	dataLength()
long	exportTo(one.microstream.afs.types.AWritableFile file)
boolean	hasReferences()
boolean	iterateReferenceIds(one.microstream.persistence.types.PersistenceObjectIdAcceptor referenceIdIterator)
long	lastTouched() The approximate system time that this particular entity has been last touched.
long	objectId()
StorageLiveDataFile	storageFile()
long	storagePosition()
String	toString()
long	typeId()

Methods inherited from class java.lang.Object

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

Method Detail

dataLength

public final long dataLength()

Specified by:

dataLength in interface StorageEntity

Returns:

The entity's data length, meaning the pure content length without any header or meta data.

typeId

public long typeId()

Specified by:

typeId in interface StorageEntity

Returns:

The entity's type id.

storagePosition

public final long storagePosition()

Specified by:

storagePosition in interface StorageEntity

cachedDataLength

public final long cachedDataLength()

Description copied from interface: StorageEntity

The length this entity occupies in the cache. This might be vary, even for fixed length typed, from the values returned by StorageEntity.dataLength() as only parts of an entity (e.g. only references) might be loaded into cache and because the cache might hold the header/meta data of an entity as well.

Specified by:

cachedDataLength in interface StorageEntity

Returns:

The length this entity occupies in the cache.

hasReferences

public final boolean hasReferences()

Specified by:

hasReferences in interface StorageEntity

Returns:

The information if this entity's type has reference fields (regardless of a particular entity's actual data).

objectId

public final long objectId()

Specified by:

objectId in interface StorageEntity

Returns:

The entity's biunique identifying id number.

lastTouched

public final long lastTouched()

Description copied from interface: StorageEntity

The approximate system time that this particular entity has been last touched. The returned value is compatible to the value returned by System.currentTimeMillis().

Specified by:

lastTouched in interface StorageEntity

Returns:

approximate system time that this particular entity has been last touched

storageFile

public final StorageLiveDataFile storageFile()

Specified by:

storageFile in interface StorageEntity

iterateReferenceIds

public final boolean iterateReferenceIds(one.microstream.persistence.types.PersistenceObjectIdAcceptor referenceIdIterator)

Specified by:

iterateReferenceIds in interface StorageEntity

exportTo

public final long exportTo(one.microstream.afs.types.AWritableFile file)

Specified by:

exportTo in interface StorageEntity

copyCachedData

public final void copyCachedData(MemoryRangeReader entityDataCollector)

Specified by:

copyCachedData in interface StorageEntity

clearCache

public final long clearCache()

Specified by:

clearCache in interface StorageEntity

toString

public final String toString()

Overrides:

toString in class Object