io.vertx.ext.web.api.validation

Enum ParameterLocation

java.lang.Object

java.lang.Enum<ParameterLocation>

io.vertx.ext.web.api.validation.ParameterLocation

All Implemented Interfaces:

Serializable, Comparable<ParameterLocation>

public enum ParameterLocation
extends Enum<ParameterLocation>

ParameterLocation describe the location of parameter inside HTTP Request

Author:

Francesco Guardiani @slinkydeveloper

Enum Constant Summary

Enum Constants

Enum Constant and Description
BODY
BODY_FORM
BODY_JSON
BODY_XML
COOKIE
FILE
HEADER
PATH
QUERY

Field Summary

Fields

Modifier and Type	Field and Description
String	s

Method Summary

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

HEADER

public static final ParameterLocation HEADER

QUERY

public static final ParameterLocation QUERY

PATH

public static final ParameterLocation PATH

FILE

public static final ParameterLocation FILE

BODY_FORM

public static final ParameterLocation BODY_FORM

BODY

public static final ParameterLocation BODY

BODY_JSON

public static final ParameterLocation BODY_JSON

BODY_XML

public static final ParameterLocation BODY_XML

COOKIE

public static final ParameterLocation COOKIE

Field Detail

s

public String s

Method Detail

values

public static ParameterLocation[] 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 (ParameterLocation c : ParameterLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static ParameterLocation 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