org.mapdb

Class Volume.RandomAccessFileVol

java.lang.Object

org.mapdb.Volume

org.mapdb.Volume.RandomAccessFileVol

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

Volume

public static final class Volume.RandomAccessFileVol
extends Volume

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
protected File	file
protected FileLock	fileLock
protected RandomAccessFile	raf

Fields inherited from class org.mapdb.Volume

closed, LOG, UNSAFE_VOL_FACTORY

Constructor Summary

Constructors

Constructor and Description
Volume.RandomAccessFileVol(File file, boolean readOnly, boolean fileLockDisable, long initSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(long startOffset, long endOffset) Set all bytes between startOffset and endOffset to zero.
protected static void	clearRAF(RandomAccessFile raf, long startOffset, long endOffset)
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)
DataInput	getDataInput(long offset, int size)
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)
long	getPackedLong(long pos) Unpack long value from the Volume.
long	getSixLong(long offset)
int	getUnsignedShort(long offset)
long	hash(long off, long len, long seed) Calculates XXHash64 from this Volume content.
boolean	isSliced()
long	length()
void	putByte(long offset, byte value)
void	putData(long offset, byte[] src, int srcPos, int srcSize)
void	putData(long offset, ByteBuffer buf)
void	putInt(long offset, int value)
void	putLong(long offset, long value)
int	putPackedLong(long pos, long value) Put packed long at given position.
void	putSixLong(long pos, long value)
void	putUnsignedShort(long offset, int value)
int	sliceSize()
void	sync()
void	truncate(long size)

Methods inherited from class org.mapdb.Volume

assertZeroes, copyEntireVolumeTo, deleteFile, fileLoad, finalize, getDataInputOverlap, getLongPackBidi, getLongPackBidiReverse, getUnsignedByte, isClosed, putDataOverlap, putLongPackBidi, putUnsignedByte, transferInto, 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

file

protected final File file

raf

protected final RandomAccessFile raf

fileLock

protected final FileLock fileLock

Constructor Detail

Volume.RandomAccessFileVol

public Volume.RandomAccessFileVol(File file,
                          boolean readOnly,
                          boolean fileLockDisable,
                          long initSize)

Method Detail

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

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,
           ByteBuffer buf)

Specified by:

putData in class Volume

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 DataInput 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 Closeable

Specified by:

close in interface 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

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

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

clearRAF

protected static void clearRAF(RandomAccessFile raf,
            long startOffset,
            long endOffset)
                        throws IOException

Throws:

IOException

putUnsignedShort

public void putUnsignedShort(long offset,
                    int value)

Overrides:

putUnsignedShort in class Volume

getUnsignedShort

public int getUnsignedShort(long offset)

Overrides:

getUnsignedShort in class Volume

getSixLong

public long getSixLong(long offset)

Overrides:

getSixLong in class Volume

putSixLong

public void putSixLong(long pos,
              long value)

Overrides:

putSixLong in class Volume

putPackedLong

public int putPackedLong(long pos,
                long value)

Description copied from class: Volume

Put packed long at given position.

Overrides:

putPackedLong in class Volume

value - to be written

Returns:

number of bytes consumed by packed value

getPackedLong

public long getPackedLong(long pos)

Description copied from class: Volume

Unpack long value from the Volume. Highest 4 bits reused to indicate number of bytes read from Volume. One can use result & DataIO.PACK_LONG_RESULT_MASK to remove size;

Overrides:

getPackedLong in class Volume

Parameters:

pos - to read value from

Returns:

The long value, minus highest byte

hash

public long hash(long off,
        long len,
        long seed)

Description copied from class: Volume

Calculates XXHash64 from this Volume content.

This code comes from LZ4-Java created by Adrien Grand.

Overrides:

hash in class Volume

Parameters:

off - offset to start calculation from

len - length of data to calculate hash

seed - hash seed

Returns:

XXHash.