org.mule.runtime.core.internal.streaming.object

Interface ObjectStreamBuffer<T>

All Superinterfaces:

org.mule.runtime.api.streaming.HasSize

All Known Implementing Classes:

AbstractObjectStreamBuffer, InMemoryObjectStreamBuffer

public interface ObjectStreamBuffer<T>
extends org.mule.runtime.api.streaming.HasSize

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

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. It uses the concept of Bucket to store and return items. Because this buffer needs to provide random access, array based lists are optimal for obtaining the item in a particular position. However, expanding the capacity of an array based list is very expensive.

This buffer works by partitioning the items into buckets of array based lists, so that we never need to expand a list, we simply add a new bucket.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	close() Releases all the resources held by this buffer.
Optional<Bucket<T>>	getBucketFor(Position position) Returns the Bucket for the given position
boolean	hasNext(long position)
void	initialise() Initialises this buffer.
Position	toPosition(long position) Transforms the given index based position to a Position object

Methods inherited from interface org.mule.runtime.api.streaming.HasSize

getSize

Method Detail

getBucketFor

Optional<Bucket<T>> getBucketFor(Position position)

Returns the Bucket for the given position

Parameters:

position - the bucket's position

Returns:

an optional the bucket. Will be empty if no bucket for that position,

toPosition

Position toPosition(long position)

Transforms the given index based position to a Position object

Parameters:

position - a zero based index position

Returns:

a Position

hasNext

boolean hasNext(long position)

Parameters:

position - a position in the stream

Returns:

Whether there's an item at the given position or not

initialise

void initialise()

Initialises this buffer. Should be invoked on every instance in order to make it functional

close

void close()

Releases all the resources held by this buffer.