org.mule.runtime.api.metadata.resolving

Interface MetadataResult<T>

Type Parameters:

T - return type of the Metadata resolving operation.

All Known Implementing Classes:

ImmutableMetadataResult

public interface MetadataResult<T>

Container for the Metadata fetch operations provided by MetadataKeysResolver, MetadataContentResolver and MetadataOutputResolver results. Allows to communicate errors without propagating exceptions to the Metadata fetching service

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static <T> MetadataResult<T>	failure(Exception e) Creates a failure result obtaining the information from the occurred exception when there is no payload for the result
static <T> MetadataResult<T>	failure(T payload, Exception e) Creates a failure result obtaining the information from the occurred exception
static <T> MetadataResult<T>	failure(T newPayload, MetadataResult<?> originalResult) Used for transforming the payload of a result with an enriched new payload, while preserving the original MetadataResult information
static <T> MetadataResult<T>	failure(T payload, String message, Exception e) Creates a failure result obtaining the information from the occurred exception with a customized failure message
static <T> MetadataResult<T>	failure(T payload, String message, FailureCode failure, String reason)
T	get()
Optional<MetadataFailure>	getFailure() If this#isSuccess is false, then a MetadataFailure instance is provided in order to describe the error that occurred during the invocation.
boolean	isSuccess()
static <T> MetadataResult<T>	success(T payload)

Method Detail

success

static <T> MetadataResult<T> success(T payload)

Parameters:

payload - object returned by the metadata operation

Returns:

a success MetadataResult instance

failure

static <T> MetadataResult<T> failure(Exception e)

Creates a failure result obtaining the information from the occurred exception when there is no payload for the result

Parameters:

e - exception that produced the failing MetadataResult

Returns:

a failure MetadataResult instance

failure

static <T> MetadataResult<T> failure(T newPayload,
                                     MetadataResult<?> originalResult)

Used for transforming the payload of a result with an enriched new payload, while preserving the original MetadataResult information

Parameters:

newPayload - object returned by the metadata operation

originalResult - original MetadataResult containing the information to propagate

Returns:

a failure MetadataResult instance

Throws:

IllegalArgumentException - if the original MetadataResult was not a failure

failure

static <T> MetadataResult<T> failure(T payload,
                                     Exception e)

Creates a failure result obtaining the information from the occurred exception

Parameters:

payload - object returned by the metadata operation

e - exception that produced the failing MetadataResult

Returns:

a failure MetadataResult instance

failure

static <T> MetadataResult<T> failure(T payload,
                                     String message,
                                     Exception e)

Creates a failure result obtaining the information from the occurred exception with a customized failure message

Parameters:

payload - object returned by the metadata operation

message - a custom message describing the context in which the failure occurred

e - exception that produced the failing MetadataResult

Returns:

a failure MetadataResult instance

failure

static <T> MetadataResult<T> failure(T payload,
                                     String message,
                                     FailureCode failure,
                                     String reason)

Parameters:

payload - object returned by the metadata operation

message - a custom message describing the context in which the failure occurred

failure - the FailureCode of the error that occurred

reason - the original message of the error that produced this failure

Returns:

a failure MetadataResult instance

get

T get()

Returns:

the object returned by the invoked Metadata operation

isSuccess

boolean isSuccess()

Returns:

true if the operation was completed without errors, false otherwise

getFailure

Optional<MetadataFailure> getFailure()

If this#isSuccess is false, then a MetadataFailure instance is provided in order to describe the error that occurred during the invocation.

Returns:

a List of MetadataFailures describing the errors that occurred during the invocation if at least one occurred.