org.mule.runtime.extension.api.runtime.operation

Interface OperationResult<Output,A extends org.mule.runtime.api.message.Attributes>

Type Parameters:

Output - the generic type of the output value

A - the generic type of the message attributes

public interface OperationResult<Output,A extends org.mule.runtime.api.message.Attributes>

Represents the result of an operation execution. Extensions can use this class for cases in which the operation not only needs to return a value to be set on the message payload but also wants to specify message attributes and/or MediaType.

The getOutput() value is always taken at face value, meaning that if it's null, then the value that the operation returns to the runtime will in fact be . However, if the getAttributes() or getMediaType() are Optional.empty(), then the runtime will interpret that as the operation not interested in setting those values, keeping the input message's attributes and/or media type untouched.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OperationResult.Builder<Output,A extends org.mule.runtime.api.message.Attributes> Builds instances of OperationResult

Method Summary

Modifier and Type	Method and Description
static <Output,A extends org.mule.runtime.api.message.Attributes> OperationResult.Builder<Output,A>	builder() Creates a new OperationResult.Builder
static <Output,A extends org.mule.runtime.api.message.Attributes> OperationResult.Builder<Output,A>	builder(org.mule.runtime.api.message.Message muleMessage) Creates a new OperationResult.Builder initialises with a state that matched the one of the given muleMessage
Optional<A>	getAttributes() The new value that the operation wants to set on Message.getAttributes().
Optional<org.mule.runtime.api.metadata.MediaType>	getMediaType() The new MediaType that the operation wants to set on Message#getDataType().
Output	getOutput()

Method Detail

builder

static <Output,A extends org.mule.runtime.api.message.Attributes> OperationResult.Builder<Output,A> builder()

Creates a new OperationResult.Builder

Type Parameters:

Output - the generic type of the output value

A - the generic type of the message attributes

Returns:

a new OperationResult.Builder

builder

static <Output,A extends org.mule.runtime.api.message.Attributes> OperationResult.Builder<Output,A> builder(org.mule.runtime.api.message.Message muleMessage)

Creates a new OperationResult.Builder initialises with a state that matched the one of the given muleMessage

Type Parameters:

Output - the generic type of the output value

A - the generic type of the message attributes

Parameters:

muleMessage - a reference Message

Returns:

a new OperationResult.Builder

getOutput

Output getOutput()

Returns:

The operation's output

getAttributes

Optional<A> getAttributes()

The new value that the operation wants to set on Message.getAttributes().

The operation might not be interested in changing that value, in which case this method would return Optional.empty()

Returns:

an Optional Attributes value

getMediaType

Optional<org.mule.runtime.api.metadata.MediaType> getMediaType()

The new MediaType that the operation wants to set on Message#getDataType().

The operation might not be interested in changing that value, in which case this method would return Optional.empty()

Returns:

an Optional MediaType value