Package io.quarkus.vertx.http.deployment.spi

Enum Class RouteBuildItem.RouteType

java.lang.Object

java.lang.Enum<RouteBuildItem.RouteType>

io.quarkus.vertx.http.deployment.spi.RouteBuildItem.RouteType

All Implemented Interfaces:

Serializable, Comparable<RouteBuildItem.RouteType>, Constable

Enclosing class:

RouteBuildItem

public static enum RouteBuildItem.RouteType
extends Enum<RouteBuildItem.RouteType>

Type of routes.

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
ABSOLUTE_ROUTE	Absolute routes are part of the application business logic, and are mounted on the root router (exposed on /).
APPLICATION_ROUTE	Application routes are part of the application business logic.
FRAMEWORK_ROUTE	Framework routes are provided by the Quarkus framework (or extensions).

Method Summary

Modifier and Type	Method	Description
static RouteBuildItem.RouteType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RouteBuildItem.RouteType[]	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

FRAMEWORK_ROUTE

public static final RouteBuildItem.RouteType FRAMEWORK_ROUTE

Framework routes are provided by the Quarkus framework (or extensions). They are not related to the application business logic, but provide a non-functional feature (health, metrics...).

Framework route can be mounted on the application router (under the non application route path) or on the management router when enabled.

APPLICATION_ROUTE

public static final RouteBuildItem.RouteType APPLICATION_ROUTE

Application routes are part of the application business logic. They are mounted on the application router (so the application prefix is applied).

ABSOLUTE_ROUTE

public static final RouteBuildItem.RouteType ABSOLUTE_ROUTE

Absolute routes are part of the application business logic, and are mounted on the root router (exposed on /).

Method Details

values

public static RouteBuildItem.RouteType[] 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 RouteBuildItem.RouteType 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