io.smallrye.openapi.runtime.util

Class JandexUtil

java.lang.Object

io.smallrye.openapi.runtime.util.JandexUtil

public class JandexUtil
extends Object

Some utility methods for working with Jandex objects.

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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) Reads a Boolean property from the given annotation instance.
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 <T extends Enum<?>> T	enumValue(String strVal, Class<T> clazz) Converts a string value to the given enum type.
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 org.jboss.jandex.AnnotationInstance	getMethodParameterAnnotation(org.jboss.jandex.MethodInfo method, int parameterIndex, org.jboss.jandex.DotName annotationName) Finds an annotation (if present) with the given name, on a particular parameter of a method.
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 org.jboss.jandex.Type	getMethodParameterType(org.jboss.jandex.MethodParameterInfo parameter) Returns the class type of the method parameter.
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.AnnotationTarget target, 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, List<AnnotationScannerExtension> extensions) Go through the method parameters looking for one that is not annotated with a jax-rs annotation.
static boolean	hasImplementation(org.jboss.jandex.AnnotationInstance annotation) Returns true if the given @Schema annotation has defined an "implementation" field.
static Map<org.jboss.jandex.ClassInfo,org.jboss.jandex.Type>	inheritanceChain(org.jboss.jandex.IndexView index, org.jboss.jandex.ClassInfo klazz, org.jboss.jandex.Type type) Builds an insertion-order map of a class's inheritance chain, starting with the klazz argument.
static Integer	intValue(org.jboss.jandex.AnnotationInstance annotation, String propertyName) Reads a Integer property value from the given annotation instance.
static boolean	isArraySchema(org.jboss.jandex.AnnotationInstance annotation) Returns true if the given @Schema annotation is an array schema.
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.
static <T> T	value(org.jboss.jandex.AnnotationInstance annotation, String name) Convenience method to retrieve the named parameter from an annotation.

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 - AnnotationInstance

refType - RefType

Returns:

String value

value

public static <T> T value(org.jboss.jandex.AnnotationInstance annotation,
                          String name)

Convenience method to retrieve the named parameter from an annotation. The value will be unwrapped from its containing AnnotationValue.

Type Parameters:

T - the type of the parameter being retrieved

Parameters:

annotation - the annotation from which to fetch the parameter

name - the name of the parameter

Returns:

an unwrapped annotation parameter value

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 - AnnotationInstance

propertyName - String

Returns:

String value

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 - AnnotationInstance

propertyName - String

Returns:

Boolean value

booleanValueWithDefault

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

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

Parameters:

annotation - AnnotationInstance

propertyName - String

Returns:

Boolean value

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 - AnnotationInstance

propertyName - String

Returns:

BigDecimal value

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 - AnnotationInstance

propertyName - String

Returns:

Integer value

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 - AnnotationInstance

propertyName - String

Returns:

List of Strings

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.

Type Parameters:

T - Type parameter

Parameters:

annotation - AnnotationInstance

propertyName - String

clazz - Class type of the Enum

Returns:

Value of property

enumValue

public static <T extends Enum<?>> T enumValue(String strVal,
                                              Class<T> clazz)

Converts a string value to the given enum type. If the string does not match one of the the enum's values name (case-insensitive) or toString value, null will be returned.

Type Parameters:

T - Type parameter

Parameters:

strVal - String

clazz - Class type of the Enum

Returns:

Value of property

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 - AnnotationInstance

Returns:

Whether it's a "ref"

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 - AnnotationInstance

Returns:

Whether it's empty

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 - ClassInfo

name - DotName

Returns:

AnnotationInstance

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:

index - IndexView

Returns:

Collection of ClassInfo's

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 - MethodInfo

paramPosition - parameter position

Returns:

List of AnnotationInstance's

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 - AnnotationInstance

Returns:

Name of item from ref

getRepeatableAnnotation

public static List<org.jboss.jandex.AnnotationInstance> getRepeatableAnnotation(org.jboss.jandex.AnnotationTarget target,
                                                                                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:

target - the annotated target (e.g. ClassInfo, MethodInfo)

singleAnnotationName - DotName

repeatableAnnotationName - DotName

Returns:

List of AnnotationInstance's

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 - MethodInfo

position - parameter position

Returns:

Type

getMethodParameterType

public static org.jboss.jandex.Type getMethodParameterType(org.jboss.jandex.MethodParameterInfo parameter)

Returns the class type of the method parameter.

Parameters:

parameter - the parameter

Returns:

Type

getRequestBodyParameterClassType

public static org.jboss.jandex.Type getRequestBodyParameterClassType(org.jboss.jandex.MethodInfo method,
                                                                     List<AnnotationScannerExtension> extensions)

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 - MethodInfo

extensions - available extensions

Returns:

Type

getMethodParameterAnnotation

public static org.jboss.jandex.AnnotationInstance getMethodParameterAnnotation(org.jboss.jandex.MethodInfo method,
                                                                               int parameterIndex,
                                                                               org.jboss.jandex.DotName annotationName)

Finds an annotation (if present) with the given name, on a particular parameter of a method. Returns null if not found.

Parameters:

method -

parameterIndex -

annotationName -

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 - AnnotationInstance

Returns:

Is it a simple class @Schema

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 - AnnotationInstance

Returns:

Is it a simple array @Schema

isArraySchema

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

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

Parameters:

annotation - AnnotationInstance

Returns:

Is it an array @Schema

hasImplementation

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

Returns true if the given @Schema annotation has defined an "implementation" field.

Parameters:

annotation - AnnotationInstance

Returns:

true if the annotation defines an implementation, otherwise false

inheritanceChain

public static Map<org.jboss.jandex.ClassInfo,org.jboss.jandex.Type> inheritanceChain(org.jboss.jandex.IndexView index,
                                                                                     org.jboss.jandex.ClassInfo klazz,
                                                                                     org.jboss.jandex.Type type)

Builds an insertion-order map of a class's inheritance chain, starting with the klazz argument.

Parameters:

index - index for superclass retrieval

klazz - the class to retrieve inheritance

type - type of the klazz

Returns:

map of a class's inheritance chain/ancestry