net.sf.mmm.util.io.api

Interface ByteArrayBuffer

All Superinterfaces:

ByteArray, ByteBuffer, ByteIterator, ByteProvider

All Known Implementing Classes:

ByteArrayBufferImpl

public interface ByteArrayBuffer
extends ByteArray, ByteBuffer

This is the interface for a byte[] buffer. It is similar to ByteBuffer but a lot simpler. However it allows to set the current index so the internal buffer-array can be consumed externally and proceeded very fast.

Since:

1.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	setCurrentIndex(int currentIndex) This method sets the currentIndex.

Methods inherited from interface net.sf.mmm.util.io.api.ByteArray

createSubArray, getBytes, getBytesAvailable, getCurrentIndex, getMaximumIndex, getMinimumIndex

Methods inherited from interface net.sf.mmm.util.io.api.ByteIterator

hasNext, next, peek, skip

Method Detail

setCurrentIndex

void setCurrentIndex(int currentIndex)

This method sets the currentIndex. This can be useful e.g. if data from the buffer has been consumed externally.
ATTENTION:
Be very careful and only use this method if you know what you are doing!

Parameters:

currentIndex - is the currentIndex to set. It has to be in the range from minimumIndex to maximumIndex + 1. A value of maximumIndex + 1 indicates that the buffer is consumed.