org.mule.runtime.core.internal.streaming.bytes

Interface InputStreamBuffer

All Known Implementing Classes:

AbstractInputStreamBuffer, InMemoryStreamBuffer

public interface InputStreamBuffer

A buffer which provides concurrent random access to the entirety of a dataset.

It works with the concept of a zero-base position. Each position represents one byte in the stream. Although this buffer tracks the position of each byte, it doesn't have a position itself. That means that pulling data from this buffer does not make any current position to be moved.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	close() Releases all the resources held by this buffer
ByteBuffer	get(long position, int length) Returns a ByteBuffer with up to length amount of bytes starting from the given position.

Method Detail

get

ByteBuffer get(long position,
               int length)

Returns a ByteBuffer with up to length amount of bytes starting from the given position. The returned buffer may contain less information than requested. If no information is available at all, then it returns null

Parameters:

position - the stream position from which the data should be read

length - how many bytes to read

Returns:

A ByteBuffer with up to length bytes of information or null if no information available at all

close

void close()

Releases all the resources held by this buffer