xerial.larray.buffer

Class LBufferAPI

java.lang.Object

xerial.larray.buffer.LBufferAPI

Direct Known Subclasses:

LBuffer, WrappedLBuffer

public class LBufferAPI
extends java.lang.Object

Defines common utility methods for accessing LBuffer

Field Summary

Fields

Modifier and Type	Field and Description
Memory	m

Constructor Summary

Constructors

Constructor and Description
LBufferAPI()
LBufferAPI(Memory m)

Method Summary

Modifier and Type	Method and Description
long	address() Address of the data part of the allocated memory
byte	apply(int offset) Read a byte at offset
byte	apply(long offset) Read a byte at offset
void	clear() Clear the buffer by filling with zeros
void	copyTo(int srcOffset, byte[] destArray, int destOffset, int size) Copy the contents of this buffer begginning from the srcOffset to a destination byte array
void	copyTo(long srcOffset, LBufferAPI dest, long destOffset, long size) Copy the contents of this buffer to the destination LBuffer
void	fill(long offset, long length, byte value) Fill the buffer of the specified range with a given value
byte	getByte(int offset)
byte	getByte(long offset)
char	getChar(int offset)
char	getChar(long offset)
double	getDouble(int offset)
double	getDouble(long offset)
float	getFloat(int offset)
float	getFloat(long offset)
int	getInt(int offset)
int	getInt(long offset)
long	getLong(int offset)
long	getLong(long offset)
short	getShort(int offset)
short	getShort(long offset)
static LBuffer	loadFrom(java.io.File file) Create an LBuffer from a given file.
protected long	offset()
void	putByte(int offset, byte value)
void	putByte(long offset, byte value)
void	putChar(int offset, char value)
void	putChar(long offset, char value)
void	putDouble(int offset, double value)
void	putDouble(long offset, double value)
void	putFloat(int offset, float value)
void	putFloat(long offset, float value)
void	putInt(int offset, int value)
void	putInt(long offset, int value)
void	putLong(int offset, long value)
void	putLong(long offset, long value)
void	putShort(int offset, short value)
void	putShort(long offset, short value)
int	readFrom(byte[] src, int srcOffset, long destOffset, int length) Read the given source byte array, then overwrite this buffer's contents
int	readFrom(byte[] src, long destOffset) Read the given source byte array, then overwrite this buffer's contents
int	readFrom(java.nio.ByteBuffer src, long destOffset) Reads the given source byte buffer into this buffer at the given offset
void	release() Release the memory content.
long	size() Size of this buffer
LBuffer	slice(long from, long to) Extract a slice [from, to) of this buffer.
byte[]	toArray() Convert this buffer to a java array.
java.nio.ByteBuffer	toDirectByteBuffer(long offset, int size) Gives a ByteBuffer view of the specified range.
java.nio.ByteBuffer[]	toDirectByteBuffers() Gives an sequence of ByteBuffers.
java.nio.ByteBuffer[]	toDirectByteBuffers(long offset, long size) Gives an sequence of ByteBuffers of a specified range.
void	update(int offset, byte value) Set a byte at offset
void	update(long offset, byte value) Set a byte at offset
WrappedLBuffer	view(long from, long to) Create a view of the range [from, to) of this buffer.
void	writeTo(java.io.File file) Dump the buffer contents to a file
void	writeTo(java.nio.channels.FileChannel channel) Write the buffer contents to the given file channel.
void	writeTo(java.nio.channels.GatheringByteChannel channel) Writes the buffer contents to the given byte channel.
void	writeTo(java.nio.channels.WritableByteChannel channel) Writes the buffer contents to the given byte channel.

Methods inherited from class java.lang.Object

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

Field Detail

m

public Memory m

Constructor Detail

LBufferAPI

public LBufferAPI()

LBufferAPI

public LBufferAPI(Memory m)

Method Detail

apply

public byte apply(int offset)

Read a byte at offset

Parameters:

offset -

Returns:

update

public void update(int offset,
                   byte value)

Set a byte at offset

Parameters:

offset -

value -

apply

public byte apply(long offset)

Read a byte at offset

Parameters:

offset -

Returns:

update

public void update(long offset,
                   byte value)

Set a byte at offset

Parameters:

offset -

value -

release

public void release()

Release the memory content. After this method invocation, the behaviour of getXXX and putXXX methods becomes undefined.

address

public long address()

Address of the data part of the allocated memory

Returns:

size

public long size()

Size of this buffer

Returns:

clear

public void clear()

Clear the buffer by filling with zeros

fill

public void fill(long offset,
                 long length,
                 byte value)

Fill the buffer of the specified range with a given value

Parameters:

offset -

length -

value -

getByte

public byte getByte(int offset)

getChar

public char getChar(int offset)

getShort

public short getShort(int offset)

getInt

