Package org.forgerock.http.routing

Enum Class RoutingMode

java.lang.Object

java.lang.Enum<RoutingMode>

org.forgerock.http.routing.RoutingMode

All Implemented Interfaces:

Serializable, Comparable<RoutingMode>, java.lang.constant.Constable

public enum RoutingMode
extends Enum<RoutingMode>

The algorithm which should be used when matching URI templates against request resource names.

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
EQUALS	The URI template must exactly match a request's resource name in order for the route to be selected.
STARTS_WITH	The URI template must match the beginning of a request's resource name in order for the route to be selected.

Method Summary

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

EQUALS

public static final RoutingMode EQUALS

The URI template must exactly match a request's resource name in order for the route to be selected.

STARTS_WITH

public static final RoutingMode STARTS_WITH

The URI template must match the beginning of a request's resource name in order for the route to be selected.

Method Details

values

public static RoutingMode[] 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 RoutingMode 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