Class OpenApiExtraSchemaVisitor

java.lang.Object
io.micronaut.openapi.visitor.OpenApiExtraSchemaVisitor
All Implemented Interfaces:
io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable, io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExtraSchemas, Object>
@Internal @SupportedOptions("micronaut.openapi.enabled") public class OpenApiExtraSchemaVisitor extends Object implements io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExtraSchemas, Object>
A TypeElementVisitor that builds the extra Open API schema definitions included by @OpenAPIExtraSchema at the compile time.
Since:
6.12.0

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

    io.micronaut.inject.visitor.TypeElementVisitor.VisitorKind

  • Field Summary

    Fields inherited from interface io.micronaut.core.order.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenApiExtraSchemaVisitor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    clean()
     
    void
    finish(@NonNull io.micronaut.inject.visitor.VisitorContext context)
     
    static Collection<String>
    getExcludedExtraSchemas()
     
    static Map<String, io.swagger.v3.oas.models.media.Schema>
    getExtraSchemas()
     
    int
    getOrder()
     
    @NonNull Set<String>
    getSupportedAnnotationNames()
     
    void
    start(@NonNull io.micronaut.inject.visitor.VisitorContext context)
     
    void
    visitClass(@NonNull io.micronaut.inject.ast.ClassElement element, @NonNull io.micronaut.inject.visitor.VisitorContext context)
     

    Methods inherited from class Object

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

    Methods inherited from interface io.micronaut.core.util.Toggleable

    isEnabled

    Methods inherited from interface io.micronaut.inject.visitor.TypeElementVisitor

    getClassType, getElementType, getSupportedOptions, getVisitorKind, query, visitConstructor, visitEnumConstant, visitField, visitMethod

  • Constructor Details

    • OpenApiExtraSchemaVisitor

      public OpenApiExtraSchemaVisitor()

  • Method Details

    • getSupportedAnnotationNames

      public @NonNull Set<String> getSupportedAnnotationNames()
      Specified by:
      getSupportedAnnotationNames in interface io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExtraSchemas, Object>

    • start

      public void start(@NonNull io.micronaut.inject.visitor.VisitorContext context)
      Specified by:
      start in interface io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExtraSchemas, Object>

    • finish

      public void finish(@NonNull io.micronaut.inject.visitor.VisitorContext context)
      Specified by:
      finish in interface io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExtraSchemas, Object>

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface io.micronaut.core.order.Ordered

    • visitClass

      public void visitClass(@NonNull io.micronaut.inject.ast.ClassElement element, @NonNull io.micronaut.inject.visitor.VisitorContext context)
      Specified by:
      visitClass in interface io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExtraSchemas, Object>

    • getExtraSchemas

      public static Map<String, io.swagger.v3.oas.models.media.Schema> getExtraSchemas()

    • getExcludedExtraSchemas

      public static Collection<String> getExcludedExtraSchemas()

    • clean

      public static void clean()