io.smallrye.openapi.runtime.io.parameter

Class ParameterReader

java.lang.Object

io.smallrye.openapi.runtime.io.parameter.ParameterReader

public class ParameterReader
extends Object

Reading the Parameter annotation

Author:

Phillip Kruger (phillip.kruger@redhat.com), Eric Wittmann (eric.wittmann@gmail.com)

See Also:

parameter-object

Method Summary

Modifier and Type	Method and Description
static org.eclipse.microprofile.openapi.models.parameters.Parameter	readParameter(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance) Reads a Parameter annotation into a model.
static org.eclipse.microprofile.openapi.models.parameters.Parameter	readParameter(com.fasterxml.jackson.databind.JsonNode node) Reads a Parameter OpenAPI node.
static Optional<List<org.eclipse.microprofile.openapi.models.parameters.Parameter>>	readParameterList(com.fasterxml.jackson.databind.JsonNode node) Reads a Parameter OpenAPI node.
static Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter>	readParameters(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue) Reads a map of Parameter annotations.
static Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter>	readParameters(com.fasterxml.jackson.databind.JsonNode node) Reads the Parameter OpenAPI nodes.
static Optional<List<org.eclipse.microprofile.openapi.models.parameters.Parameter>>	readParametersList(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue) Reads a map of Parameter annotations.

Methods inherited from class java.lang.Object

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

Method Detail

readParametersList

public static Optional<List<org.eclipse.microprofile.openapi.models.parameters.Parameter>> readParametersList(AnnotationScannerContext context,
                                                                                                              org.jboss.jandex.AnnotationValue annotationValue)

Reads a map of Parameter annotations.

Parameters:

context - the scanning context

annotationValue - Map of @Parameter annotations

Returns:

List of Parameter model

readParameterList

public static Optional<List<org.eclipse.microprofile.openapi.models.parameters.Parameter>> readParameterList(com.fasterxml.jackson.databind.JsonNode node)

Reads a Parameter OpenAPI node.

Parameters:

node - json list

Returns:

List of Parameter model

readParameters

public static Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter> readParameters(AnnotationScannerContext context,
                                                                                                      org.jboss.jandex.AnnotationValue annotationValue)

Reads a map of Parameter annotations.

Parameters:

context - the scanning context

annotationValue - Map of @Parameter annotations

Returns:

Map of Parameter model

readParameters

public static Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter> readParameters(com.fasterxml.jackson.databind.JsonNode node)

Reads the Parameter OpenAPI nodes.

Parameters:

node - json map of Parameters

Returns:

Map of Parameter model

readParameter

public static org.eclipse.microprofile.openapi.models.parameters.Parameter readParameter(AnnotationScannerContext context,
                                                                                         org.jboss.jandex.AnnotationInstance annotationInstance)

Reads a Parameter annotation into a model.

Parameters:

context - the scanning context

annotationInstance - @Parameter model

Returns:

Parameter model

readParameter

public static org.eclipse.microprofile.openapi.models.parameters.Parameter readParameter(com.fasterxml.jackson.databind.JsonNode node)

Reads a Parameter OpenAPI node.

Parameters:

node - the json object

Returns:

Parameter model