org.apache.flink.runtime.memorymanager

Class CheckedMemorySegment

java.lang.Object

org.apache.flink.runtime.memorymanager.CheckedMemorySegment

public class CheckedMemorySegment
extends Object

This class represents a piece of memory allocated from the memory manager. The segment is backed by a byte array and features random put and get methods for the basic types that are stored in a byte-wise fashion in the memory.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	memory The array in which the data is stored.
protected int	offset The offset in the memory array where this segment starts.
protected int	size The size of the memory segment.
protected ByteBuffer	wrapper Wrapper for I/O requests.

Constructor Summary

Constructors

Constructor and Description
CheckedMemorySegment(byte[] memory)

Method Summary

Methods

Modifier and Type	Method and Description
CheckedMemorySegment	get(DataOutput out, int offset, int length)
byte	get(int index)
CheckedMemorySegment	get(int index, byte[] dst)
CheckedMemorySegment	get(int index, byte[] dst, int offset, int length)
byte[]	getBackingArray()
boolean	getBoolean(int index)
char	getChar(int index)
double	getDouble(int index)
float	getFloat(int index)
int	getInt(int index)
int	getIntBigEndian(int index)
int	getIntLittleEndian(int index)
long	getLong(int index)
long	getLongBigEndian(int index)
long	getLongLittleEndian(int index)
short	getShort(int index)
boolean	isFreed()
CheckedMemorySegment	put(DataInput in, int offset, int length)
CheckedMemorySegment	put(int index, byte b)
CheckedMemorySegment	put(int index, byte[] src)
CheckedMemorySegment	put(int index, byte[] src, int offset, int length)
CheckedMemorySegment	putBoolean(int index, boolean value)
CheckedMemorySegment	putChar(int index, char value)
CheckedMemorySegment	putDouble(int index, double value)
CheckedMemorySegment	putFloat(int index, float value)
void	putInt(int index, int value)
void	putIntBigEndian(int index, int value)
void	putIntLittleEndian(int index, int value)
void	putLong(int index, long value)
void	putLongBigEndian(int index, long value)
void	putLongLittleEndian(int index, long value)
CheckedMemorySegment	putShort(int index, short value)
int	size()
int	translateOffset(int offset)
ByteBuffer	wrap(int offset, int length)

Methods inherited from class java.lang.Object

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

Field Detail

memory

protected byte[] memory

The array in which the data is stored.

offset

protected final int offset

The offset in the memory array where this segment starts.

size

protected final int size

The size of the memory segment.

wrapper

protected ByteBuffer wrapper

Wrapper for I/O requests.

Constructor Detail

CheckedMemorySegment

public CheckedMemorySegment(byte[] memory)

Method Detail

isFreed

public boolean isFreed()

size

public final int size()

getBackingArray

public final byte[] getBackingArray()

translateOffset

public final int translateOffset(int offset)

wrap

public ByteBuffer wrap(int offset,
              int length)

get

public final byte get(int index)

put

public final CheckedMemorySegment put(int index,
                       byte b)

get

public final CheckedMemorySegment get(int index,
                       byte[] dst)

put

public final CheckedMemorySegment put(int index,
                       byte[] src)

get

public final CheckedMemorySegment get(int index,
                       byte[] dst,
                       int offset,
                       int length)

put

public final CheckedMemorySegment put(int index,
                       byte[] src,
                       int offset,
                       int length)

get

public final CheckedMemorySegment get(DataOutput out,
                       int offset,
                       int length)
                               throws IOException

Throws:

IOException

put

public final CheckedMemorySegment put(DataInput in,
                       int offset,
                       int length)
                               throws IOException

Throws:

IOException

getBoolean

public final boolean getBoolean(int index)

putBoolean

public final CheckedMemorySegment putBoolean(int index,
                              boolean value)

getChar

public final char getChar(int index)

putChar

public final CheckedMemorySegment putChar(int index,
                           char value)

getShort

public final short getShort(int index)

putShort

public final CheckedMemorySegment putShort(int index,
                            short value)

getInt

public final int getInt(int index)

getIntLittleEndian

public final int getIntLittleEndian(int index)

getIntBigEndian

public final int getIntBigEndian(int index)

putInt

public final void putInt(int index,
          int value)

putIntLittleEndian

public final void putIntLittleEndian(int index,
                      int value)

putIntBigEndian

public final void putIntBigEndian(int index,
                   int value)

getLong

public final long getLong(int index)

getLongLittleEndian

public final long getLongLittleEndian(int index)

getLongBigEndian

public final long getLongBigEndian(int index)

putLong

public final void putLong(int index,
           long value)

putLongLittleEndian

public final void putLongLittleEndian(int index,
                       long value)

putLongBigEndian

public final void putLongBigEndian(int index,
                    long value)

getFloat

public final float getFloat(int index)

putFloat

public final CheckedMemorySegment putFloat(int index,
                            float value)

getDouble

public final double getDouble(int index)

putDouble

public final CheckedMemorySegment putDouble(int index,
                             double value)