Package org.apache.mina.util.byteaccess

Interface ByteArray

All Superinterfaces:

IoAbsoluteReader, IoAbsoluteWriter

All Known Implementing Classes:

AbstractByteArray, BufferByteArray, ByteArrayPool.DirectBufferByteArray, CompositeByteArray

public interface ByteArray
extends IoAbsoluteReader, IoAbsoluteWriter

Represents a sequence of bytes that can be read or written directly or through a cursor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ByteArray.Cursor	Provides relocatable, relative access to the underlying array.

Method Summary

Modifier and Type	Method	Description
ByteArray.Cursor	cursor()
ByteArray.Cursor	cursor(int index)
boolean	equals(Object other)	A ByteArray is equal to another ByteArray if they start and end at the same index, have the same byte order, and contain the same bytes at each index.
int	first()
void	free()	Remove any resources associated with this object.
Iterable<IoBuffer>	getIoBuffers()
IoBuffer	getSingleIoBuffer()
int	last()
ByteOrder	order()
void	order(ByteOrder order)	Set the byte order of the array.

Methods inherited from interface org.apache.mina.util.byteaccess.IoAbsoluteReader

get, get, getChar, getDouble, getFloat, getInt, getLong, getShort, length, slice

Methods inherited from interface org.apache.mina.util.byteaccess.IoAbsoluteWriter

put, put, putChar, putDouble, putFloat, putInt, putLong, putShort

Method Details

first

int first()

Returns:

the index of the first byte that can be accessed.

last

int last()

Returns:

the index after the last byte that can be accessed.

order

ByteOrder order()

Returns:

the order of the bytes.

order

void order(ByteOrder order)

Set the byte order of the array.

Parameters:

order - The ByteOrder to use

free

void free()

Remove any resources associated with this object. Using the object after this method is called may result in undefined behaviour.

getIoBuffers

Iterable<IoBuffer> getIoBuffers()

Returns:

the sequence of IoBuffers that back this array. Compared to getSingleIoBuffer(), this method should be relatively efficient for all implementations.

getSingleIoBuffer

IoBuffer getSingleIoBuffer()

Returns:

a single IoBuffer that backs this array. Some implementations may initially have data split across multiple buffers, so calling this method may require a new buffer to be allocated and populated.

equals

boolean equals(Object other)

A ByteArray is equal to another ByteArray if they start and end at the same index, have the same byte order, and contain the same bytes at each index.

Overrides:

equals in class Object

Parameters:

other - The ByteArray we want to compare with

Returns:

true if both ByteArray are equals

cursor

ByteArray.Cursor cursor()

Returns:

a cursor starting at index 0 (which may not be the start of the array).

cursor

ByteArray.Cursor cursor(int index)

Parameters:

index - The starting point

Returns:

a cursor starting at the given index.