Class ContextUtils
java.lang.Object
io.micronaut.openapi.visitor.ContextUtils
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final io.micronaut.core.type.Argument<Map<String, ConfigUtils.CustomSchema>> static final io.micronaut.core.type.Argument<Map<String, EndpointProperties>> static final io.micronaut.core.type.Argument<Map<String, GroupProperties>> static final io.micronaut.core.type.Argument<Map<String, ConfigUtils.SchemaDecorator>> static final io.micronaut.core.type.Argument<List<io.swagger.v3.oas.models.servers.Server>> static final io.micronaut.core.type.Argument<List<io.swagger.v3.oas.models.tags.Tag>> -
Method Summary
Modifier and TypeMethodDescriptionstatic voidaddGeneratedResource(String path, @Nullable io.micronaut.inject.visitor.VisitorContext context) static voidaddOriginatingElement(io.micronaut.inject.ast.Element element, io.micronaut.inject.visitor.VisitorContext context) Records an element contributing to the OpenAPI output for the current visitor context.static voidaddOriginatingType(io.micronaut.inject.ast.ClassElement type, io.micronaut.inject.visitor.VisitorContext context) Records a type the OpenAPI output describes as contributing to it, with the supertypes and interfaces it inherits members from: the schema of the type reads their annotations and Javadoc too.static PathcalcClassesOutputPath(io.micronaut.inject.writer.GeneratedFile generatedFile, io.micronaut.inject.visitor.VisitorContext context) static PathcalcProjectPath(io.micronaut.inject.writer.GeneratedFile generatedFile, io.micronaut.inject.visitor.VisitorContext context) static booleanstatic voidstatic voidfail(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context, @Nullable io.micronaut.inject.ast.Element element) static <T> Tget(String paramName, io.micronaut.core.type.Argument<T> arg, io.micronaut.inject.visitor.VisitorContext context) static <T> Tget(String paramName, io.micronaut.core.type.Argument<T> arg, T defaultValue, io.micronaut.inject.visitor.VisitorContext context) static <T> Tstatic <T> Tget(String paramName, Class<T> arg, T defaultValue, io.micronaut.inject.visitor.VisitorContext context) static @Nullable io.micronaut.inject.ast.ClassElementgetClassElement(String className, io.micronaut.inject.visitor.VisitorContext context) static @Nullable io.micronaut.inject.ast.ClassElement[]getClassElements(String packageName, io.micronaut.inject.visitor.VisitorContext context) static @Nullable PathgetClassesOutputPath(io.micronaut.inject.visitor.VisitorContext context) getOptions(io.micronaut.inject.visitor.VisitorContext context) static io.micronaut.inject.ast.Element[]getOriginatingElements(io.micronaut.inject.visitor.VisitorContext context) Returns the deduplicated elements contributing to the current OpenAPI output.static PathgetProjectDir(io.micronaut.inject.visitor.VisitorContext context) static IntegergetVisitedElements(io.micronaut.inject.visitor.VisitorContext context) static voidstatic voidinfo(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context, @Nullable io.micronaut.inject.ast.Element element) static <T> voidput(CharSequence paramName, T value, io.micronaut.inject.visitor.VisitorContext context) static voidstatic io.micronaut.inject.writer.GeneratedFilevisitMetaInfFile(String path, io.micronaut.inject.visitor.VisitorContext context) static io.micronaut.inject.writer.GeneratedFilevisitMetaInfFile(String path, io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element... originatingElements) Locate or create a META-INF resource and associate it with the contributing elements.static voidstatic voidwarn(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context, @Nullable io.micronaut.inject.ast.Element element)
-
Field Details
-
TAGS_LIST_ARGUMENT
public static final io.micronaut.core.type.Argument<List<io.swagger.v3.oas.models.tags.Tag>> TAGS_LIST_ARGUMENT -
SERVERS_LIST_ARGUMENT
public static final io.micronaut.core.type.Argument<List<io.swagger.v3.oas.models.servers.Server>> SERVERS_LIST_ARGUMENT -
EXTENSIONS_MAP_ARGUMENT
-
EXPANDABLE_PROPERTIES_ARGUMENT
-
ARGUMENT_SCHEMA_DECORATORS_MAP
public static final io.micronaut.core.type.Argument<Map<String, ConfigUtils.SchemaDecorator>> ARGUMENT_SCHEMA_DECORATORS_MAP -
ARGUMENT_CUSTOM_SCHEMA_MAP
public static final io.micronaut.core.type.Argument<Map<String, ConfigUtils.CustomSchema>> ARGUMENT_CUSTOM_SCHEMA_MAP -
ARGUMENT_GROUP_PROPERTIES_MAP
public static final io.micronaut.core.type.Argument<Map<String, GroupProperties>> ARGUMENT_GROUP_PROPERTIES_MAP -
ARGUMENT_ENDPOINT_PROPERTIES_MAP
public static final io.micronaut.core.type.Argument<Map<String, EndpointProperties>> ARGUMENT_ENDPOINT_PROPERTIES_MAP
-
-
Method Details
-
getVisitedElements
-
getClassesOutputPath
public static @Nullable Path getClassesOutputPath(io.micronaut.inject.visitor.VisitorContext context) -
calcClassesOutputPath
public static Path calcClassesOutputPath(io.micronaut.inject.writer.GeneratedFile generatedFile, io.micronaut.inject.visitor.VisitorContext context) -
calcProjectPath
public static Path calcProjectPath(io.micronaut.inject.writer.GeneratedFile generatedFile, io.micronaut.inject.visitor.VisitorContext context) -
visitMetaInfFile
public static io.micronaut.inject.writer.GeneratedFile visitMetaInfFile(String path, io.micronaut.inject.visitor.VisitorContext context) -
visitMetaInfFile
public static io.micronaut.inject.writer.GeneratedFile visitMetaInfFile(String path, io.micronaut.inject.visitor.VisitorContext context, io.micronaut.inject.ast.Element... originatingElements) Locate or create a META-INF resource and associate it with the contributing elements.- Parameters:
path- The META-INF-relative resource pathcontext- The visitor contextoriginatingElements- The elements contributing to the resource- Returns:
- The generated file, or
nullwhen the visitor context cannot create it
-
addOriginatingElement
public static void addOriginatingElement(io.micronaut.inject.ast.Element element, io.micronaut.inject.visitor.VisitorContext context) Records an element contributing to the OpenAPI output for the current visitor context.- Parameters:
element- The contributing elementcontext- The visitor context
-
addOriginatingType
public static void addOriginatingType(io.micronaut.inject.ast.ClassElement type, io.micronaut.inject.visitor.VisitorContext context) Records a type the OpenAPI output describes as contributing to it, with the supertypes and interfaces it inherits members from: the schema of the type reads their annotations and Javadoc too. Arrays contribute their component type. The classes of the JDK are left out, as they are never compiled with the application.- Parameters:
type- The typecontext- The visitor context
-
getOriginatingElements
public static io.micronaut.inject.ast.Element[] getOriginatingElements(io.micronaut.inject.visitor.VisitorContext context) Returns the deduplicated elements contributing to the current OpenAPI output.- Parameters:
context- The visitor context- Returns:
- The contributing elements in their deterministic insertion order
-
getProjectDir
-
warn
public static void warn(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context) -
warn
public static void warn(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context, @Nullable io.micronaut.inject.ast.Element element) -
info
public static void info(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context) -
info
public static void info(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context, @Nullable io.micronaut.inject.ast.Element element) -
fail
public static void fail(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context) -
fail
public static void fail(String message, @Nullable io.micronaut.inject.visitor.VisitorContext context, @Nullable io.micronaut.inject.ast.Element element) -
addGeneratedResource
public static void addGeneratedResource(String path, @Nullable io.micronaut.inject.visitor.VisitorContext context) -
get
public static <T> T get(String paramName, io.micronaut.core.type.Argument<T> arg, io.micronaut.inject.visitor.VisitorContext context) -
get
public static <T> T get(String paramName, io.micronaut.core.type.Argument<T> arg, T defaultValue, io.micronaut.inject.visitor.VisitorContext context) -
get
-
get
-
put
public static <T> void put(CharSequence paramName, T value, io.micronaut.inject.visitor.VisitorContext context) -
remove
-
contains
public static boolean contains(String paramName, io.micronaut.inject.visitor.VisitorContext context) -
getOptions
-
getClassElement
public static @Nullable io.micronaut.inject.ast.ClassElement getClassElement(String className, io.micronaut.inject.visitor.VisitorContext context) -
getClassElements
public static @Nullable io.micronaut.inject.ast.ClassElement[] getClassElements(String packageName, io.micronaut.inject.visitor.VisitorContext context)
-