io.smallrye.openapi.runtime.io.tag

Class TagReader

java.lang.Object

io.smallrye.openapi.runtime.io.tag.TagReader

public class TagReader
extends Object

Reading the Tag from annotation or json

Author:

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

See Also:

tagObject

Method Summary

Modifier and Type	Method and Description
static List<org.jboss.jandex.AnnotationInstance>	getTagAnnotations(org.jboss.jandex.AnnotationTarget target)
static boolean	hasTagAnnotation(org.jboss.jandex.AnnotationTarget target)
static org.eclipse.microprofile.openapi.models.tags.Tag	readTag(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance) Reads a single Tag annotation.
static Optional<List<org.eclipse.microprofile.openapi.models.tags.Tag>>	readTags(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue annotationValue) Reads any Tag annotations.The annotation value is an array of Tag annotations.
static Optional<List<org.eclipse.microprofile.openapi.models.tags.Tag>>	readTags(com.fasterxml.jackson.databind.JsonNode node) Reads a list of Tag OpenAPI nodes.

Methods inherited from class java.lang.Object

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

Method Detail

readTags

public static Optional<List<org.eclipse.microprofile.openapi.models.tags.Tag>> readTags(AnnotationScannerContext context,
                                                                                        org.jboss.jandex.AnnotationValue annotationValue)

Reads any Tag annotations.The annotation value is an array of Tag annotations.

Parameters:

context - scanning context

annotationValue - an array of @Tag annotations

Returns:

List of Tag models

readTags

public static Optional<List<org.eclipse.microprofile.openapi.models.tags.Tag>> readTags(com.fasterxml.jackson.databind.JsonNode node)

Reads a list of Tag OpenAPI nodes.

Parameters:

node - the json array node

Returns:

List of Tag models

readTag

public static org.eclipse.microprofile.openapi.models.tags.Tag readTag(AnnotationScannerContext context,
                                                                       org.jboss.jandex.AnnotationInstance annotationInstance)

Reads a single Tag annotation.

Parameters:

context - scanning context

annotationInstance - @Tag annotation, must not be null

Returns:

Tag model

hasTagAnnotation

public static boolean hasTagAnnotation(org.jboss.jandex.AnnotationTarget target)

getTagAnnotations

public static List<org.jboss.jandex.AnnotationInstance> getTagAnnotations(org.jboss.jandex.AnnotationTarget target)