org.mapdb

Class Volume.MappedFileVol

java.lang.Object

org.mapdb.Volume

org.mapdb.Volume.ByteBufferVol

org.mapdb.Volume.MappedFileVol

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

Volume

public static final class Volume.MappedFileVol
extends Volume.ByteBufferVol

Nested Class Summary

Nested classes/interfaces inherited from class org.mapdb.Volume

Volume.ByteArrayVol, Volume.ByteBufferVol, Volume.ByteBufferVolSingle, Volume.FileChannelVol, Volume.MappedFileVol, Volume.MappedFileVolSingle, Volume.MemoryVol, Volume.MemoryVolSingle, Volume.RandomAccessFileVol, Volume.ReadOnly, Volume.SingleByteArrayVol, Volume.VolumeFactory

Field Summary

Fields

Modifier and Type	Field and Description
static Volume.VolumeFactory	FACTORY
static Volume.VolumeFactory	FACTORY_WITH_CLEANER_HACK
protected File	file
protected FileChannel	fileChannel
protected FileLock	fileLock
protected FileChannel.MapMode	mapMode
protected RandomAccessFile	raf

Fields inherited from class org.mapdb.Volume.ByteBufferVol

cleanerHackEnabled, growLock, readOnly, slices, sliceShift, sliceSize, sliceSizeModMask

Fields inherited from class org.mapdb.Volume

closed, LOG, UNSAFE_VOL_FACTORY

Constructor Summary

Constructors

Constructor and Description
Volume.MappedFileVol(File file, boolean readOnly, boolean fileLockDisable, int sliceShift, boolean cleanerHackEnabled, long initSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	ensureAvailable(long offset) Check space allocated by Volume is bigger or equal to given offset.
boolean	fileLoad() If underlying storage is memory-mapped-file, this method will try to load and precache all file data into disk cache.
File	getFile() returns underlying file if it exists
boolean	getFileLocked() return true if this Volume holds exclusive lock over its file
long	length()
void	sync()
void	truncate(long size)

Methods inherited from class org.mapdb.Volume.ByteBufferVol

clear, getByte, getData, getDataInput, getDataInputOverlap, getInt, getLong, getPackedLong, getSixLong, getSlice, getUnsignedByte, getUnsignedShort, isSliced, putByte, putData, putData, putDataOverlap, putInt, putLong, putPackedLong, putSixLong, putUnsignedByte, putUnsignedShort, sliceSize, toByte, toByte, transferInto, unmap

Methods inherited from class org.mapdb.Volume

assertZeroes, copyEntireVolumeTo, deleteFile, finalize, getLongPackBidi, getLongPackBidiReverse, hash, isClosed, putLongPackBidi, volumeTransfer

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final Volume.VolumeFactory FACTORY

FACTORY_WITH_CLEANER_HACK

public static final Volume.VolumeFactory FACTORY_WITH_CLEANER_HACK

file

protected final File file

fileChannel

protected final FileChannel fileChannel

mapMode

protected final FileChannel.MapMode mapMode

raf

protected final RandomAccessFile raf

fileLock

protected final FileLock fileLock

Constructor Detail

Volume.MappedFileVol

public Volume.MappedFileVol(File file,
                    boolean readOnly,
                    boolean fileLockDisable,
                    int sliceShift,
                    boolean cleanerHackEnabled,
                    long initSize)

Method Detail

ensureAvailable

public final void ensureAvailable(long offset)

Description copied from class: Volume

Check space allocated by Volume is bigger or equal to given offset. So it is safe to write into smaller offsets.

Specified by:

ensureAvailable in class Volume

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Volume

sync

public void sync()

Specified by:

sync in class Volume

length

public long length()

Specified by:

length in class Volume

getFile

public File getFile()

Description copied from class: Volume

returns underlying file if it exists

Specified by:

getFile in class Volume

getFileLocked

public boolean getFileLocked()

Description copied from class: Volume

return true if this Volume holds exclusive lock over its file

Specified by:

getFileLocked in class Volume

truncate

public void truncate(long size)

Specified by:

truncate in class Volume

fileLoad

public boolean fileLoad()

Description copied from class: Volume

If underlying storage is memory-mapped-file, this method will try to load and precache all file data into disk cache. Most likely it will call MappedByteBuffer.load(), but could also read content of entire file etc This method will not pin data into memory, they might be removed at any time.

Overrides:

fileLoad in class Volume

Returns:

true if this method did something, false if underlying storage does not support loading