org.mapdb

Class Volume.ReadOnly

java.lang.Object

org.mapdb.Volume

org.mapdb.Volume.ReadOnly

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

Volume

public static final class Volume.ReadOnly
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
protected Volume	vol

Fields inherited from class org.mapdb.Volume

closed, LOG, UNSAFE_VOL_FACTORY

Constructor Summary

Constructors

Constructor and Description
Volume.ReadOnly(Volume vol)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(long startOffset, long endOffset) Set all bytes between startOffset and endOffset to zero.
void	close()
void	deleteFile()
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)
DataInput	getDataInputOverlap(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	getLongPackBidi(long offset)
long	getLongPackBidiReverse(long offset, long limitOffset)
long	getSixLong(long pos)
int	getUnsignedByte(long offset)
int	getUnsignedShort(long offset)
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	putDataOverlap(long offset, byte[] src, int srcPos, int srcSize)
void	putInt(long offset, int value)
void	putLong(long offset, long value)
int	putLongPackBidi(long offset, long value)
void	putSixLong(long pos, long value)
void	putUnsignedByte(long offset, int b)
void	putUnsignedShort(long offset, int value)
int	sliceSize()
void	sync()
void	transferInto(long inputOffset, Volume target, long targetOffset, long size) Transfers data from this Volume into target volume.
void	truncate(long size)

Methods inherited from class org.mapdb.Volume

assertZeroes, copyEntireVolumeTo, fileLoad, finalize, getPackedLong, hash, isClosed, putPackedLong, volumeTransfer

Methods inherited from class java.lang.Object

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

Field Detail

vol

protected final Volume vol

Constructor Detail

Volume.ReadOnly

public Volume.ReadOnly(Volume vol)

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

putDataOverlap

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

Overrides:

putDataOverlap 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

getDataInputOverlap

public DataInput getDataInputOverlap(long offset,
                            int size)

Overrides:

getDataInputOverlap 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

deleteFile

public void deleteFile()

Overrides:

deleteFile in class Volume

isSliced

public boolean isSliced()

Specified by:

isSliced in class Volume

length

public long length()

Specified by:

length 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 b)

Overrides:

putUnsignedByte in class Volume

putLongPackBidi

public int putLongPackBidi(long offset,
                  long value)

Overrides:

putLongPackBidi in class Volume

getLongPackBidi

public long getLongPackBidi(long offset)

Overrides:

getLongPackBidi in class Volume

getLongPackBidiReverse

public long getLongPackBidiReverse(long offset,
                          long limitOffset)

Overrides:

getLongPackBidiReverse in class Volume

getSixLong

public long getSixLong(long pos)

Overrides:

getSixLong in class Volume

putSixLong

public void putSixLong(long pos,
              long value)

Overrides:

putSixLong 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

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

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