org.apache.juneau.rest

Enum RestParamType

java.lang.Object

java.lang.Enum<RestParamType>

org.apache.juneau.rest.RestParamType

All Implemented Interfaces:

Serializable, Comparable<RestParamType>

public enum RestParamType
extends Enum<RestParamType>

Represents the possible parameter types as defined by the Swagger 2.0 specification.

See Also:

• Overview > juneau-rest-server > OPTIONS pages

Enum Constant Summary

Enum Constants

Enum Constant and Description
BODY Request body
FORMDATA Form data entry
HEADER Header value
OTHER Not a standard Swagger-defined field
PATH Path variable
QUERY Query parameter

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PATH

public static final RestParamType PATH

Path variable

HEADER

public static final RestParamType HEADER

Header value

FORMDATA

public static final RestParamType FORMDATA

Form data entry

QUERY

public static final RestParamType QUERY

Query parameter

BODY

public static final RestParamType BODY

Request body

OTHER

public static final RestParamType OTHER

Not a standard Swagger-defined field

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<RestParamType>