com.yahoo.memory

Class MemoryRegionR

java.lang.Object

com.yahoo.memory.MemoryRegion

com.yahoo.memory.MemoryRegionR

All Implemented Interfaces:

Memory

public class MemoryRegionR
extends MemoryRegion

Read-only version of MemoryRegion

Author:

Praveenkumar Venkatesan

Constructor Summary

Constructors

Constructor and Description
MemoryRegionR(Memory memory, long memOffsetBytes, long capacityBytes, MemoryRequest memReq)

Method Summary

Modifier and Type	Method and Description
Object	array() Returns the backing on-heap primitive array if there is one, otherwise returns null
ByteBuffer	byteBuffer() Returns the backing ByteBuffer if there is one, otherwise returns null
void	clear() Clears all bytes of this Memory to zero
void	clear(long offsetBytes, long lengthBytes) Clears a portion of this Memory to zero.
void	clearBits(long offsetBytes, byte bitMask) Clears the bits defined by the bitMask
void	copy(long srcOffsetBytes, long dstOffsetBytes, long lengthBytes) Copies bytes from a source region of this Memory to a destination region of this Memory.
void	fill(byte value) Fills all bytes of this Memory region to the given byte value.
void	fill(long offsetBytes, long lengthBytes, byte value) Fills a portion of this Memory region to the given byte value.
int	getAndAddInt(long offsetBytes, int delta) Atomically adds the given value to the integer located at offsetBytes.
long	getAndAddLong(long offsetBytes, long delta) Atomically adds the given value to the long located at offsetBytes.
int	getAndSetInt(long offsetBytes, int newValue) Atomically exchanges the given value with the current value located at offsetBytes.
long	getAndSetLong(long offsetBytes, long newValue) Atomically exchanges the given value with the current value located at offsetBytes.
NativeMemory	getNativeMemory() Returns the root NativeMemory, which could also be the derived MemoryMappedFile or AllocMemory.
Object	getParent() Gets the parent Memory or backing array.
boolean	isReadOnly() Returns true if this Memory is read only
void	putBoolean(long offsetBytes, boolean srcValue) Puts the boolean value at the given offset
void	putBooleanArray(long offsetBytes, boolean[] srcArray, int srcOffset, int length) Puts the boolean array at the given offset
void	putByte(long offsetBytes, byte srcValue) Puts the byte value at the given offset
void	putByteArray(long offsetBytes, byte[] srcArray, int srcOffset, int length) Puts the byte array at the given offset
void	putChar(long offsetBytes, char srcValue) Puts the char value at the given offset
void	putCharArray(long offsetBytes, char[] srcArray, int srcOffset, int length) Puts the char array at the given offset
void	putDouble(long offsetBytes, double srcValue) Puts the double value at the given offset
void	putDoubleArray(long offsetBytes, double[] srcArray, int srcOffset, int length) Puts the double array at the given offset
void	putFloat(long offsetBytes, float srcValue) Puts the float value at the given offset
void	putFloatArray(long offsetBytes, float[] srcArray, int srcOffset, int length) Puts the float array at the given offset
void	putInt(long offsetBytes, int srcValue) Puts the int value at the given offset
void	putIntArray(long offsetBytes, int[] srcArray, int srcOffset, int length) Puts the int array at the given offset
void	putLong(long offsetBytes, long srcValue) Puts the long value at the given offset
void	putLongArray(long offsetBytes, long[] srcArray, int srcOffset, int length) Puts the long array at the given offset
void	putShort(long offsetBytes, short srcValue) Puts the short value at the given offset
void	putShortArray(long offsetBytes, short[] srcArray, int srcOffset, int length) Puts the short array at the given offset
void	setBits(long offsetBytes, byte bitMask) Sets the bits defined by the bitMask
void	setMemoryRequest(MemoryRequest memReq) Sets a MemoryRequest

Methods inherited from class com.yahoo.memory.MemoryRegion

asReadOnlyMemory, getAddress, getBoolean, getBooleanArray, getByte, getByteArray, getCapacity, getChar, getCharArray, getCumulativeOffset, getDouble, getDoubleArray, getFloat, getFloatArray, getInt, getIntArray, getLong, getLongArray, getMemoryRequest, getShort, getShortArray, hasArray, hasByteBuffer, isAllBitsClear, isAllBitsSet, isAllocated, isAnyBitsClear, isAnyBitsSet, isDirect, reassign, toHexString

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryRegionR

public MemoryRegionR(Memory memory,
                     long memOffsetBytes,
                     long capacityBytes,
                     MemoryRequest memReq)