public int getInt(int offset)

getFloat

public float getFloat(int offset)

getLong

public long getLong(int offset)

getDouble

public double getDouble(int offset)

putByte

public void putByte(int offset,
                    byte value)

putChar

public void putChar(int offset,
                    char value)

putShort

public void putShort(int offset,
                     short value)

putInt

public void putInt(int offset,
                   int value)

putFloat

public void putFloat(int offset,
                     float value)

putLong

public void putLong(int offset,
                    long value)

putDouble

public void putDouble(int offset,
                      double value)

getByte

public byte getByte(long offset)

getChar

public char getChar(long offset)

getShort

public short getShort(long offset)

getInt

public int getInt(long offset)

getFloat

public float getFloat(long offset)

getLong

public long getLong(long offset)

getDouble

public double getDouble(long offset)

putByte

public void putByte(long offset,
                    byte value)

putChar

public void putChar(long offset,
                    char value)

putShort

public void putShort(long offset,
                     short value)

putInt

public void putInt(long offset,
                   int value)

putFloat

public void putFloat(long offset,
                     float value)

putLong

public void putLong(long offset,
                    long value)

putDouble

public void putDouble(long offset,
                      double value)

copyTo

public void copyTo(int srcOffset,
                   byte[] destArray,
                   int destOffset,
                   int size)

Copy the contents of this buffer begginning from the srcOffset to a destination byte array

Parameters:

srcOffset -

destArray -

destOffset -

size -

copyTo

public void copyTo(long srcOffset,
                   LBufferAPI dest,
                   long destOffset,
                   long size)

Copy the contents of this buffer to the destination LBuffer

Parameters:

srcOffset -

dest -

destOffset -

size -

slice

public LBuffer slice(long from,
                     long to)

Extract a slice [from, to) of this buffer. This methods creates a copy of the specified region.

Parameters:

from -

to -

Returns:

view

public WrappedLBuffer view(long from,
                           long to)

Create a view of the range [from, to) of this buffer. Unlike slice(from, to), the generated view is a reference to this buffer.

Parameters:

from -

to -

Returns:

toArray

public byte[] toArray()

Convert this buffer to a java array.

Returns:

writeTo

public void writeTo(java.nio.channels.FileChannel channel)
             throws java.io.IOException

Write the buffer contents to the given file channel. This method just calls channel.write(this.toDirectByteBuffers());

Parameters:

channel -

Throws:

java.io.IOException

writeTo

public void writeTo(java.nio.channels.GatheringByteChannel channel)
             throws java.io.IOException

Writes the buffer contents to the given byte channel.

Parameters:

channel -

Throws:

java.io.IOException

writeTo

public void writeTo(java.nio.channels.WritableByteChannel channel)
             throws java.io.IOException

Writes the buffer contents to the given byte channel.

Parameters:

channel -

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.File file)
             throws java.io.IOException

Dump the buffer contents to a file

Parameters:

file -

Throws:

java.io.IOException

readFrom

public int readFrom(byte[] src,
                    long destOffset)

Read the given source byte array, then overwrite this buffer's contents

Parameters:

src - source byte array

destOffset - offset in this buffer to read to

Returns:

the number of bytes read

readFrom

public int readFrom(byte[] src,
                    int srcOffset,
                    long destOffset,
                    int length)

Read the given source byte array, then overwrite this buffer's contents

Parameters:

src - source byte array

srcOffset - offset in source byte array to read from

destOffset - offset in this buffer to read to

length - max number of bytes to read

Returns:

the number of bytes read

readFrom

public int readFrom(java.nio.ByteBuffer src,
                    long destOffset)

Reads the given source byte buffer into this buffer at the given offset

Parameters:

src - source byte buffer

destOffset - offset in this buffer to read to

Returns:

the number of bytes read

loadFrom

public static LBuffer loadFrom(java.io.File file)
                        throws java.io.IOException

Create an LBuffer from a given file.

Parameters:

file -

Returns:

Throws:

java.io.IOException

toDirectByteBuffers

public java.nio.ByteBuffer[] toDirectByteBuffers()

Gives an sequence of ByteBuffers. Writing to these ByteBuffers modifies the contents of this LBuffer.

Returns:

toDirectByteBuffers

public java.nio.ByteBuffer[] toDirectByteBuffers(long offset,
                                                 long size)

Gives an sequence of ByteBuffers of a specified range. Writing to these ByteBuffers modifies the contents of this LBuffer.

Parameters:

offset -

size -

Returns:

toDirectByteBuffer

public java.nio.ByteBuffer toDirectByteBuffer(long offset,
                                              int size)

Gives a ByteBuffer view of the specified range. Writing to the returned ByteBuffer modifies the contenets of this LByteBuffer

Parameters:

offset -

size -

Returns:

offset

protected long offset()