Package io.smallrye.openapi.spring

Enum SpringParameter

java.lang.Object

java.lang.Enum<SpringParameter>

io.smallrye.openapi.spring.SpringParameter

All Implemented Interfaces:

Serializable, Comparable<SpringParameter>

public enum SpringParameter
extends Enum<SpringParameter>

Meta information for the Spring Parameter annotations relating them to the In and Style attributes of Parameters.

Author:

Phillip Kruger (phillip.kruger@redhat.com)

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE_PARAM
HEADER_PARAM
MATRIX_PARAM
PATH_PARAM
QUERY_PARAM

Method Summary

Modifier and Type	Method	Description
static boolean	isParameter(org.jboss.jandex.DotName annotationName)
static SpringParameter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpringParameter[]	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

PATH_PARAM

public static final SpringParameter PATH_PARAM

MATRIX_PARAM

public static final SpringParameter MATRIX_PARAM

QUERY_PARAM

public static final SpringParameter QUERY_PARAM

HEADER_PARAM

public static final SpringParameter HEADER_PARAM

COOKIE_PARAM

public static final SpringParameter COOKIE_PARAM

Method Detail

values

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

Returns:

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

valueOf

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

isParameter

public static boolean isParameter(org.jboss.jandex.DotName annotationName)