Package io.micronaut.http.annotation

Annotation Interface Error

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@HttpMethodMapping
@Inherited
public @interface Error

Annotation that can be applied to method to map it to an error route.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends Throwable>	exception
boolean	global	Whether the error handler should be registered as a global error handler or just locally to the declaring Controller.
HttpStatus	status
Class<? extends Throwable>	value

Element Details

value

@AliasFor(member="exception")
Class<? extends Throwable> value

Returns:

The exception to map to

Default:

java.lang.Throwable.class

exception

@AliasFor(member="value")
Class<? extends Throwable> exception

Returns:

The exception to map to

Default:

java.lang.Throwable.class

status

HttpStatus status

Returns:

The HttpStatus code to map

Default:

INTERNAL_SERVER_ERROR

global

boolean global

Whether the error handler should be registered as a global error handler or just locally to the declaring Controller.

Returns:

True if it should be global

Default:

false