org.mapdb.volume

Class ByteBufferVolSingle

java.lang.Object

org.mapdb.volume.Volume

org.mapdb.volume.ByteBufferVolSingle

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ByteBufferMemoryVolSingle, MappedFileVolSingle

public abstract class ByteBufferVolSingle
extends Volume

Abstract Volume over single ByteBuffer, maximal size is 2GB (32bit limit). It leaves ByteBufferVol details (allocation, disposal) on subclasses. Most methods are final for better performance (JIT compiler can inline those).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.ByteBuffer	buffer
protected boolean	cleanerHackEnabled
protected long	maxSize
protected boolean	readOnly

Fields inherited from class org.mapdb.volume.Volume

closed, LOG, UNSAFE_VOL_FACTORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ByteBufferVolSingle(boolean readOnly, long maxSize, boolean cleanerHackEnabled)

Method Summary

Modifier and Type	Method and Description
void	clear(long startOffset, long endOffset) Set all bytes between startOffset and endOffset to zero.
void	copyTo(long inputOffset, Volume target, long targetOffset, long size) Transfers data from this Volume into target volume.
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[] src, int srcPos, int srcSize)
DataInput2.ByteBuffer	getDataInput(long offset, int size)
DataInput2	getDataInputOverlap(long offset, int size)
int	getInt(long offset)
long	getLong(long offset)
boolean	isSliced()
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	putDataOverlap(long offset, byte[] data, int pos, int len)
void	putInt(long offset, int value)
void	putLong(long offset, long value)
int	sliceSize()

Methods inherited from class org.mapdb.volume.Volume

assertZeroes, clearOverlap, close, copyFrom, copyTo, copyTo, deleteFile, fileLoad, finalize, getFile, getFileLocked, getPackedLong, getSixLong, getUnsignedByte, getUnsignedShort, hash, isClosed, isReadOnly, length, putPackedLong, putSixLong, putUnsignedByte, putUnsignedShort, sync, truncate

Methods inherited from class java.lang.Object

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

Field Detail

cleanerHackEnabled

protected final boolean cleanerHackEnabled

buffer

protected java.nio.ByteBuffer buffer

readOnly

protected final boolean readOnly

maxSize

protected final long maxSize

Constructor Detail

ByteBufferVolSingle

protected ByteBufferVolSingle(boolean readOnly,
                              long maxSize,
                              boolean cleanerHackEnabled)

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

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

Specified by:

putData in class Volume

copyTo

public void copyTo(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:

copyTo 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 DataInput2.ByteBuffer 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 DataInput2 getDataInputOverlap(long offset,
                                      int size)

Overrides:

getDataInputOverlap 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

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