Uses of Class
io.smallrye.openapi.runtime.scanner.spi.AnnotationScannerContext
-
-
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.callback
Methods in io.smallrye.openapi.runtime.io.callback with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.callbacks.Callback
CallbackReader. readCallback(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation)
static org.eclipse.microprofile.openapi.models.callbacks.Callback
CallbackReader. readCallback(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation, org.jboss.jandex.MethodInfo methodInfo)
Reads a Callback annotation into a model.static Map<String,org.eclipse.microprofile.openapi.models.callbacks.Callback>
CallbackReader. readCallbacks(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Callback annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.components
Methods in io.smallrye.openapi.runtime.io.components with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.Components
ComponentsReader. readComponents(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads any Components annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.content
Methods in io.smallrye.openapi.runtime.io.content with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.media.Content
ContentReader. readContent(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue, ContentDirection direction)
Reads a single Content annotation into a model. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.definition
Methods in io.smallrye.openapi.runtime.io.definition with parameters of type AnnotationScannerContext Modifier and Type Method Description static void
DefinitionReader. processDefinition(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.OpenAPI openApi, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a OpenAPIDefinition annotation. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.encoding
Methods in io.smallrye.openapi.runtime.io.encoding with parameters of type AnnotationScannerContext Modifier and Type Method Description static Map<String,org.eclipse.microprofile.openapi.models.media.Encoding>
EncodingReader. readEncodings(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads an array of Encoding annotations as a Map. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.example
Methods in io.smallrye.openapi.runtime.io.example with parameters of type AnnotationScannerContext Modifier and Type Method Description static Object
ExampleReader. parseValue(AnnotationScannerContext context, String value)
Reads an example value and decode it, the parsing is delegated to the extensions currently set in the scanner.static Map<String,org.eclipse.microprofile.openapi.models.examples.Example>
ExampleReader. readExamples(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Example annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.extension
Methods in io.smallrye.openapi.runtime.io.extension with parameters of type AnnotationScannerContext Modifier and Type Method Description static Map<String,Object>
ExtensionReader. readExtensions(AnnotationScannerContext context, List<org.jboss.jandex.AnnotationInstance> extensions)
Reads a List of Extension annotations.static Map<String,Object>
ExtensionReader. readExtensions(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance extensible)
static Map<String,Object>
ExtensionReader. readExtensions(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads an array of Extension annotations.static Object
ExtensionReader. readExtensionValue(AnnotationScannerContext context, String name, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a single Extension annotation. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.externaldocs
Methods in io.smallrye.openapi.runtime.io.externaldocs with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.ExternalDocumentation
ExternalDocsReader. readExternalDocs(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads an ExternalDocumentation annotation.static org.eclipse.microprofile.openapi.models.ExternalDocumentation
ExternalDocsReader. readExternalDocs(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads an ExternalDocumentation annotation. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.header
Methods in io.smallrye.openapi.runtime.io.header with parameters of type AnnotationScannerContext Modifier and Type Method Description static Map<String,org.eclipse.microprofile.openapi.models.headers.Header>
HeaderReader. readHeaders(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Header annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.mediatype
Methods in io.smallrye.openapi.runtime.io.mediatype with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.media.MediaType
MediaTypeReader. readMediaType(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a single Content annotation into aMediaType
model. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.operation
Methods in io.smallrye.openapi.runtime.io.operation with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.Operation
OperationReader. readOperation(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance, org.jboss.jandex.MethodInfo methodInfo)
Reads a single Operation annotation. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.parameter
Methods in io.smallrye.openapi.runtime.io.parameter with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.parameters.Parameter
ParameterReader. readParameter(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a Parameter annotation into a model.static Map<String,org.eclipse.microprofile.openapi.models.parameters.Parameter>
ParameterReader. readParameters(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Parameter annotations.static Optional<List<org.eclipse.microprofile.openapi.models.parameters.Parameter>>
ParameterReader. readParametersList(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Parameter annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.paths
Methods in io.smallrye.openapi.runtime.io.paths with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.PathItem
PathsReader. readPathItem(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
static org.eclipse.microprofile.openapi.models.PathItem
PathsReader. readPathItem(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue, org.jboss.jandex.MethodInfo methodInfo)
Reads the PathItem. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.requestbody
Methods in io.smallrye.openapi.runtime.io.requestbody with parameters of type AnnotationScannerContext Modifier and Type Method Description static Map<String,org.eclipse.microprofile.openapi.models.parameters.RequestBody>
RequestBodyReader. readRequestBodies(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of RequestBody annotations.static org.eclipse.microprofile.openapi.models.parameters.RequestBody
RequestBodyReader. readRequestBody(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a RequestBody annotation into a model.static org.eclipse.microprofile.openapi.models.parameters.RequestBody
RequestBodyReader. readRequestBody(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a RequestBody annotation into a model.static org.eclipse.microprofile.openapi.models.parameters.RequestBody
RequestBodyReader. readRequestBodySchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation)
Reads a RequestBodySchema annotation into a model. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.response
Methods in io.smallrye.openapi.runtime.io.response with parameters of type AnnotationScannerContext Modifier and Type Method Description static String
ResponseReader. getResponseName(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation)
static org.eclipse.microprofile.openapi.models.responses.APIResponse
ResponseReader. readResponse(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a APIResponse annotation into a model.static org.eclipse.microprofile.openapi.models.responses.APIResponses
ResponseReader. readResponses(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads an array of APIResponse annotations into anAPIResponses
model.static org.eclipse.microprofile.openapi.models.responses.APIResponse
ResponseReader. readResponseSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation)
Reads a APIResponseSchema annotation into a model.static Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse>
ResponseReader. readResponsesMap(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of APIResponse annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.schema
Methods in io.smallrye.openapi.runtime.io.schema with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. enumToSchema(AnnotationScannerContext context, org.jboss.jandex.Type enumType)
Convert a Jandex enum class type to aSchema
model.Adds each enum constant name to the list of the given schema's enumeration list.static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. readSchema(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationInstance annotation, Map<String,Object> defaults)
static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. readSchema(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationInstance annotation, org.jboss.jandex.ClassInfo clazz)
Populates the schema using the@Schema
on the provided class.static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. readSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance schemaAnnotation)
Reads a Schema annotation into a model.static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. readSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue value)
Reads a Schema annotation into a model.static Map<String,org.eclipse.microprofile.openapi.models.media.Schema>
SchemaReader. readSchemas(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of Schema annotations.static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. schemaRegistration(AnnotationScannerContext context, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema)
Register the provided schema in the SchemaRegistry if allowed.static org.eclipse.microprofile.openapi.models.media.Schema
SchemaFactory. typeToSchema(AnnotationScannerContext context, org.jboss.jandex.Type type, List<AnnotationScannerExtension> extensions)
Converts a Jandex type to aSchema
model. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.securityscheme
Methods in io.smallrye.openapi.runtime.io.securityscheme with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.security.SecurityScheme
SecuritySchemeReader. readSecurityScheme(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a SecurityScheme annotation into a model.static Map<String,org.eclipse.microprofile.openapi.models.security.SecurityScheme>
SecuritySchemeReader. readSecuritySchemes(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads a map of SecurityScheme annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.tag
Methods in io.smallrye.openapi.runtime.io.tag with parameters of type AnnotationScannerContext Modifier and Type Method Description static org.eclipse.microprofile.openapi.models.tags.Tag
TagReader. readTag(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)
Reads a single Tag annotation.static Optional<List<org.eclipse.microprofile.openapi.models.tags.Tag>>
TagReader. readTags(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue)
Reads any Tag annotations.The annotation value is an array of Tag annotations. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner
Methods in io.smallrye.openapi.runtime.scanner with parameters of type AnnotationScannerContext Modifier and Type Method Description static SchemaRegistry
SchemaRegistry. newInstance(AnnotationScannerContext context)
Create a new instance of aSchemaRegistry
on this thread.static org.eclipse.microprofile.openapi.models.media.Schema
OpenApiDataObjectScanner. process(AnnotationScannerContext context, org.jboss.jandex.Type type)
Build a Schema with ClassType as root.Constructors in io.smallrye.openapi.runtime.scanner with parameters of type AnnotationScannerContext Constructor Description OpenApiDataObjectScanner(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget annotationTarget, org.jboss.jandex.Type classType)
OpenApiDataObjectScanner(AnnotationScannerContext context, org.jboss.jandex.Type classType)
Constructor for data object scanner. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner.dataobject
Methods in io.smallrye.openapi.runtime.scanner.dataobject with parameters of type AnnotationScannerContext Modifier and Type Method Description static TypeResolver
TypeResolver. forClass(AnnotationScannerContext context, org.jboss.jandex.ClassInfo clazz, org.jboss.jandex.Type leaf)
Create a new TypeResolver for the given ClassInfo clazz and type.static Map<String,TypeResolver>
TypeResolver. getAllFields(AnnotationScannerContext context, org.jboss.jandex.Type leaf, org.jboss.jandex.ClassInfo leafKlazz, org.jboss.jandex.AnnotationTarget reference)
static org.eclipse.microprofile.openapi.models.media.Schema
AnnotationTargetProcessor. process(AnnotationScannerContext context, DataObjectDeque objectStack, TypeResolver typeResolver, DataObjectDeque.PathEntry parentPathEntry)
static org.eclipse.microprofile.openapi.models.media.Schema
AnnotationTargetProcessor. process(AnnotationScannerContext context, DataObjectDeque objectStack, TypeResolver typeResolver, DataObjectDeque.PathEntry parentPathEntry, org.jboss.jandex.Type type)
static org.jboss.jandex.ParameterizedType
TypeResolver. resolveParameterizedAncestor(AnnotationScannerContext context, org.jboss.jandex.ParameterizedType pType, org.jboss.jandex.Type seekType)
Constructors in io.smallrye.openapi.runtime.scanner.dataobject with parameters of type AnnotationScannerContext Constructor Description TypeProcessor(AnnotationScannerContext context, DataObjectDeque objectStack, DataObjectDeque.PathEntry parentPathEntry, TypeResolver typeResolver, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationTarget annotationTarget)
-
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner.spi
Fields in io.smallrye.openapi.runtime.scanner.spi declared as AnnotationScannerContext Modifier and Type Field Description protected AnnotationScannerContext
AbstractParameterProcessor. scannerContext
Methods in io.smallrye.openapi.runtime.scanner.spi with parameters of type AnnotationScannerContext Modifier and Type Method Description default void
AnnotationScanner. addApiReponseFromAnnotation(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance apiResponseAnnotation, org.eclipse.microprofile.openapi.models.Operation operation)
Add api response to api responses using the annotation informationdefault void
AnnotationScanner. addApiReponseSchemaFromAnnotation(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)
Add api response to api responses using the annotation informationdefault void
AnnotationScanner. createResponseFromRestMethod(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)
Called when a scanner (jax-rs, spring) method's APIResponse annotations have all been processed but no response was actually created for the operation.This method will create a response from the method information and add it to the given operation.default String[]
AnnotationScanner. getConsumes(AnnotationScannerContext context)
default List<org.jboss.jandex.MethodInfo>
AnnotationScanner. getResourceMethods(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resource)
Extracts all methods from the provided class and its ancestors that are known to the instance's indexdefault org.eclipse.microprofile.openapi.models.media.Schema
AnnotationScanner. kotlinContinuationToSchema(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method)
default void
AnnotationScanner. processCallback(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)
Process a callback annotationdefault void
AnnotationScanner. processDefinitionAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi)
Process a certain class for OpenApiDefinition annotations.default void
AnnotationScanner. processExtensions(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)
Process the Extensions annotationsdefault Optional<org.eclipse.microprofile.openapi.models.Operation>
AnnotationScanner. processOperation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo method)
While scanning JAX-RS/Spring method, find the operationsdefault void
AnnotationScanner. processOperationTags(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.OpenAPI openApi, Set<String> resourceTags, org.eclipse.microprofile.openapi.models.Operation operation)
Process tags.default org.eclipse.microprofile.openapi.models.parameters.RequestBody
AnnotationScanner. processRequestBody(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, ResourceParameters params)
Process the request bodydefault void
AnnotationScanner. processResponse(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation, Map<org.jboss.jandex.DotName,org.jboss.jandex.AnnotationInstance> exceptionAnnotationMap)
default void
AnnotationScanner. processScannerExtensions(AnnotationScannerContext context, Collection<org.jboss.jandex.ClassInfo> applications)
Scan for scanner extensionsdefault void
AnnotationScanner. processSecuritySchemeAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi)
Process a certain class for security annotations.default Set<String>
AnnotationScanner. processTags(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target, org.eclipse.microprofile.openapi.models.OpenAPI openApi, boolean nullWhenMissing)
Processes anyTag
orTags
annotations present on the annotation target and adds them to the OpenAPI model.default boolean
AnnotationScanner. responseCodeExistInMethodAnnotations(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance exMapperApiResponseAnnotation, List<org.jboss.jandex.AnnotationInstance> methodApiResponseAnnotations)
Check if the response code declared in the ExceptionMapper already defined in one of the ApiReponse annotations of the method.org.eclipse.microprofile.openapi.models.OpenAPI
AnnotationScanner. scan(AnnotationScannerContext annotationScannerContext, org.eclipse.microprofile.openapi.models.OpenAPI oai)
Constructors in io.smallrye.openapi.runtime.scanner.spi with parameters of type AnnotationScannerContext Constructor Description AbstractParameterProcessor(AnnotationScannerContext scannerContext, Function<org.jboss.jandex.AnnotationInstance,org.eclipse.microprofile.openapi.models.parameters.Parameter> reader, List<AnnotationScannerExtension> extensions)
-
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.util
Methods in io.smallrye.openapi.runtime.util with parameters of type AnnotationScannerContext Modifier and Type Method Description static boolean
TypeUtil. allowRegistration(AnnotationScannerContext context, org.jboss.jandex.Type classType)
Determines if a type is eligible for registration.static boolean
TypeUtil. isA(AnnotationScannerContext context, org.jboss.jandex.Type testSubject, org.jboss.jandex.Type testObject)
Test whether testSubject is an "instanceof" type testObject.
-