io.smallrye.openapi.runtime.util

Class SchemaFactory

java.lang.Object

io.smallrye.openapi.runtime.util.SchemaFactory

public class SchemaFactory
extends Object

Author:

Marc Savy <marc@rhymewithgravy.com>

Method Summary

Modifier and Type	Method and Description
static org.eclipse.microprofile.openapi.models.media.Schema	readClassSchema(org.jboss.jandex.IndexView index, org.jboss.jandex.Type type, boolean schemaReferenceSupported) Introspect into the given Class to generate a Schema model.
static org.eclipse.microprofile.openapi.models.media.Schema	readSchema(org.jboss.jandex.IndexView index, org.jboss.jandex.AnnotationInstance annotation) Reads a Schema annotation into a model.
static org.eclipse.microprofile.openapi.models.media.Schema	readSchema(org.jboss.jandex.IndexView index, org.jboss.jandex.AnnotationValue value) Reads a Schema annotation into a model.
static org.eclipse.microprofile.openapi.models.media.Schema	readSchema(org.jboss.jandex.IndexView index, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationInstance annotation, Map<String,Object> overrides)
static org.eclipse.microprofile.openapi.models.media.Schema	typeToSchema(org.jboss.jandex.IndexView index, org.jboss.jandex.Type type, List<AnnotationScannerExtension> extensions) Converts a jandex type to a Schema model.

Methods inherited from class java.lang.Object

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

Method Detail

readSchema

public static org.eclipse.microprofile.openapi.models.media.Schema readSchema(org.jboss.jandex.IndexView index,
                                                                              org.jboss.jandex.AnnotationValue value)

Reads a Schema annotation into a model.

Parameters:

index -

value -

readSchema

public static org.eclipse.microprofile.openapi.models.media.Schema readSchema(org.jboss.jandex.IndexView index,
                                                                              org.jboss.jandex.AnnotationInstance annotation)

Reads a Schema annotation into a model.

Parameters:

index -

annotation -

readSchema

public static org.eclipse.microprofile.openapi.models.media.Schema readSchema(org.jboss.jandex.IndexView index,
                                                                              org.eclipse.microprofile.openapi.models.media.Schema schema,
                                                                              org.jboss.jandex.AnnotationInstance annotation,
                                                                              Map<String,Object> overrides)

readClassSchema

public static org.eclipse.microprofile.openapi.models.media.Schema readClassSchema(org.jboss.jandex.IndexView index,
                                                                                   org.jboss.jandex.Type type,
                                                                                   boolean schemaReferenceSupported)

Introspect into the given Class to generate a Schema model. The boolean indicates whether this class type should be turned into a reference.

Parameters:

index - the index of classes being scanned

type - the implementation type of the item to scan

schemaReferenceSupported -

typeToSchema

public static org.eclipse.microprofile.openapi.models.media.Schema typeToSchema(org.jboss.jandex.IndexView index,
                                                                                org.jboss.jandex.Type type,
                                                                                List<AnnotationScannerExtension> extensions)

Converts a jandex type to a Schema model.

Parameters:

index - the index of classes being scanned

type - the implementation type of the item to scan

extensions -