Package io.micronaut.openapi.visitor

Class OpenApiExcludeVisitor

java.lang.Object
io.micronaut.openapi.visitor.OpenApiExcludeVisitor
All Implemented Interfaces:
io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable, io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExcludes,Object>
@SupportedOptions("micronaut.openapi.enabled") public class OpenApiExcludeVisitor extends Object implements io.micronaut.inject.visitor.TypeElementVisitor<OpenAPIExcludes,Object>
A TypeElementVisitor that builds the Swagger model from Micronaut controllers included by @OpenAPIExclude at the compile time.
Since:
6.18.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
    OpenApiExcludeVisitor()
     
    OpenApiExcludeVisitor(List<String> excludedPackages, List<String> excludedClasses)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    clean()
     
    static List<String>
    getExcludedClasses()
     
    static List<String>
    getExcludedPackages()
     
    int
    getOrder()
     
    void
    start(io.micronaut.inject.visitor.VisitorContext context)
     
    void
    visitClass(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context)
     

    Methods inherited from class java.lang.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

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

  • Constructor Details

    • OpenApiExcludeVisitor

      public OpenApiExcludeVisitor()

    • OpenApiExcludeVisitor

      public OpenApiExcludeVisitor(List<String> excludedPackages, List<String> excludedClasses)

  • Method Details

    • start

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

    • visitClass

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

    • getExcludedPackages

      public static List<String> getExcludedPackages()

    • getExcludedClasses

      public static List<String> getExcludedClasses()

    • clean

      public static void clean()

    • getOrder

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