io.smallrye.openapi.runtime.scanner

Interface AnnotationScannerExtension

All Known Implementing Classes:

DefaultAnnotationScannerExtension

public interface AnnotationScannerExtension

Extension point for supporting extensions to JAX-RS. Implement this directly or extend DefaultAnnotationScannerExtension.

See Also:

DefaultAnnotationScannerExtension

Method Summary

Modifier and Type	Method and Description
default boolean	isJaxRsAnnotationExtension(org.jboss.jandex.AnnotationInstance instance) Returns true if the given annotation is a jax-rs annotation extension, such as would be in the javax.ws.rs package.
default void	processJaxRsApplications(OpenApiAnnotationScanner scanner, Collection<org.jboss.jandex.ClassInfo> applications) Gives a chance to extensions to process the set of jax-rs application classes.
default org.jboss.jandex.Type	resolveAsyncType(org.jboss.jandex.Type type) Unwraps an asynchronous type such as CompletionStage<X> into its resolved type X

Method Detail

resolveAsyncType

default org.jboss.jandex.Type resolveAsyncType(org.jboss.jandex.Type type)

Unwraps an asynchronous type such as CompletionStage<X> into its resolved type X

Parameters:

type - the type to unwrap if it is a supported async type

Returns:

the resolved type or null if not supported

processJaxRsApplications

default void processJaxRsApplications(OpenApiAnnotationScanner scanner,
                                      Collection<org.jboss.jandex.ClassInfo> applications)

Gives a chance to extensions to process the set of jax-rs application classes.

Parameters:

scanner - the scanner used for application scanning

applications - the set of jax-rs application classes

isJaxRsAnnotationExtension

default boolean isJaxRsAnnotationExtension(org.jboss.jandex.AnnotationInstance instance)

Returns true if the given annotation is a jax-rs annotation extension, such as would be in the javax.ws.rs package.

Parameters:

instance - the annotation to check

Returns:

true if the given annotation is a jax-rs annotation extension