Enum Class ResourcePathDeclaration.ComponentType

java.lang.Object

java.lang.Enum<ResourcePathDeclaration.ComponentType>

com.soklet.core.ResourcePathDeclaration.ComponentType

All Implemented Interfaces:

Serializable, Comparable<ResourcePathDeclaration.ComponentType>, Constable

Enclosing class:

ResourcePathDeclaration

public static enum ResourcePathDeclaration.ComponentType
extends Enum<ResourcePathDeclaration.ComponentType>

How to interpret a ResourcePathDeclaration.Component of a ResourcePathDeclaration - is it literal text or a placeholder?

For example, given the path declaration /languages/{languageId}:

• ComponentType at index 0 would be LITERAL
• ComponentType at index 1 would be PLACEHOLDER

Note: this type is not normally used by Soklet applications unless they choose to implement a custom ResourceMethodResolver.

Author:

Mark Allen

See Also:

• ResourcePathDeclaration

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
LITERAL	A literal component of a resource path declaration.
PLACEHOLDER	A placeholder component (that is, one whose value is provided at runtime) of a resource path declaration.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LITERAL

public static final ResourcePathDeclaration.ComponentType LITERAL

A literal component of a resource path declaration.

For example, given resource path declaration /users/{userId}, the users component would be of type LITERAL.

PLACEHOLDER

public static final ResourcePathDeclaration.ComponentType PLACEHOLDER

A placeholder component (that is, one whose value is provided at runtime) of a resource path declaration.

For example, given resource path declaration /users/{userId}, the userId component would be of type PLACEHOLDER.

Method Details

values

public static ResourcePathDeclaration.ComponentType[] 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 ResourcePathDeclaration.ComponentType 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