io.swagger.api.annotations

Enum ApiParamExtended.ParamType

java.lang.Object

java.lang.Enum<ApiParamExtended.ParamType>

io.swagger.api.annotations.ApiParamExtended.ParamType

All Implemented Interfaces:

Serializable, Comparable<ApiParamExtended.ParamType>

Enclosing class:

ApiParamExtended

public static enum ApiParamExtended.ParamType
extends Enum<ApiParamExtended.ParamType>

Enum constants for parameter types

Enum Constant Summary

Enum Constants

Enum Constant and Description
BODY
FORM
HEADER
PATH
QUERY

Method Summary

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

QUERY

public static final ApiParamExtended.ParamType QUERY

BODY

public static final ApiParamExtended.ParamType BODY

HEADER

public static final ApiParamExtended.ParamType HEADER

FORM

public static final ApiParamExtended.ParamType FORM

Method Detail

values

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

Returns:

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

valueOf

public static ApiParamExtended.ParamType 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<ApiParamExtended.ParamType>