org.mule.runtime.api.sampledata

Interface SampleDataResult

All Known Implementing Classes:

ImmutableSampleDataResult

public interface SampleDataResult

Represents the result of a sample data connector request

Since:

1.4

Method Summary

Modifier and Type	Method and Description
Optional<SampleDataFailure>	getFailure()
Optional<Message>	getSampleData()
default boolean	isSuccess()
static SampleDataResult	resultFrom(Message message) Creates a new SampleDataResult with a successful result containing the resolved sample data.
static SampleDataResult	resultFrom(SampleDataFailure failure) Creates a new SampleDataResult with a failure result containing the associated failure

Method Detail

resultFrom

static SampleDataResult resultFrom(Message message)

Creates a new SampleDataResult with a successful result containing the resolved sample data.

Parameters:

message - The resolved with the sample data

Returns:

a SampleDataResult with the resolved sample data.

resultFrom

static SampleDataResult resultFrom(SampleDataFailure failure)

Creates a new SampleDataResult with a failure result containing the associated failure

Parameters:

failure - The generated failure occurred trying to resolve the sample data

Returns:

a SampleDataResult with the SampleDataFailure

getSampleData

Optional<Message> getSampleData()

Returns:

An Optional Message with the sample data. In an error case returns empty.

getFailure

Optional<SampleDataFailure> getFailure()

Returns:

An Optional failure with the error that occurred trying to resolve the sample data

isSuccess

default boolean isSuccess()

Returns:

A boolean indicating if the resolution finished correctly or not.