org.wildfly.swarm.microprofile.openapi.runtime.util

Class JandexUtil

java.lang.Object

org.wildfly.swarm.microprofile.openapi.runtime.util.JandexUtil

public class JandexUtil
extends Object

Some utility methods for working with Jandex objects.

Author:

eric.wittmann@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JandexUtil.JaxRsParameterInfo Holds relevant information about a jax-rs method parameter.
static class	JandexUtil.RefType Simple enum to indicate the type of a $ref being read/written.

Method Summary

Modifier and Type	Method and Description
static BigDecimal	bigDecimalValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName) Reads a Double property value from the given annotation instance.
static Boolean	booleanValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName) Reads a Boolean property value from the given annotation instance.
static Boolean	booleanValueWithDefault(org.jboss.jandex.AnnotationInstance annotation, String propertyName)
static <T extends Enum> T	enumValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName, Class<T> clazz) Reads a String property value from the given annotation instance.
static org.jboss.jandex.AnnotationInstance	getClassAnnotation(org.jboss.jandex.ClassInfo ct, org.jboss.jandex.DotName name) Gets a single class annotation from the given class.
static Collection<org.jboss.jandex.ClassInfo>	getJaxRsResourceClasses(org.jboss.jandex.IndexView index) Use the jandex index to find all jax-rs resource classes.
static JandexUtil.JaxRsParameterInfo	getMethodParameterJaxRsInfo(org.jboss.jandex.MethodInfo method, int idx) Returns jax-rs info about the parameter at the given index.
static org.jboss.jandex.Type	getMethodParameterType(org.jboss.jandex.MethodInfo method, short position) Returns the class type of the method parameter at the given position.
static List<org.jboss.jandex.AnnotationInstance>	getParameterAnnotations(org.jboss.jandex.MethodInfo method, short paramPosition) Returns all annotations configured for a single parameter of a method.
static List<org.jboss.jandex.AnnotationInstance>	getRepeatableAnnotation(org.jboss.jandex.ClassInfo clazz, org.jboss.jandex.DotName singleAnnotationName, org.jboss.jandex.DotName repeatableAnnotationName) Many OAI annotations can either be found singly or as a wrapped array.
static List<org.jboss.jandex.AnnotationInstance>	getRepeatableAnnotation(org.jboss.jandex.MethodInfo method, org.jboss.jandex.DotName singleAnnotationName, org.jboss.jandex.DotName repeatableAnnotationName) Many OAI annotations can either be found singly or as a wrapped array.
static org.jboss.jandex.Type	getRequestBodyParameterClassType(org.jboss.jandex.MethodInfo method) Go through the method parameters looking for one that is not annotated with a jax-rs annotation.
static Integer	intValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName) Reads a Integer property value from the given annotation instance.
static boolean	isEmpty(org.jboss.jandex.AnnotationInstance annotation) Returns true if the given annotation is void of any values (and thus is "empty").
static boolean	isRef(org.jboss.jandex.AnnotationInstance annotation) Returns true if the given annotation instance is a "ref".
static boolean	isSimpleArraySchema(org.jboss.jandex.AnnotationInstance annotation) Returns true if the given @Schema annotation is a simple array schema.
static boolean	isSimpleClassSchema(org.jboss.jandex.AnnotationInstance annotation) Returns true if the given @Schema annotation is a simple class schema.
static String	nameFromRef(org.jboss.jandex.AnnotationInstance annotation) Gets the name of an item from its ref.
static String	refValue(org.jboss.jandex.AnnotationInstance annotation, JandexUtil.RefType refType) Reads a string property named "ref" value from the given annotation and converts it to a value appropriate for setting on a model's "$ref" property.
static List<String>	stringListValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName) Reads a String array property value from the given annotation instance.
static String	stringValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName) Reads a String property value from the given annotation instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

refValue

public static String refValue(org.jboss.jandex.AnnotationInstance annotation,
                              JandexUtil.RefType refType)

Reads a string property named "ref" value from the given annotation and converts it to a value appropriate for setting on a model's "$ref" property.

Parameters:

annotation -

refType -

stringValue

public static String stringValue(org.jboss.jandex.AnnotationInstance annotation,
                                 String propertyName)

Reads a String property value from the given annotation instance. If no value is found this will return null.

Parameters:

annotation -

propertyName -

booleanValue

public static Boolean booleanValue(org.jboss.jandex.AnnotationInstance annotation,
                                   String propertyName)

Reads a Boolean property value from the given annotation instance. If no value is found this will return null.

Parameters:

annotation -

propertyName -

booleanValueWithDefault

public static Boolean booleanValueWithDefault(org.jboss.jandex.AnnotationInstance annotation,
                                              String propertyName)

bigDecimalValue

public static BigDecimal bigDecimalValue(org.jboss.jandex.AnnotationInstance annotation,
                                         String propertyName)

Reads a Double property value from the given annotation instance. If no value is found this will return null.

Parameters:

annotation -

propertyName -

intValue

