com.vaadin.flow.router

Enum RouteParameterFormatOption

java.lang.Object

java.lang.Enum<RouteParameterFormatOption>

com.vaadin.flow.router.RouteParameterFormatOption

All Implemented Interfaces:

Serializable, Comparable<RouteParameterFormatOption>

public enum RouteParameterFormatOption
extends Enum<RouteParameterFormatOption>

Define the route parameters format flags. This is used when retrieving route information, so that the result may contain the parameters definition represented according with the specified flags.

For internal use only. May be renamed or removed in a future release.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MODIFIER Parameter modifier, i.e.
NAME The name of the parameter.
REGEX Original template regex.
REGEX_NAME The named template of the parameter, i.e.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NAME

public static final RouteParameterFormatOption NAME

The name of the parameter.

REGEX

public static final RouteParameterFormatOption REGEX

Original template regex.

MODIFIER

public static final RouteParameterFormatOption MODIFIER

Parameter modifier, i.e. optional or wildcard.

REGEX_NAME

public static final RouteParameterFormatOption REGEX_NAME

The named template of the parameter, i.e. int, long, bool, string.

Method Detail

values

public static RouteParameterFormatOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RouteParameterFormatOption c : RouteParameterFormatOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static RouteParameterFormatOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null