io.smallrye.openapi.jaxrs

Enum JaxRsParameter

java.lang.Object

java.lang.Enum<JaxRsParameter>

io.smallrye.openapi.jaxrs.JaxRsParameter

All Implemented Interfaces:

Serializable, Comparable<JaxRsParameter>

public enum JaxRsParameter
extends Enum<JaxRsParameter>

Meta information for the JAX-RS *Param annotations relating them to the In and Style attributes of Parameters.

Author:

Michael Edgar <michael@xlate.io>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEAN_PARAM
COOKIE_PARAM
FORM_PARAM
HEADER_PARAM
MATRIX_PARAM
PATH_PARAM
QUERY_PARAM
RESTEASY_COOKIE_PARAM
RESTEASY_FORM_PARAM
RESTEASY_HEADER_PARAM
RESTEASY_MATRIX_PARAM
RESTEASY_MULITIPART_FORM
RESTEASY_PATH_PARAM
RESTEASY_QUERY_PARAM

Method Summary

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

MATRIX_PARAM

public static final JaxRsParameter MATRIX_PARAM

QUERY_PARAM

public static final JaxRsParameter QUERY_PARAM

FORM_PARAM

public static final JaxRsParameter FORM_PARAM

HEADER_PARAM

public static final JaxRsParameter HEADER_PARAM

COOKIE_PARAM

public static final JaxRsParameter COOKIE_PARAM

BEAN_PARAM

public static final JaxRsParameter BEAN_PARAM

RESTEASY_PATH_PARAM

public static final JaxRsParameter RESTEASY_PATH_PARAM

RESTEASY_MATRIX_PARAM

public static final JaxRsParameter RESTEASY_MATRIX_PARAM

RESTEASY_QUERY_PARAM

public static final JaxRsParameter RESTEASY_QUERY_PARAM

RESTEASY_FORM_PARAM

public static final JaxRsParameter RESTEASY_FORM_PARAM

RESTEASY_HEADER_PARAM

public static final JaxRsParameter RESTEASY_HEADER_PARAM

RESTEASY_COOKIE_PARAM

public static final JaxRsParameter RESTEASY_COOKIE_PARAM

RESTEASY_MULITIPART_FORM

public static final JaxRsParameter RESTEASY_MULITIPART_FORM

Method Detail

values

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

Returns:

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

valueOf

public static JaxRsParameter 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)