Package org.apache.mina.util.byteaccess
Class BufferByteArray
- java.lang.Object
-
- org.apache.mina.util.byteaccess.BufferByteArray
-
- All Implemented Interfaces:
ByteArray
,IoAbsoluteReader
,IoAbsoluteWriter
public abstract class BufferByteArray extends Object
AByteArray
backed by aIoBuffer
. This class is abstract. Subclasses need to override thefree()
method. An implementation backed by a heapIoBuffer
can be created with aSimpleByteArrayFactory
.- Author:
- Apache MINA Project
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.mina.util.byteaccess.ByteArray
ByteArray.Cursor
-
-
Constructor Summary
Constructors Constructor Description BufferByteArray(IoBuffer bb)
Creates a new instance of BufferByteArray and uses the suppliedIoBuffer
to back this class
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
byte
get(int index)
void
get(int index, IoBuffer other)
Gets enough bytes to fill theIoBuffer
from the given index.char
getChar(int index)
double
getDouble(int index)
float
getFloat(int index)
int
getInt(int index)
Iterable<IoBuffer>
getIoBuffers()
long
getLong(int index)
short
getShort(int index)
IoBuffer
getSingleIoBuffer()
int
hashCode()
int
last()
int
length()
ByteOrder
order()
void
order(ByteOrder order)
Set the byte order of the array.void
put(int index, byte b)
Puts abyte
at the given index.void
put(int index, IoBuffer other)
Puts bytes from theIoBuffer
at the given index.void
putChar(int index, char c)
Puts achar
at the given index.void
putDouble(int index, double d)
Puts adouble
at the given index.void
putFloat(int index, float f)
Puts afloat
at the given index.void
putInt(int index, int i)
Puts anint
at the given index.void
putLong(int index, long l)
Puts along
at the given index.void
putShort(int index, short s)
Puts ashort
at the given index.ByteArray
slice(int index, int length)
Creates an array with a view of part of this array.
-
-
-
Field Detail
-
bb
protected IoBuffer bb
The backingIoBuffer
.
-
-
Method Detail
-
getIoBuffers
public Iterable<IoBuffer> getIoBuffers()
- Returns:
- the sequence of
IoBuffer
s that back this array. Compared togetSingleIoBuffer()
, this method should be relatively efficient for all implementations.
-
getSingleIoBuffer
public 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.
-
slice
public ByteArray slice(int index, int length)
Creates an array with a view of part of this array. Callingfree()
on the returned slice has no effect.- Parameters:
index
- The starting positionlength
- The number of bytes to copy- Returns:
- The ByteArray that is a view on the original array
-
cursor
public ByteArray.Cursor cursor()
- Returns:
- a cursor starting at index 0 (which may not be the start of the array).
-
cursor
public ByteArray.Cursor cursor(int index)
- Parameters:
index
- The starting point- Returns:
- a cursor starting at the given index.
-
first
public int first()
- Returns:
- the index of the first byte that can be accessed.
-
last
public int last()
- Returns:
- the index after the last byte that can be accessed.
-
order
public ByteOrder order()
- Returns:
- the order of the bytes.
-
order
public void order(ByteOrder order)
Set the byte order of the array.- Parameters:
order
- The ByteOrder to use
-
get
public byte get(int index)
- Parameters:
index
- The starting position- Returns:
- a
byte
from the given index.
-
put
public void put(int index, byte b)
Puts abyte
at the given index.- Parameters:
index
- The positionb
- The byte to put
-
get
public void get(int index, IoBuffer other)
Gets enough bytes to fill theIoBuffer
from the given index.- Parameters:
index
- The starting positionother
- The IoBuffer that will be filled with the bytes
-
put
public void put(int index, IoBuffer other)
Puts bytes from theIoBuffer
at the given index.- Parameters:
index
- The positionother
- The bytes to put
-
getShort
public short getShort(int index)
- Parameters:
index
- The starting position- Returns:
- a
short
from the given index.
-
putShort
public void putShort(int index, short s)
Puts ashort
at the given index.- Parameters:
index
- The positions
- The short to put
-
getInt
public int getInt(int index)
- Parameters:
index
- The starting position- Returns:
- an
int
from the given index.
-
putInt
public void putInt(int index, int i)
Puts anint
at the given index.- Parameters:
index
- The positioni
- The int to put
-
getLong
public long getLong(int index)
- Parameters:
index
- The starting position- Returns:
- a
long
from the given index.
-
putLong
public void putLong(int index, long l)
Puts along
at the given index.- Parameters:
index
- The positionl
- The long to put
-
getFloat
public float getFloat(int index)
- Parameters:
index
- The starting position- Returns:
- a
float
from the given index.
-
putFloat
public void putFloat(int index, float f)
Puts afloat
at the given index.- Parameters:
index
- The positionf
- The float to put
-
getDouble
public double getDouble(int index)
- Parameters:
index
- The starting position- Returns:
- a
double
from the given index.
-
putDouble
public void putDouble(int index, double d)
Puts adouble
at the given index.- Parameters:
index
- The positiond
- The doubvle to put
-
getChar
public char getChar(int index)
- Parameters:
index
- The starting position- Returns:
- a
char
from the given index.
-
putChar
public void putChar(int index, char c)
Puts achar
at the given index.- Parameters:
index
- The positionc
- The char to put
-
hashCode
public int hashCode()
-
length
public final int length()
- Specified by:
length
in interfaceIoAbsoluteReader
- Returns:
- the total number of bytes that can be accessed.
-
equals
public final 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.
-
-