org.mapdb

Class Volume.ByteBufferVol

java.lang.Object

org.mapdb.Volume

org.mapdb.Volume.ByteBufferVol

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

Volume.MappedFileVol, Volume.MemoryVol

Enclosing class:

Volume

public abstract static class Volume.ByteBufferVol
extends Volume

Abstract Volume over bunch of ByteBuffers It leaves ByteBufferVol details (allocation, disposal) on subclasses. Most methods are final for better performance (JIT compiler can inline those).

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
protected boolean	cleanerHackEnabled
protected ReentrantLock	growLock
protected boolean	readOnly
protected ByteBuffer[]	slices
protected int	sliceShift
protected int	sliceSize
protected int	sliceSizeModMask

Fields inherited from class org.mapdb.Volume

closed, LOG, UNSAFE_VOL_FACTORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Volume.ByteBufferVol(boolean readOnly, int sliceShift, boolean cleanerHackEnabled)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(long startOffset, long endOffset) Set all bytes between startOffset and endOffset to zero.
byte	getByte(long offset)
void	getData(long offset, byte[] src, int srcPos, int srcSize)
DataIO.DataInputByteBuffer	getDataInput(long offset, int size)
DataInput	getDataInputOverlap(long offset, int size)
int	getInt(long offset)
long	getLong(long offset)
long	getPackedLong(long position) Unpack long value from the Volume.
long	getSixLong(long pos)
protected ByteBuffer	getSlice(long offset)
int	getUnsignedByte(long offset)
int	getUnsignedShort(long offset)
boolean	isSliced()
void	putByte(long offset, byte value)
void	putData(long offset, byte[] src, int srcPos, int srcSize)
void	putData(long offset, ByteBuffer buf)
void	putDataOverlap(long offset, byte[] data, int pos, int len)
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	putUnsignedByte(long offset, int byt)
void	putUnsignedShort(long offset, int value)
int	sliceSize()
protected static byte	toByte(int byt)
protected static byte	toByte(long l)
void	transferInto(long inputOffset, Volume target, long targetOffset, long size) Transfers data from this Volume into target volume.
protected static boolean	unmap(MappedByteBuffer b) Hack to unmap MappedByteBuffer.

Methods inherited from class org.mapdb.Volume

assertZeroes, close, copyEntireVolumeTo, deleteFile, ensureAvailable, fileLoad, finalize, getFile, getFileLocked, getLongPackBidi, getLongPackBidiReverse, hash, isClosed, length, putLongPackBidi, sync, truncate, volumeTransfer

Methods inherited from class java.lang.Object

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

Field Detail

cleanerHackEnabled

protected final boolean cleanerHackEnabled

growLock

protected final ReentrantLock growLock

sliceShift

protected final int sliceShift

sliceSizeModMask

protected final int sliceSizeModMask

sliceSize

protected final int sliceSize

slices

protected volatile ByteBuffer[] slices

readOnly

protected final boolean readOnly

Constructor Detail

Volume.ByteBufferVol

protected Volume.ByteBufferVol(boolean readOnly,
                    int sliceShift,
                    boolean cleanerHackEnabled)

Method Detail

getSlice

protected final ByteBuffer getSlice(long offset)

putLong

public final void putLong(long offset,
           long value)

Specified by:

putLong in class Volume

putInt

public final void putInt(long offset,
          int value)

Specified by:

putInt in class Volume

putByte

public final 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 final void putData(long offset,
           ByteBuffer buf)

Specified by:

putData in class Volume

transferInto

public void transferInto(long inputOffset,
                Volume target,
                long targetOffset,
                long size)

Description copied from class: Volume

Transfers data from this Volume into target volume. If its possible, the implementation should override this method to enable direct memory transfer. Caller must respect slice boundaries. ie it is not possible to transfer data which cross slice boundaries.

Overrides:

transferInto in class Volume

Parameters:

inputOffset - offset inside this Volume, ie data will be read from this offset

target - Volume to copy data into

targetOffset - position in target volume where data will be copied into

size - size of data to copy

getData

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

Specified by:

getData in class Volume

getLong

public final long getLong(long offset)

Specified by:

getLong in class Volume

getInt

public final int getInt(long offset)

Specified by:

getInt in class Volume

getByte

public final byte getByte(long offset)

Specified by:

getByte in class Volume

getDataInput

public final DataIO.DataInputByteBuffer getDataInput(long offset,
                                      int size)

Specified by:

getDataInput in class Volume

putDataOverlap

public void putDataOverlap(long offset,
                  byte[] data,
                  int pos,
                  int len)

Overrides:

putDataOverlap in class Volume

getDataInputOverlap

public DataInput getDataInputOverlap(long offset,
                            int size)

Overrides:

getDataInputOverlap in class Volume

putUnsignedShort

public void putUnsignedShort(long offset,
                    int value)

Overrides:

putUnsignedShort in class Volume

getUnsignedShort

public int getUnsignedShort(long offset)

Overrides:

getUnsignedShort in class Volume

getUnsignedByte

public int getUnsignedByte(long offset)

Overrides:

getUnsignedByte in class Volume

putUnsignedByte

public void putUnsignedByte(long offset,
                   int byt)

Overrides:

putUnsignedByte in class Volume

toByte

protected static byte toByte(int byt)

toByte

protected static byte toByte(long l)

getSixLong

public long getSixLong(long pos)

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 position)

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:

position - to read value from

Returns:

The long value, minus highest byte

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

isSliced

public boolean isSliced()

Specified by:

isSliced in class Volume

sliceSize

public int sliceSize()

Specified by:

sliceSize in class Volume

Returns:

slice size or -1 if not sliced

unmap

protected static boolean unmap(MappedByteBuffer b)

Hack to unmap MappedByteBuffer. Unmap is necessary on Windows, otherwise file is locked until JVM exits or BB is GCed. There is no public JVM API to unmap buffer, so this tries to use SUN proprietary API for unmap. Any error is silently ignored (for example SUN API does not exist on Android).