org.mapdb.volume

Class FileChannelVol

java.lang.Object

org.mapdb.volume.Volume

org.mapdb.volume.FileChannelVol

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class FileChannelVol
extends Volume

Volume which uses FileChannel. Uses global lock and does not use mapped memory.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.channels.FileChannel	channel
static VolumeFactory	FACTORY
protected java.io.File	file
protected java.nio.channels.FileLock	fileLock
protected java.util.concurrent.locks.Lock	growLock
protected boolean	readOnly
protected long	size
protected int	sliceSize

Fields inherited from class org.mapdb.volume.Volume

closed, LOG, UNSAFE_VOL_FACTORY

Constructor Summary

Constructors

Constructor and Description
FileChannelVol(java.io.File file)
FileChannelVol(java.io.File file, boolean readOnly, long fileLockWait, int sliceShift, long initSize)

Method Summary

Modifier and Type	Method and Description
protected static void	checkFolder(java.io.File file, boolean readOnly)
static void	clear(java.nio.channels.FileChannel channel, long startOffset, long endOffset)
void	clear(long startOffset, long endOffset) Set all bytes between startOffset and endOffset to zero.
void	close()
void	ensureAvailable(long offset) Check space allocated by Volume is bigger or equal to given offset.
byte	getByte(long offset)
void	getData(long offset, byte[] bytes, int bytesPos, int size)
DataInput2.ByteBuffer	getDataInput(long offset, int size)
java.io.File	getFile() returns underlying file if it exists
boolean	getFileLocked() return true if this Volume holds exclusive lock over its file
int	getInt(long offset)
long	getLong(long offset)
boolean	isReadOnly()
boolean	isSliced()
long	length()
void	putByte(long offset, byte value)
void	putData(long offset, byte[] src, int srcPos, int srcSize)
void	putData(long offset, java.nio.ByteBuffer buf)
void	putInt(long offset, int value)
void	putLong(long offset, long value)
protected void	readFully(long offset, java.nio.ByteBuffer buf)
int	sliceSize()
void	sync()
void	truncate(long size)
protected void	writeFully(long offset, java.nio.ByteBuffer buf)

Methods inherited from class org.mapdb.volume.Volume

assertZeroes, clearOverlap, copyFrom, copyTo, copyTo, copyTo, deleteFile, fileLoad, finalize, getDataInputOverlap, getPackedLong, getSixLong, getUnsignedByte, getUnsignedShort, hash, isClosed, putDataOverlap, putPackedLong, putSixLong, putUnsignedByte, putUnsignedShort

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final VolumeFactory FACTORY

file

protected final java.io.File file

sliceSize

protected final int sliceSize

channel

protected java.nio.channels.FileChannel channel

readOnly

protected final boolean readOnly

fileLock

protected final java.nio.channels.FileLock fileLock

size

protected volatile long size

growLock

protected final java.util.concurrent.locks.Lock growLock

Constructor Detail

FileChannelVol

public FileChannelVol(java.io.File file,
                      boolean readOnly,
                      long fileLockWait,
                      int sliceShift,
                      long initSize)

FileChannelVol

public FileChannelVol(java.io.File file)

Method Detail

checkFolder

protected static void checkFolder(java.io.File file,
                                  boolean readOnly)
                           throws java.io.IOException

Throws:

java.io.IOException

ensureAvailable

public 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

truncate

public void truncate(long size)

Specified by:

truncate in class Volume

writeFully

protected void writeFully(long offset,
                          java.nio.ByteBuffer buf)

putLong

public void putLong(long offset,
                    long value)

Specified by:

putLong in class Volume

putInt

public void putInt(long offset,
                   int value)

Specified by:

putInt in class Volume

putByte

public void putByte(long offset,
                    byte value)

Specified by:

putByte in class Volume

putData

public void putData(long offset,
                    byte[] src,
                    int srcPos,
                    int srcSize)

Specified by:

putData in class Volume

putData

public void putData(long offset,
                    java.nio.ByteBuffer buf)

Specified by:

putData in class Volume

readFully

protected void readFully(long offset,
                         java.nio.ByteBuffer buf)

getLong

public long getLong(long offset)

Specified by:

getLong in class Volume

getInt

public int getInt(long offset)

Specified by:

getInt in class Volume

getByte

public byte getByte(long offset)

Specified by:

getByte in class Volume

getDataInput

public DataInput2.ByteBuffer getDataInput(long offset,
                                          int size)

Specified by:

getDataInput in class Volume

getData

public void getData(long offset,
                    byte[] bytes,
                    int bytesPos,
                    int size)

Specified by:

getData in class Volume

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class Volume

sync

public void sync()

Specified by:

sync in class Volume

sliceSize

public int sliceSize()

Specified by:

sliceSize in class Volume

Returns:

slice size or -1 if not sliced

isSliced

public boolean isSliced()

Specified by:

isSliced in class Volume

length

public long length()

Specified by:

length in class Volume

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class Volume

getFile

public java.io.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

clear

public void clear(long startOffset,
                  long endOffset)

Description copied from class: Volume

Set all bytes between startOffset and endOffset to zero. Area between offsets must be ready for write once clear finishes.

Specified by:

clear in class Volume

clear

public static void clear(java.nio.channels.FileChannel channel,
                         long startOffset,
                         long endOffset)