io.smallrye.openapi.jaxrs

Class ParameterProcessor

java.lang.Object

io.smallrye.openapi.jaxrs.ParameterProcessor

public class ParameterProcessor
extends Object

Note, PathParam targets of PathSegment are not currently supported.

Author:

Michael Edgar <michael@xlate.io>

Method Summary

Modifier and Type	Method and Description
static ResourceParameters	process(org.jboss.jandex.IndexView index, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo resourceMethod, Function<org.jboss.jandex.AnnotationInstance,org.eclipse.microprofile.openapi.models.parameters.Parameter> reader, List<AnnotationScannerExtension> extensions) Process parameter annotations for the given class and method.This method operates in two phases.

Methods inherited from class java.lang.Object

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

Method Detail

process

public static ResourceParameters process(org.jboss.jandex.IndexView index,
                                         org.jboss.jandex.ClassInfo resourceClass,
                                         org.jboss.jandex.MethodInfo resourceMethod,
                                         Function<org.jboss.jandex.AnnotationInstance,org.eclipse.microprofile.openapi.models.parameters.Parameter> reader,
                                         List<AnnotationScannerExtension> extensions)

Process parameter annotations for the given class and method.This method operates in two phases. First, class-level parameters are processed and saved in the ResourceParameters. Second, method-level parameters are processed. Form parameters are only applicable to the method-level in this component.

Parameters:

index - index of classes to be used for further introspection, if necessary

resourceClass - the class info

resourceMethod - the JAX-RS resource method, annotated with one of the JAX-RS HTTP annotations

reader - callback method for a function producing Parameter from a Parameter

extensions - scanner extensions

Returns:

scanned parameters and modified path contained in a ResourceParameters object