public static Integer intValue(org.jboss.jandex.AnnotationInstance annotation,
                               String propertyName)

Reads a Integer property value from the given annotation instance. If no value is found this will return null.

Parameters:

annotation -

propertyName -

stringListValue

public static List<String> stringListValue(org.jboss.jandex.AnnotationInstance annotation,
                                           String propertyName)

Reads a String array property value from the given annotation instance. If no value is found this will return null.

Parameters:

annotation -

propertyName -

Returns:

enumValue

public static <T extends Enum> T enumValue(org.jboss.jandex.AnnotationInstance annotation,
                                           String propertyName,
                                           Class<T> clazz)

Reads a String property value from the given annotation instance. If no value is found this will return null.

Parameters:

annotation -

propertyName -

isRef

public static boolean isRef(org.jboss.jandex.AnnotationInstance annotation)

Returns true if the given annotation instance is a "ref". An annotation is a ref if it has a non-null value for the "ref" property.

Parameters:

annotation -

isEmpty

public static boolean isEmpty(org.jboss.jandex.AnnotationInstance annotation)

Returns true if the given annotation is void of any values (and thus is "empty"). An example of this would be if a jax-rs method were annotated with @Tag()

Parameters:

annotation -

getClassAnnotation

public static org.jboss.jandex.AnnotationInstance getClassAnnotation(org.jboss.jandex.ClassInfo ct,
                                                                     org.jboss.jandex.DotName name)

Gets a single class annotation from the given class. Returns null if no matching annotation is found.

Parameters:

ct -

name -

getJaxRsResourceClasses

public static Collection<org.jboss.jandex.ClassInfo> getJaxRsResourceClasses(org.jboss.jandex.IndexView index)

Use the jandex index to find all jax-rs resource classes. This is done by searching for all Class-level @Path annotations.

Parameters:

pathAnnotations -

index -

getParameterAnnotations

public static List<org.jboss.jandex.AnnotationInstance> getParameterAnnotations(org.jboss.jandex.MethodInfo method,
                                                                                short paramPosition)

Returns all annotations configured for a single parameter of a method.

Parameters:

method -

paramPosition -

nameFromRef

public static String nameFromRef(org.jboss.jandex.AnnotationInstance annotation)

Gets the name of an item from its ref. For example, the ref might be "#/components/parameters/departureDate" which would result in a name of "departureDate".

Parameters:

annotation -

getRepeatableAnnotation

public static List<org.jboss.jandex.AnnotationInstance> getRepeatableAnnotation(org.jboss.jandex.MethodInfo method,
                                                                                org.jboss.jandex.DotName singleAnnotationName,
                                                                                org.jboss.jandex.DotName repeatableAnnotationName)

Many OAI annotations can either be found singly or as a wrapped array. This method will look for both and return a list of all found. Both the single and wrapper annotation names must be provided.

Parameters:

method -

singleAnnotationName -

repeatableAnnotationName -

getRepeatableAnnotation

public static List<org.jboss.jandex.AnnotationInstance> getRepeatableAnnotation(org.jboss.jandex.ClassInfo clazz,
                                                                                org.jboss.jandex.DotName singleAnnotationName,
                                                                                org.jboss.jandex.DotName repeatableAnnotationName)

Many OAI annotations can either be found singly or as a wrapped array. This method will look for both and return a list of all found. Both the single and wrapper annotation names must be provided.

Parameters:

clazz -

singleAnnotationName -

repeatableAnnotationName -

getMethodParameterType

public static org.jboss.jandex.Type getMethodParameterType(org.jboss.jandex.MethodInfo method,
                                                           short position)

Returns the class type of the method parameter at the given position.

Parameters:

method -

position -

getRequestBodyParameterClassType

public static org.jboss.jandex.Type getRequestBodyParameterClassType(org.jboss.jandex.MethodInfo method)

Go through the method parameters looking for one that is not annotated with a jax-rs annotation. That will be the one that is the request body.

Parameters:

method -

getMethodParameterJaxRsInfo

public static JandexUtil.JaxRsParameterInfo getMethodParameterJaxRsInfo(org.jboss.jandex.MethodInfo method,
                                                                        int idx)

Returns jax-rs info about the parameter at the given index. If the index is invalid or does not refer to a jax-rs parameter (ie is not annoted with e.g. @PathParam) then this will return null. Otherwise it will return a JandexUtil.JaxRsParameterInfo object with the name and type of the param.

Parameters:

method -

idx -

isSimpleClassSchema

public static boolean isSimpleClassSchema(org.jboss.jandex.AnnotationInstance annotation)

Returns true if the given @Schema annotation is a simple class schema. This means that the annotation only has one field defined, and that field is "implementation".

Parameters:

annotation -

isSimpleArraySchema

public static boolean isSimpleArraySchema(org.jboss.jandex.AnnotationInstance annotation)

Returns true if the given @Schema annotation is a simple array schema. This is defined as a schema with only a "type" field and "implementation" field defined *and* the type must be array.

Parameters:

annotation -