org.mule.runtime.core.message

Class ErrorBuilder

java.lang.Object

org.mule.runtime.core.message.ErrorBuilder

public final class ErrorBuilder
extends Object

Builder for Error instances.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.message.Error	build() Creates the instance of Error with the supplied configuration.
static ErrorBuilder	builder()
static ErrorBuilder	builder(Throwable e)
ErrorBuilder	description(String description) Sets the description of the error.
ErrorBuilder	detailedDescription(String detailedDescription) Sets a detailed description of the error.
ErrorBuilder	errorMessage(org.mule.runtime.api.message.Message errorMessage) Sets the error message for the error.
ErrorBuilder	errorType(org.mule.runtime.api.message.ErrorType errorType) Sets the error type of this error.
ErrorBuilder	exception(Throwable exception) Sets the exception that causes the error.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ErrorBuilder builder()

builder

public static ErrorBuilder builder(Throwable e)

exception

public ErrorBuilder exception(Throwable exception)

Sets the exception that causes the error. @see Error.getCause()

Parameters:

exception - the exception that caused the error

Returns:

this builder

description

public ErrorBuilder description(String description)

Sets the description of the error. The description if meant to be a short text that describes the error and should not contain any java specific detail.

Parameters:

description - the description

Returns:

this builder

detailedDescription

public ErrorBuilder detailedDescription(String detailedDescription)

Sets a detailed description of the error. This description should provide as much information as possible for recognize what the problem can be and, if possible, provide information on how to fix it.

Parameters:

detailedDescription - the detailed description

Returns:

this builder

errorType

public ErrorBuilder errorType(org.mule.runtime.api.message.ErrorType errorType)

Sets the error type of this error. @see ErrorType.

Parameters:

errorType - the error type

Returns:

this builder

errorMessage

public ErrorBuilder errorMessage(org.mule.runtime.api.message.Message errorMessage)

Sets the error message for the error. An error message is a Message with information related to the error. For instance, a response from an http:request operation may return a 4XX status code. The content for the whole response can be set in the error message so the information is available during the error handler execution.

Parameters:

errorMessage -

Returns:

build

public org.mule.runtime.api.message.Error build()

Creates the instance of Error with the supplied configuration. All builder parameters are required except for the error message which may be null.

Returns:

the error instance