Package springfox.documentation.service

Enum ParameterType

java.lang.Object

java.lang.Enum<ParameterType>

springfox.documentation.service.ParameterType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParameterType>

public enum ParameterType
extends java.lang.Enum<ParameterType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY
COOKIE
FORM
FORMDATA
HEADER
PATH
QUERY

Method Summary

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

QUERY

public static final ParameterType QUERY

HEADER

public static final ParameterType HEADER

PATH

public static final ParameterType PATH

COOKIE

public static final ParameterType COOKIE

FORM

public static final ParameterType FORM

FORMDATA

public static final ParameterType FORMDATA

BODY

public static final ParameterType BODY

Method Detail

values

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

Returns:

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

valueOf

public static ParameterType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getIn

public java.lang.String getIn()

from

public static ParameterType from(java.lang.String value)