io.smallrye.openapi.runtime.util

Class TypeUtil

java.lang.Object

io.smallrye.openapi.runtime.util.TypeUtil

public class TypeUtil
extends Object

Author:

Marc Savy <marc@rhymewithgravy.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeUtil.DataFormat
static class	TypeUtil.TypeWithFormat

Method Summary

Modifier and Type	Method and Description
static TypeUtil.TypeWithFormat	arrayFormat()
static boolean	equalTypes(org.jboss.jandex.Type type1, org.jboss.jandex.Type type2)
static boolean	equalWrappedTypes(org.jboss.jandex.Type primitiveCandidate, org.jboss.jandex.Type wrappedCandidate)
static org.jboss.jandex.AnnotationInstance	getAnnotation(org.jboss.jandex.AnnotationTarget annotationTarget, org.jboss.jandex.DotName annotationName)
static org.jboss.jandex.AnnotationInstance	getAnnotation(org.jboss.jandex.ClassInfo field, org.jboss.jandex.DotName annotationName)
static org.jboss.jandex.AnnotationInstance	getAnnotation(org.jboss.jandex.FieldInfo field, org.jboss.jandex.DotName annotationName)
static org.jboss.jandex.AnnotationInstance	getAnnotation(org.jboss.jandex.Type type, org.jboss.jandex.DotName annotationName)
static Collection<org.jboss.jandex.AnnotationInstance>	getAnnotations(org.jboss.jandex.AnnotationTarget type)
static <T> T	getAnnotationValue(org.jboss.jandex.AnnotationTarget target, org.jboss.jandex.DotName annotationName) Convenience method to retrieve the "value" parameter from an annotation bound to the target.
static <T> T	getAnnotationValue(org.jboss.jandex.AnnotationTarget target, org.jboss.jandex.DotName annotationName, String propertyName) Convenience method to retrieve the named parameter from an annotation bound to the target.
static <T> T	getAnnotationValue(org.jboss.jandex.AnnotationTarget target, org.jboss.jandex.DotName annotationName, String propertyName, T defaultValue) Convenience method to retrieve the named parameter from an annotation bound to the target.
static org.jboss.jandex.Type	getBound(org.jboss.jandex.WildcardType wct)
static Class<?>	getClass(String name)
static Class<?>	getClass(org.jboss.jandex.Type type)
static org.jboss.jandex.ClassInfo	getDeclaringClass(org.jboss.jandex.AnnotationTarget type)
static org.jboss.jandex.DotName	getName(org.jboss.jandex.Type type)
static org.jboss.jandex.AnnotationInstance	getSchemaAnnotation(org.jboss.jandex.AnnotationTarget annotationTarget)
static org.jboss.jandex.AnnotationInstance	getSchemaAnnotation(org.jboss.jandex.ClassInfo field)
static org.jboss.jandex.AnnotationInstance	getSchemaAnnotation(org.jboss.jandex.FieldInfo field)
static org.jboss.jandex.AnnotationInstance	getSchemaAnnotation(org.jboss.jandex.Type type)
static TypeUtil.TypeWithFormat	getTypeFormat(org.jboss.jandex.PrimitiveType primitiveType)
static TypeUtil.TypeWithFormat	getTypeFormat(org.jboss.jandex.Type classType)
static boolean	hasAnnotation(org.jboss.jandex.AnnotationTarget target, org.jboss.jandex.DotName annotationName)
static boolean	isA(org.jboss.jandex.IndexView index, org.jboss.jandex.Type testSubject, org.jboss.jandex.Type testObject) Test whether testSubject is an instanceof type test.
static boolean	isPrimitiveWrapper(org.jboss.jandex.PrimitiveType primitive, org.jboss.jandex.Type wrapped)
static TypeUtil.TypeWithFormat	objectFormat()
static org.jboss.jandex.Type	resolveWildcard(org.jboss.jandex.Type type)
static org.jboss.jandex.Type	resolveWildcard(org.jboss.jandex.WildcardType wildcardType)

Methods inherited from class java.lang.Object

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

Method Detail

getTypeFormat

public static TypeUtil.TypeWithFormat getTypeFormat(org.jboss.jandex.PrimitiveType primitiveType)

getTypeFormat

public static TypeUtil.TypeWithFormat getTypeFormat(org.jboss.jandex.Type classType)

arrayFormat

public static TypeUtil.TypeWithFormat arrayFormat()

objectFormat

public static TypeUtil.TypeWithFormat objectFormat()

getClass

public static Class<?> getClass(org.jboss.jandex.Type type)
                         throws ClassNotFoundException

Throws:

ClassNotFoundException

getClass

public static Class<?> getClass(String name)
                         throws ClassNotFoundException

