org.apache.mina.util.byteaccess

Class CompositeByteArrayRelativeBase

java.lang.Object

org.apache.mina.util.byteaccess.CompositeByteArrayRelativeBase

Direct Known Subclasses:

CompositeByteArrayRelativeReader, CompositeByteArrayRelativeWriter

abstract class CompositeByteArrayRelativeBase
extends java.lang.Object

Provides common functionality between the CompositeByteArrayRelativeReader and CompositeByteArrayRelativeWriter.

Field Summary

Fields

Modifier and Type	Field and Description
protected CompositeByteArray	cba The underlying CompositeByteArray.
protected ByteArray.Cursor	cursor A cursor of the underlying CompositeByteArray.

Constructor Summary

Constructors

Constructor and Description
CompositeByteArrayRelativeBase(CompositeByteArray cba) Creates a new instance of CompositeByteArrayRelativeBase.

Method Summary

Modifier and Type	Method and Description
void	append(ByteArray ba) Make a ByteArray available for access at the end of this object.
protected abstract void	cursorPassedFirstComponent() Called whenever the cursor has passed from the cba's first component.
void	free() Free all resources associated with this object.
int	getIndex() Get the index that will be used for the next access.
int	getRemaining()
boolean	hasRemaining()
int	last() Get the index after the last byte that can be accessed.
java.nio.ByteOrder	order()

Methods inherited from class java.lang.Object

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

Field Detail

cba

protected final CompositeByteArray cba

The underlying CompositeByteArray.

cursor

protected final ByteArray.Cursor cursor

A cursor of the underlying CompositeByteArray. This cursor is never moved directly; its position only changes through calls to relative read or write methods.

Constructor Detail

CompositeByteArrayRelativeBase

public CompositeByteArrayRelativeBase(CompositeByteArray cba)

Creates a new instance of CompositeByteArrayRelativeBase.

Parameters:

cba - The CompositeByteArray that will be the base for this class

Method Detail

getRemaining

public final int getRemaining()

hasRemaining

public final boolean hasRemaining()

order

public java.nio.ByteOrder order()

append

public final void append(ByteArray ba)

Make a ByteArray available for access at the end of this object.

free

public final void free()

Free all resources associated with this object.

getIndex

public final int getIndex()

Get the index that will be used for the next access.

last

public final int last()

Get the index after the last byte that can be accessed.

cursorPassedFirstComponent

protected abstract void cursorPassedFirstComponent()

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).