Package net.officefloor.web.build

Enum Class HttpValueLocation

java.lang.Object

java.lang.Enum<HttpValueLocation>

net.officefloor.web.build.HttpValueLocation

All Implemented Interfaces:

Serializable, Comparable<HttpValueLocation>, Constable

public enum HttpValueLocation
extends Enum<HttpValueLocation>

Location of the HttpParameter.

Author:

Daniel Sagenschneider

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
COOKIE	Value from a cookie.
ENTITY	Value from the request entity body.
HEADER	Value from a request header.
PATH	Value from the URL path.
QUERY	Value from the query string.

Method Summary

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

PATH

public static final HttpValueLocation PATH

Value from the URL path.

QUERY

public static final HttpValueLocation QUERY

Value from the query string.

HEADER

public static final HttpValueLocation HEADER

Value from a request header.

COOKIE

public static final HttpValueLocation COOKIE

Value from a cookie.

ENTITY

public static final HttpValueLocation ENTITY

Value from the request entity body.

Method Details

values

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