Throws:

ClassNotFoundException

isA

public static boolean isA(org.jboss.jandex.IndexView index,
                          org.jboss.jandex.Type testSubject,
                          org.jboss.jandex.Type testObject)

Test whether testSubject is an instanceof type test.

For example, test whether List is a Collection.

Attempts to work with both Jandex and using standard class.

Parameters:

index - Jandex index

testSubject - type to test

testObject - type to test against

Returns:

true if is of type

getName

public static org.jboss.jandex.DotName getName(org.jboss.jandex.Type type)

getBound

public static org.jboss.jandex.Type getBound(org.jboss.jandex.WildcardType wct)

resolveWildcard

public static org.jboss.jandex.Type resolveWildcard(org.jboss.jandex.WildcardType wildcardType)

resolveWildcard

public static org.jboss.jandex.Type resolveWildcard(org.jboss.jandex.Type type)

equalTypes

public static boolean equalTypes(org.jboss.jandex.Type type1,
                                 org.jboss.jandex.Type type2)

equalWrappedTypes

public static boolean equalWrappedTypes(org.jboss.jandex.Type primitiveCandidate,
                                        org.jboss.jandex.Type wrappedCandidate)

isPrimitiveWrapper

public static boolean isPrimitiveWrapper(org.jboss.jandex.PrimitiveType primitive,
                                         org.jboss.jandex.Type wrapped)

getSchemaAnnotation

public static org.jboss.jandex.AnnotationInstance getSchemaAnnotation(org.jboss.jandex.AnnotationTarget annotationTarget)

getSchemaAnnotation

public static org.jboss.jandex.AnnotationInstance getSchemaAnnotation(org.jboss.jandex.ClassInfo field)

getSchemaAnnotation

public static org.jboss.jandex.AnnotationInstance getSchemaAnnotation(org.jboss.jandex.FieldInfo field)

getSchemaAnnotation

public static org.jboss.jandex.AnnotationInstance getSchemaAnnotation(org.jboss.jandex.Type type)

hasAnnotation

public static boolean hasAnnotation(org.jboss.jandex.AnnotationTarget target,
                                    org.jboss.jandex.DotName annotationName)

getAnnotation

public static org.jboss.jandex.AnnotationInstance getAnnotation(org.jboss.jandex.AnnotationTarget annotationTarget,
                                                                org.jboss.jandex.DotName annotationName)

getAnnotationValue

public static <T> T getAnnotationValue(org.jboss.jandex.AnnotationTarget target,
                                       org.jboss.jandex.DotName annotationName)

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

Type Parameters:

T - the type of the parameter being retrieved

Parameters:

target - the target object annotated with the annotation named by annotationName

annotationName - name of the annotation from which to retrieve the value

Returns:

an unwrapped annotation parameter value

getAnnotationValue

public static <T> T getAnnotationValue(org.jboss.jandex.AnnotationTarget target,
                                       org.jboss.jandex.DotName annotationName,
                                       String propertyName)

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

Type Parameters:

T - the type of the parameter being retrieved

Parameters:

target - the target object annotated with the annotation named by annotationName

annotationName - name of the annotation from which to retrieve the value

propertyName - the name of the parameter/property in the annotation

Returns:

an unwrapped annotation parameter value

getAnnotationValue

public static <T> T getAnnotationValue(org.jboss.jandex.AnnotationTarget target,
                                       org.jboss.jandex.DotName annotationName,
                                       String propertyName,
                                       T defaultValue)

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

Type Parameters:

T - the type of the parameter being retrieved

Parameters:

target - the target object annotated with the annotation named by annotationName

annotationName - name of the annotation from which to retrieve the value

propertyName - the name of the parameter/property in the annotation

defaultValue - a default value to return if either the annotation or the value are missing

Returns:

an unwrapped annotation parameter value

getAnnotations

public static Collection<org.jboss.jandex.AnnotationInstance> getAnnotations(org.jboss.jandex.AnnotationTarget type)

getDeclaringClass

public static org.jboss.jandex.ClassInfo getDeclaringClass(org.jboss.jandex.AnnotationTarget type)

getAnnotation

public static org.jboss.jandex.AnnotationInstance getAnnotation(org.jboss.jandex.Type type,
                                                                org.jboss.jandex.DotName annotationName)

getAnnotation

public static org.jboss.jandex.AnnotationInstance getAnnotation(org.jboss.jandex.ClassInfo field,
                                                                org.jboss.jandex.DotName annotationName)

getAnnotation

public static org.jboss.jandex.AnnotationInstance getAnnotation(org.jboss.jandex.FieldInfo field,
                                                                org.jboss.jandex.DotName annotationName)