Method Detail

clear

public void clear()

Description copied from interface: Memory

Clears all bytes of this Memory to zero

Specified by:

clear in interface Memory

Overrides:

clear in class MemoryRegion

clear

public void clear(long offsetBytes,
                  long lengthBytes)

Description copied from interface: Memory

Clears a portion of this Memory to zero.

Specified by:

clear in interface Memory

Overrides:

clear in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

lengthBytes - the length in bytes

clearBits

public void clearBits(long offsetBytes,
                      byte bitMask)

Description copied from interface: Memory

Clears the bits defined by the bitMask

Specified by:

clearBits in interface Memory

Overrides:

clearBits in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start.

bitMask - the bits set to one will be cleared

copy

public void copy(long srcOffsetBytes,
                 long dstOffsetBytes,
                 long lengthBytes)

Description copied from interface: Memory

Copies bytes from a source region of this Memory to a destination region of this Memory. These regions may not overlap. This will be checked if asserts are enabled in the JVM.

Specified by:

copy in interface Memory

Overrides:

copy in class MemoryRegion

Parameters:

srcOffsetBytes - the source offset

dstOffsetBytes - the destintaion offset

lengthBytes - the number of bytes to copy

fill

public void fill(long offsetBytes,
                 long lengthBytes,
                 byte value)

Description copied from interface: Memory

Fills a portion of this Memory region to the given byte value.

Specified by:

fill in interface Memory

Overrides:

fill in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

lengthBytes - the length in bytes

value - the given byte value

fill

public void fill(byte value)

Description copied from interface: Memory

Fills all bytes of this Memory region to the given byte value.

Specified by:

fill in interface Memory

Overrides:

fill in class MemoryRegion

Parameters:

value - the given byte value

getAndAddInt

public int getAndAddInt(long offsetBytes,
                        int delta)

Description copied from interface: Memory

Atomically adds the given value to the integer located at offsetBytes.

Specified by:

getAndAddInt in interface Memory

Overrides:

getAndAddInt in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

delta - the amount to add

Returns:

the modified value

getAndAddLong

public long getAndAddLong(long offsetBytes,
                          long delta)

Description copied from interface: Memory

Atomically adds the given value to the long located at offsetBytes.

Specified by:

getAndAddLong in interface Memory

Overrides:

getAndAddLong in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

delta - the amount to add

Returns:

the modified value

getAndSetInt

public int getAndSetInt(long offsetBytes,
                        int newValue)

Description copied from interface: Memory

Atomically exchanges the given value with the current value located at offsetBytes.

Specified by:

getAndSetInt in interface Memory

Overrides:

getAndSetInt in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

newValue - new value

Returns:

the previous value

getAndSetLong

public long getAndSetLong(long offsetBytes,
                          long newValue)

Description copied from interface: Memory

Atomically exchanges the given value with the current value located at offsetBytes.

Specified by:

getAndSetLong in interface Memory

Overrides:

getAndSetLong in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

newValue - new value

Returns:

the previous value

putBoolean

public void putBoolean(long offsetBytes,
                       boolean srcValue)

Description copied from interface: Memory

Puts the boolean value at the given offset

Specified by:

putBoolean in interface Memory

Overrides:

putBoolean in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putBooleanArray

public void putBooleanArray(long offsetBytes,
                            boolean[] srcArray,
                            int srcOffset,
                            int length)

Description copied from interface: Memory

Puts the boolean array at the given offset

Specified by:

putBooleanArray in interface Memory

Overrides:

putBooleanArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putByte

public void putByte(long offsetBytes,
                    byte srcValue)

Description copied from interface: Memory

Puts the byte value at the given offset

Specified by:

putByte in interface Memory

Overrides:

putByte in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putByteArray

public void putByteArray(long offsetBytes,
                         byte[] srcArray,
                         int srcOffset,
                         int length)

Description copied from interface: Memory

Puts the byte array at the given offset

Specified by:

putByteArray in interface Memory

Overrides:

putByteArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putChar

public void putChar(long offsetBytes,
                    char srcValue)

Description copied from interface: Memory

Puts the char value at the given offset

Specified by:

putChar in interface Memory

Overrides:

putChar in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putCharArray

public void putCharArray(long offsetBytes,
                         char[] srcArray,
                         int srcOffset,
                         int length)

Description copied from interface: Memory

Puts the char array at the given offset

Specified by:

putCharArray in interface Memory

Overrides:

putCharArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putDouble

