Package io.quarkus.vertx.web

Enum Class Route.HandlerType

java.lang.Object

java.lang.Enum<Route.HandlerType>

io.quarkus.vertx.web.Route.HandlerType

All Implemented Interfaces:

Serializable, Comparable<Route.HandlerType>, Constable

Enclosing class:

Route

public static enum Route.HandlerType
extends Enum<Route.HandlerType>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKING	A blocking request handler.
FAILURE	A failure handler can declare a single method parameter whose type extends Throwable.
NORMAL	A non-blocking request handler.

Method Summary

Modifier and Type	Method	Description
static Route.HandlerType	from(String value)
static Route.HandlerType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Route.HandlerType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORMAL

public static final Route.HandlerType NORMAL

A non-blocking request handler.

See Also:

• Route.handler(Handler)

BLOCKING

public static final Route.HandlerType BLOCKING

A blocking request handler.

See Also:

• Route.blockingHandler(Handler)

FAILURE

public static final Route.HandlerType FAILURE

A failure handler can declare a single method parameter whose type extends Throwable. The type of the parameter is used to match the result of RoutingContext.failure().

 
  class Routes {
     @Route(type = HandlerType.FAILURE)
     void unsupported(UnsupportedOperationException e, HttpServerResponse response) {
        response.setStatusCode(501).end(e.getMessage());
     }
  }
  
 

If a failure handler declares neither a path nor a regex then the route matches all requests.

See Also:

• Route.failureHandler(Handler)

Method Details

values

public static Route.HandlerType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Route.HandlerType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

from

public static Route.HandlerType from(String value)