io.pravega.common.util

Interface ArrayView

All Known Implementing Classes:

ByteArraySegment

public interface ArrayView

Defines a generic read-only view of an index-based, array-like structure.

Method Summary

Modifier and Type	Method and Description
byte[]	array() Gets a reference to the backing array for this ArrayView.
int	arrayOffset() Gets a value indicating the offset in the backing array where this ArrayView starts at.
void	copyTo(byte[] target, int targetOffset, int length) Copies a specified number of bytes from this ArrayView into the given target array.
byte	get(int index) Gets the value at the specified index.
byte[]	getCopy() Returns a copy of the contents of this ArrayView.
int	getLength() Gets a value representing the length of this ArrayView.
java.io.InputStream	getReader() Creates an InputStream that can be used to read the contents of this ArrayView.
java.io.InputStream	getReader(int offset, int length) Creates an InputStream that can be used to read the contents of this ArrayView.

Method Detail

get

byte get(int index)

Gets the value at the specified index.

Parameters:

index - The index to query.

Returns:

Byte indicating the value at the given index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If index is invalid.

getLength

int getLength()

Gets a value representing the length of this ArrayView.

Returns:

The length.

array

byte[] array()

Gets a reference to the backing array for this ArrayView. This should be used in conjunction with arrayOffset() in order to determine where in the array this ArrayView starts at. NOTE: Care must be taken when using this array. Just like any other array in Java, it is modifiable and changes to it will be reflected in this ArrayView.

Returns:

The backing array.

arrayOffset

int arrayOffset()

Gets a value indicating the offset in the backing array where this ArrayView starts at.

Returns:

The offset in the backing array.

getReader

java.io.InputStream getReader()

Creates an InputStream that can be used to read the contents of this ArrayView. The InputStream returned spans the entire ArrayView.

Returns:

The InputStream.

getReader

java.io.InputStream getReader(int offset,
                              int length)

Creates an InputStream that can be used to read the contents of this ArrayView. The InputStream returned spans the given section of the ArrayView.

Parameters:

offset - The starting offset of the section to read.

length - The length of the section to read.

Returns:

The InputStream.

copyTo

void copyTo(byte[] target,
            int targetOffset,
            int length)

Copies a specified number of bytes from this ArrayView into the given target array.

Parameters:

target - The target array.

targetOffset - The offset within the target array to start copying data at.

length - The number of bytes to copy.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If targetOffset or length are invalid.

getCopy

byte[] getCopy()

Returns a copy of the contents of this ArrayView.

Returns:

A byte array with the same length as this ArrayView, containing a copy of the data within it.