org.mule.runtime.core.api.util

Class StreamingUtils

java.lang.Object

org.mule.runtime.core.api.util.StreamingUtils

public final class StreamingUtils
extends Object

Utilities for handling Cursor instances

Since:

4.0

Method Summary

Modifier and Type	Method and Description
static Object	streamingContent(Object value, CursorProviderFactory cursorProviderFactory, Event event) If the cursorProviderFactory accepts the given value, then the result of invoking CursorProviderFactory.of(Event, Object) is returned.
static Event	withCursoredEvent(Event event, CheckedFunction<Event,Event> f) Executes the given function f considering that the given event might have a CursorProvider as payload.

Methods inherited from class java.lang.Object

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

Method Detail

withCursoredEvent

public static Event withCursoredEvent(Event event,
                                      CheckedFunction<Event,Event> f)
                               throws org.mule.runtime.api.exception.MuleException

Executes the given function f considering that the given event might have a CursorProvider as payload. In that case, this method obtains a cursor from the provider and executes the function.

Closing the opened cursor, handling exceptions and return values are all taken care of by this utility method.

Parameters:

event - an Event

f - the function to execute

Returns:

the output Event

Throws:

org.mule.runtime.api.exception.MuleException

streamingContent

public static Object streamingContent(Object value,
                                      CursorProviderFactory cursorProviderFactory,
                                      Event event)

If the cursorProviderFactory accepts the given value, then the result of invoking CursorProviderFactory.of(Event, Object) is returned. Otherwise, the original value is.

Parameters:

value - a value which may be a repeatable streaming resource

cursorProviderFactory - a nullable CursorStreamProviderFactory

event - the event on which the value was generated

Returns:

the value or a CursorProvider