io.smallrye.openapi.vertx

Enum VertxParameter

java.lang.Object

java.lang.Enum<VertxParameter>

io.smallrye.openapi.vertx.VertxParameter

All Implemented Interfaces:

Serializable, Comparable<VertxParameter>

public enum VertxParameter
extends Enum<VertxParameter>

Meta information for the Vert.x 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 and Description
HEADER_PARAM
PATH_PARAM
QUERY_PARAM

Method Summary

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

QUERY_PARAM

public static final VertxParameter QUERY_PARAM

HEADER_PARAM

public static final VertxParameter HEADER_PARAM

Method Detail

values

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

Returns:

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

valueOf

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