org.apache.mina.util.byteaccess

Class CompositeByteArrayRelativeReader

java.lang.Object

org.apache.mina.util.byteaccess.CompositeByteArrayRelativeBase

org.apache.mina.util.byteaccess.CompositeByteArrayRelativeReader

All Implemented Interfaces:

IoRelativeReader

public class CompositeByteArrayRelativeReader
extends CompositeByteArrayRelativeBase
implements IoRelativeReader

Provides restricted, relative, read-only access to the bytes in a CompositeByteArray. Using this interface has the advantage that it can be automatically determined when a component ByteArray can no longer be read, and thus components can be automatically freed. This makes it easier to use pooling for underlying ByteArrays.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autoFree Whether or not to free component CompositeByteArrays when the cursor moves past them.

Fields inherited from class org.apache.mina.util.byteaccess.CompositeByteArrayRelativeBase

cba, cursor

Constructor Summary

Constructors

Constructor and Description
CompositeByteArrayRelativeReader(CompositeByteArray cba, boolean autoFree) Creates a new instance of CompositeByteArrayRelativeReader.

Method Summary

Modifier and Type	Method and Description
protected void	cursorPassedFirstComponent() Called whenever the cursor has passed from the cba's first component.
byte	get() Returns the byte at the current position in the buffer
void	get(IoBuffer bb) places the data starting at current position into the supplied IoBuffer
char	getChar() Gets a char and advances the reader.
double	getDouble() Gets a double and advances the reader.
float	getFloat() Gets a float and advances the reader.
int	getInt() Gets an int and advances the reader.
long	getLong() Gets a long and advances the reader.
short	getShort() Gets a short and advances the reader.
void	skip(int length) Advances the reader by the given number of bytes.
ByteArray	slice(int length) Creates an array with a view of part of this array.

Methods inherited from class org.apache.mina.util.byteaccess.CompositeByteArrayRelativeBase

append, free, getIndex, getRemaining, hasRemaining, last, order

Methods inherited from class java.lang.Object

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

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

getRemaining, hasRemaining, order

Field Detail

autoFree

private final boolean autoFree

Whether or not to free component CompositeByteArrays when the cursor moves past them.

Constructor Detail

CompositeByteArrayRelativeReader

public CompositeByteArrayRelativeReader(CompositeByteArray cba,
                                        boolean autoFree)

Creates a new instance of CompositeByteArrayRelativeReader.

Parameters:

cba - The backing ByteArray

autoFree - If data should be freed once it has been passed in the list

Method Detail

cursorPassedFirstComponent

protected void cursorPassedFirstComponent()

Description copied from class: CompositeByteArrayRelativeBase

Called whenever the cursor has passed from the cba's first component. As the first component is no longer used, this provides a good opportunity for subclasses to perform some action on it (such as freeing it).

Specified by:

cursorPassedFirstComponent in class CompositeByteArrayRelativeBase

skip

public void skip(int length)

Description copied from interface: IoRelativeReader

Advances the reader by the given number of bytes.

Specified by:

skip in interface IoRelativeReader

slice

public ByteArray slice(int length)

Description copied from interface: IoRelativeReader

Creates an array with a view of part of this array.

Specified by:

slice in interface IoRelativeReader

get

public byte get()

Returns the byte at the current position in the buffer

Specified by:

get in interface IoRelativeReader

get

public void get(IoBuffer bb)

places the data starting at current position into the supplied IoBuffer

Specified by:

get in interface IoRelativeReader

getShort

public short getShort()

Description copied from interface: IoRelativeReader

Gets a short and advances the reader.

Specified by:

getShort in interface IoRelativeReader

getInt

public int getInt()

Description copied from interface: IoRelativeReader

Gets an int and advances the reader.

Specified by:

getInt in interface IoRelativeReader

getLong

public long getLong()

Description copied from interface: IoRelativeReader

Gets a long and advances the reader.

Specified by:

getLong in interface IoRelativeReader

getFloat

public float getFloat()

Description copied from interface: IoRelativeReader

Gets a float and advances the reader.

Specified by:

getFloat in interface IoRelativeReader

getDouble

public double getDouble()

Description copied from interface: IoRelativeReader

Gets a double and advances the reader.

Specified by:

getDouble in interface IoRelativeReader

getChar

public char getChar()

Description copied from interface: IoRelativeReader

Gets a char and advances the reader.

Specified by:

getChar in interface IoRelativeReader