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

Class AbstractObjectStreamBuffer<T>

java.lang.Object

org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

org.mule.runtime.core.internal.streaming.object.AbstractObjectStreamBuffer<T>

Type Parameters:

T - the generic type of the items in the stream

All Implemented Interfaces:

org.mule.runtime.api.streaming.HasSize, ObjectStreamBuffer<T>

Direct Known Subclasses:

InMemoryObjectStreamBuffer

public abstract class AbstractObjectStreamBuffer<T>
extends AbstractStreamingBuffer
implements ObjectStreamBuffer<T>

Base class for implementations of ObjectStreamBuffer

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from class org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

AbstractStreamingBuffer.LockReleaser

Field Summary

Fields inherited from class org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

closed, readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
AbstractObjectStreamBuffer(StreamingIterator<T> stream)

Method Summary

Modifier and Type	Method and Description
void	close() Releases all the resources held by this buffer.
protected abstract void	doClose()
Optional<Bucket<T>>	getBucketFor(Position position) Returns the Bucket for the given position
protected Bucket<T>	getCurrentBucket()
protected abstract Optional<Bucket<T>>	getPresentBucket(Position position)
int	getSize()
boolean	hasNext(long i)
void	initialise() Initialises this buffer.
protected abstract void	initialize(Optional<Position> maxPosition, Bucket<T> initialBucket)
protected abstract Bucket<T>	onBucketOverflow(Bucket<T> overflownBucket)
protected void	setCurrentBucket(Bucket<T> bucket)
protected void	setMaxPosition(Position maxPosition)
protected abstract void	validateMaxBufferSizeNotExceeded(int instancesCount)

Methods inherited from class org.mule.runtime.core.internal.streaming.AbstractStreamingBuffer

checkNotClosed, closeSafely, withReadLock, withWriteLock

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.core.internal.streaming.object.ObjectStreamBuffer

toPosition

Constructor Detail

AbstractObjectStreamBuffer

public AbstractObjectStreamBuffer(StreamingIterator<T> stream)

Method Detail

initialise

public final void initialise()

Description copied from interface: ObjectStreamBuffer

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

Specified by:

initialise in interface ObjectStreamBuffer<T>

initialize

protected abstract void initialize(Optional<Position> maxPosition,
                                   Bucket<T> initialBucket)

getBucketFor

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

Description copied from interface: ObjectStreamBuffer

Returns the Bucket for the given position

Specified by:

getBucketFor in interface ObjectStreamBuffer<T>

Parameters:

position - the bucket's position

Returns:

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

getSize

public int getSize()

Specified by:

getSize in interface org.mule.runtime.api.streaming.HasSize

hasNext

public final boolean hasNext(long i)

Specified by:

hasNext in interface ObjectStreamBuffer<T>

Parameters:

i - a position in the stream

Returns:

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

validateMaxBufferSizeNotExceeded

protected abstract void validateMaxBufferSizeNotExceeded(int instancesCount)

onBucketOverflow

protected abstract Bucket<T> onBucketOverflow(Bucket<T> overflownBucket)

close

public final void close()

Description copied from interface: ObjectStreamBuffer

Releases all the resources held by this buffer.

Specified by:

close in interface ObjectStreamBuffer<T>

doClose

protected abstract void doClose()

getPresentBucket

protected abstract Optional<Bucket<T>> getPresentBucket(Position position)

getCurrentBucket

protected Bucket<T> getCurrentBucket()

setCurrentBucket

protected void setCurrentBucket(Bucket<T> bucket)

setMaxPosition

protected void setMaxPosition(Position maxPosition)