Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.error

Interface ErrorTypeDefinition<E extends Enum<E>>

Type Parameters:

E - Enum type

All Known Implementing Classes:

MuleErrors

@MinMuleVersion("4.1")
public interface ErrorTypeDefinition<E extends Enum<E>>

Identifies a Mule Error Type to be declared by extensions and must be implemented by an Enum.

Error Type Hierarchy

• To declare hierarchy between error types, the values of the Enum can override getParent() and declare which is the parent of the modified element.
• The parent can be any of the same Enum class or any of MuleErrors values, inherit from MuleErrors indicates that the child will inherit from a Mule exposed error.
• Cyclic references are not permitted.

Since:

1.0

See Also:

• MuleErrors

Method Summary

Modifier and Type	Method	Description
default Optional<ErrorTypeDefinition<? extends Enum<?>>>	getParent()
default String	getType()

Method Details

getType

default String getType()

Returns:

The type of the current error type definition

getParent

default Optional<ErrorTypeDefinition<? extends Enum<?>>> getParent()

Returns:

The Optional parent of the current error type definition