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>

Method Summary

Modifier and Type	Method and Description
static boolean	allowRegistration(org.jboss.jandex.IndexView index, org.jboss.jandex.Type classType) Determines if a type is eligible for registration.
static void	applyTypeAttributes(org.jboss.jandex.Type classType, org.eclipse.microprofile.openapi.models.media.Schema schema) Sets the default schema attributes for the given type on the provided schema instance.
static io.smallrye.openapi.runtime.util.TypeUtil.TypeWithFormat	arrayFormat()
static void	clearMatchingDefaultAttributes(org.eclipse.microprofile.openapi.models.media.Schema fieldSchema, org.eclipse.microprofile.openapi.models.media.Schema typeSchema) Removes the known default schema attributes from the fieldSchema if they are also present and have the same value in the typeSchema.
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 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.Type	getOptionalType(org.jboss.jandex.Type type) Unwraps the type parameter (generic or primitive) from the given optional 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 Map<String,Object>	getTypeAttributes(org.jboss.jandex.Type classType) Retrieves the read-only Map of schema attributes for the given type.
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	isOptional(org.jboss.jandex.Type type) Determine if a given type is one of the following types: java.util.Optional java.util.OptionalDouble java.util.OptionalInt java.util.OptionalLong
static boolean	isPrimitiveWrapper(org.jboss.jandex.PrimitiveType primitive, org.jboss.jandex.Type wrapped)
static boolean	isTerminalType(org.jboss.jandex.Type type)
static io.smallrye.openapi.runtime.util.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

allowRegistration

public static boolean allowRegistration(org.jboss.jandex.IndexView index,
                                        org.jboss.jandex.Type classType)

Determines if a type is eligible for registration. If the schema type is array or object, the type must be in the provided index. Otherwise, only those types with defined properties beyond 'type' and 'format' are eligible.

Parameters:

index - index of classes to consider

classType - the type to check

Returns:

true if the type may be registered in the SchemaRegistry, false otherwise.

getTypeAttributes

public static Map<String,Object> getTypeAttributes(org.jboss.jandex.Type classType)

Retrieves the read-only Map of schema attributes for the given type.

Parameters:

classType - the type

Returns:

Map of default schema attributes

applyTypeAttributes

public static void applyTypeAttributes(org.jboss.jandex.Type classType,
                                       org.eclipse.microprofile.openapi.models.media.Schema schema)

Sets the default schema attributes for the given type on the provided schema instance.

Parameters:

classType - the type

schema - a writable schema to be updated with the type's default schema attributes

clearMatchingDefaultAttributes

public static void clearMatchingDefaultAttributes(org.eclipse.microprofile.openapi.models.media.Schema fieldSchema,
                                                  org.eclipse.microprofile.openapi.models.media.Schema typeSchema)

Removes the known default schema attributes from the fieldSchema if they are also present and have the same value in the typeSchema. This method reduces any duplicate attributes between the two schemas when they are in an 'allOf' composition.

Parameters:

fieldSchema - the schema for a field of the type described by typeSchema

typeSchema - the schema for a class type

arrayFormat

public static io.smallrye.openapi.runtime.util.TypeUtil.TypeWithFormat arrayFormat()

objectFormat

public static io.smallrye.openapi.runtime.util.TypeUtil.TypeWithFormat objectFormat()

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

isTerminalType

public static boolean isTerminalType(org.jboss.jandex.Type type)

isOptional

public static boolean isOptional(org.jboss.jandex.Type type)

Determine if a given type is one of the following types:

• java.util.Optional
• java.util.OptionalDouble
• java.util.OptionalInt
• java.util.OptionalLong

Parameters:

type - the type to check

Returns:

true if the type is one of the four optional types, otherwise false

getOptionalType

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

Unwraps the type parameter (generic or primitive) from the given optional type.

Parameters:

type - the type to unwrap

Returns:

the generic type argument for java.util.Optional, otherwise the optional primitive double, int, or long

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)