io.smallrye.openapi.runtime.scanner

Class ParameterProcessor

java.lang.Object

io.smallrye.openapi.runtime.scanner.ParameterProcessor

public class ParameterProcessor
extends Object

Note, PathParam targets of PathSegment are not currently supported.

Author:

Michael Edgar <michael@xlate.io>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterProcessor.JaxRsParameter Meta information for the JAX-RS *Param annotations relating them to the Parameter.In and Parameter.Style attributes of Parameters.
static class	ParameterProcessor.ResourceParameters Result object returned to the annotation scanner.

Method Summary

Modifier and Type	Method and Description
static ParameterProcessor.ResourceParameters	process(org.jboss.jandex.IndexView index, org.jboss.jandex.MethodInfo resourceMethod, Function<org.jboss.jandex.AnnotationInstance,ParameterImpl> reader, List<AnnotationScannerExtension> extensions) Process parameter annotations for the given class and method.

Methods inherited from class java.lang.Object

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

Method Detail

process

public static ParameterProcessor.ResourceParameters process(org.jboss.jandex.IndexView index,
                                                            org.jboss.jandex.MethodInfo resourceMethod,
                                                            Function<org.jboss.jandex.AnnotationInstance,ParameterImpl> 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 ParameterProcessor.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

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

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

extensions - scanner extensions

Returns:

scanned parameters and modified path contained in a ParameterProcessor.ResourceParameters object