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

Class AbstractCursorIteratorProviderFactory

java.lang.Object

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

All Implemented Interfaces:

CursorProviderFactory<Iterator>, CursorIteratorProviderFactory

Direct Known Subclasses:

InMemoryCursorIteratorProviderFactory, NullCursorIteratorProviderFactory

public abstract class AbstractCursorIteratorProviderFactory
extends Object
implements CursorIteratorProviderFactory

Base implementation of CursorIteratorProviderFactory which contains all the base behaviour and template methods.

It interacts with the CursorManager in order to track all allocated resources and make sure they're properly disposed of once they're no longer necessary.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
AbstractCursorIteratorProviderFactory(StreamingManager streamingManager)

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Object value)
Object	of(Event event, Iterator iterator) Optionally creates a new CursorProvider to buffer the given value.
protected abstract Object	resolve(Iterator iterator, Event event) Implementations should use this method to actually create the output value

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCursorIteratorProviderFactory

public AbstractCursorIteratorProviderFactory(StreamingManager streamingManager)

Method Detail

of

public final Object of(Event event,
                       Iterator iterator)

Optionally creates a new CursorProvider to buffer the given value.

Implementations might resolve that the given stream is/should not be buffered and thus it will return the same given stream. In that case, the stream will be unaltered.

Specified by:

of in interface CursorProviderFactory<Iterator>

Parameters:

event - the event on which buffering is talking place

iterator - the stream to be cursored

Returns:

A CursorProvider or the same given inputStream

resolve

protected abstract Object resolve(Iterator iterator,
                                  Event event)

Implementations should use this method to actually create the output value

Parameters:

iterator - the streaming iterator

event - the event on which streaming is happening

accepts

public boolean accepts(Object value)

Specified by:

accepts in interface CursorProviderFactory<Iterator>

Parameters:

value - a stream

Returns:

true if the value is a StreamingIterator