public void putDouble(long offsetBytes,
                      double srcValue)

Description copied from interface: Memory

Puts the double value at the given offset

Specified by:

putDouble in interface Memory

Overrides:

putDouble in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putDoubleArray

public void putDoubleArray(long offsetBytes,
                           double[] srcArray,
                           int srcOffset,
                           int length)

Description copied from interface: Memory

Puts the double array at the given offset

Specified by:

putDoubleArray in interface Memory

Overrides:

putDoubleArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putFloat

public void putFloat(long offsetBytes,
                     float srcValue)

Description copied from interface: Memory

Puts the float value at the given offset

Specified by:

putFloat in interface Memory

Overrides:

putFloat in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putFloatArray

public void putFloatArray(long offsetBytes,
                          float[] srcArray,
                          int srcOffset,
                          int length)

Description copied from interface: Memory

Puts the float array at the given offset

Specified by:

putFloatArray in interface Memory

Overrides:

putFloatArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putInt

public void putInt(long offsetBytes,
                   int srcValue)

Description copied from interface: Memory

Puts the int value at the given offset

Specified by:

putInt in interface Memory

Overrides:

putInt in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putIntArray

public void putIntArray(long offsetBytes,
                        int[] srcArray,
                        int srcOffset,
                        int length)

Description copied from interface: Memory

Puts the int array at the given offset

Specified by:

putIntArray in interface Memory

Overrides:

putIntArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putLong

public void putLong(long offsetBytes,
                    long srcValue)

Description copied from interface: Memory

Puts the long value at the given offset

Specified by:

putLong in interface Memory

Overrides:

putLong in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putLongArray

public void putLongArray(long offsetBytes,
                         long[] srcArray,
                         int srcOffset,
                         int length)

Description copied from interface: Memory

Puts the long array at the given offset

Specified by:

putLongArray in interface Memory

Overrides:

putLongArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

putShort

public void putShort(long offsetBytes,
                     short srcValue)

Description copied from interface: Memory

Puts the short value at the given offset

Specified by:

putShort in interface Memory

Overrides:

putShort in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcValue - the value to put

putShortArray

public void putShortArray(long offsetBytes,
                          short[] srcArray,
                          int srcOffset,
                          int length)

Description copied from interface: Memory

Puts the short array at the given offset

Specified by:

putShortArray in interface Memory

Overrides:

putShortArray in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

srcArray - The source array.

srcOffset - offset in array units

length - number of array units to transfer The size of this array determines the bytes transferred.

setBits

public void setBits(long offsetBytes,
                    byte bitMask)

Description copied from interface: Memory

Sets the bits defined by the bitMask

Specified by:

setBits in interface Memory

Overrides:

setBits in class MemoryRegion

Parameters:

offsetBytes - offset bytes relative to this Memory start

bitMask - the bits set to one will be set

array

public Object array()

Description copied from interface: Memory

Returns the backing on-heap primitive array if there is one, otherwise returns null

Specified by:

array in interface Memory

Overrides:

array in class MemoryRegion

Returns:

the backing on-heap primitive array if there is one, otherwise returns null

byteBuffer

public ByteBuffer byteBuffer()

Description copied from interface: Memory

Returns the backing ByteBuffer if there is one, otherwise returns null

Specified by:

byteBuffer in interface Memory

Overrides:

byteBuffer in class MemoryRegion

Returns:

the backing ByteBuffer if there is one, otherwise returns null

getNativeMemory

public NativeMemory getNativeMemory()

Description copied from interface: Memory

Returns the root NativeMemory, which could also be the derived MemoryMappedFile or AllocMemory.

Specified by:

getNativeMemory in interface Memory

Overrides:

getNativeMemory in class MemoryRegion

Returns:

the root NativeMemory.

getParent

public Object getParent()

Description copied from interface: Memory

Gets the parent Memory or backing array. Used internally.

Specified by:

getParent in interface Memory

Overrides:

getParent in class MemoryRegion

Returns:

the parent Memory.

isReadOnly

public boolean isReadOnly()

Description copied from interface: Memory

Returns true if this Memory is read only

Specified by:

isReadOnly in interface Memory

Overrides:

isReadOnly in class MemoryRegion

Returns:

true if this Memory is read only

setMemoryRequest

public void setMemoryRequest(MemoryRequest memReq)

Description copied from interface: Memory

Sets a MemoryRequest

Specified by:

setMemoryRequest in interface Memory

Overrides:

setMemoryRequest in class MemoryRegion

Parameters:

memReq - the MemoryRequest