org.embulk.spi

Class Buffer

java.lang.Object

org.embulk.spi.Buffer

public abstract class Buffer
extends Object

A buffer used in and between plugins. It wraps a byte array.

It will be a pure abstract class, but it now has some static creator methods implemented.

Those static creator methods, allocate(int), copyOf(byte[]), copyOf(byte[], int, int), wrap(byte[]), and wrap(byte[], int, int) are implemented for compatibility for some legacy plugins calling them. They will be removed before Embulk v1. Plugins should no longer call them, even in tests.

At the same time, a constant Buffer.EMPTY has already been removed. Plugins cannot use it anymore.

Since:

0.4.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Buffer()
protected	Buffer(byte[] wrap, int offset, int capacity) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Buffer	allocate(int length) Deprecated. This method is to be removed. Plugins should no longer call it directly.
abstract byte[]	array() Deprecated. Accessing the internal byte array is not safe.
abstract int	capacity() Returns the capacity of this Buffer.
static Buffer	copyOf(byte[] src) Deprecated. This method is to be removed. Plugins should no longer call it directly.
static Buffer	copyOf(byte[] src, int index, int length) Deprecated. This method is to be removed. Plugins should no longer call it directly.
abstract void	getBytes(int index, Buffer dest, int destIndex, int length) Copies an array from this Buffer, beginning at index, to destIndex of dest.
abstract void	getBytes(int index, byte[] dest, int destIndex, int length) Copies an array from this Buffer, beginning at index, to destIndex of dest.
abstract int	limit() Returns the current limit of this Buffer.
abstract Buffer	limit(int limit) Sets the current limit of this Buffer.
abstract int	offset() Returns the current offset of this Buffer.
abstract Buffer	offset(int offset) Sets the current offset of this Buffer.
abstract void	release() Releases this Buffer.
abstract void	setBytes(int index, Buffer source, int sourceIndex, int length) Copies an array from source, beginning at sourceIndex, to index of this Buffer.
abstract void	setBytes(int index, byte[] source, int sourceIndex, int length) Copies an array from source, beginning at sourceIndex, to index of this Buffer.
static Buffer	wrap(byte[] src) Deprecated. This method is to be removed. Plugins should no longer call it directly.
static Buffer	wrap(byte[] src, int offset, int size) Deprecated. This method is to be removed. Plugins should no longer call it directly.

Methods inherited from class java.lang.Object

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

Constructor Detail

Buffer

protected Buffer()

Buffer

@Deprecated
protected Buffer(byte[] wrap,
                             int offset,
                             int capacity)

Deprecated.

Method Detail

array

@Deprecated
public abstract byte[] array()

Deprecated. Accessing the internal byte array is not safe.

Returns the internal byte array of this Buffer.

Returns:

the internal byte array

Since:

0.4.0

offset

public abstract int offset()

Returns the current offset of this Buffer.

Returns:

the current offset

Since:

0.4.0

offset

public abstract Buffer offset(int offset)

Sets the current offset of this Buffer.

Parameters:

offset - the offset to set

Returns:

this Buffer itself

Since:

0.4.0

limit

public abstract int limit()

Returns the current limit of this Buffer.

Returns:

the current limit

Since:

0.4.0

limit

public abstract Buffer limit(int limit)

Sets the current limit of this Buffer.

Parameters:

limit - the limit to set

Returns:

this Buffer itself

Since:

0.4.0

capacity

public abstract int capacity()

Returns the capacity of this Buffer.

The capacity does not change once created.

Returns:

the capacity

Since:

0.4.0

setBytes

public abstract void setBytes(int index,
                              byte[] source,
                              int sourceIndex,
                              int length)

Copies an array from source, beginning at sourceIndex, to index of this Buffer.

Parameters:

index - starting position in this destination Buffer

source - the source array

sourceIndex - starting position in the source array

length - the number of bytes to be copied

Since:

0.4.0

setBytes

public abstract void setBytes(int index,
                              Buffer source,
                              int sourceIndex,
                              int length)

Copies an array from source, beginning at sourceIndex, to index of this Buffer.

Parameters:

index - starting position in this destination Buffer

source - the source Buffer

sourceIndex - starting position in the source Buffer

length - the number of bytes to be copied

Since:

0.4.0

getBytes

public abstract void getBytes(int index,
                              byte[] dest,
                              int destIndex,
                              int length)

Copies an array from this Buffer, beginning at index, to destIndex of dest.

Parameters:

index - starting position in this source Buffer

dest - the destination array

destIndex - starting position in the destination array

length - the number of bytes to be copied

Since:

0.4.0

getBytes

public abstract void getBytes(int index,
                              Buffer dest,
                              int destIndex,
                              int length)

Copies an array from this Buffer, beginning at index, to destIndex of dest.

Parameters:

index - starting position in this source Buffer

dest - the destination Buffer

destIndex - starting position in the destination Buffer

length - the number of bytes to be copied

Since:

0.4.0

release

public abstract void release()

Releases this Buffer.

Since:

0.4.0

allocate

@Deprecated
public static Buffer allocate(int length)

Deprecated. This method is to be removed. Plugins should no longer call it directly.

Creates a new Buffer instance.

Parameters:

length - length of the created Buffer

Returns:

created Buffer

Since:

0.4.0

copyOf

@Deprecated
public static Buffer copyOf(byte[] src)

Deprecated. This method is to be removed. Plugins should no longer call it directly.

Creates a new Buffer instance copied from src.

Parameters:

src - the source byte array

Returns:

created Buffer

Since:

0.4.0

copyOf

@Deprecated
public static Buffer copyOf(byte[] src,
                                        int index,
                                        int length)

Deprecated. This method is to be removed. Plugins should no longer call it directly.

Creates a new Buffer instance copied from src.

Parameters:

src - the source byte array

index - starting position in the source array

length - the number of bytes to be copied

Returns:

created Buffer

Since:

0.4.0

wrap

@Deprecated
public static Buffer wrap(byte[] src)

Deprecated. This method is to be removed. Plugins should no longer call it directly.

Creates a new Buffer instance wrapping src as the internal array.

Parameters:

src - the source byte array

Returns:

created Buffer

Since:

0.4.0

wrap

@Deprecated
public static Buffer wrap(byte[] src,
                                      int offset,
                                      int size)

Deprecated. This method is to be removed. Plugins should no longer call it directly.

Creates a new Buffer instance wrapping src as the internal array.

Parameters:

src - the source byte array

offset - starting position in the source array

size - the number of bytes to be wrapped

Returns:

created Buffer

Since:

0.4.0