Class JetOpenApiAnnotationsExtension

java.lang.Object

net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension

@NullMarked
public abstract class JetOpenApiAnnotationsExtension
extends Object

JetOpenApiAnnotationsExtension is a Gradle extension for JetOpenApiAnnotationsPlugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JetOpenApiAnnotationsExtension.GenerateOperationId	JetOpenApiAnnotationsExtension.GenerateOperationId is an enum for getGenerateOperationId().

Constructor Summary

Constructors

Constructor	Description
JetOpenApiAnnotationsExtension()

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.provider.Property<JetOpenApiAnnotationsExtension.GenerateOperationId>	getGenerateOperationId()	For the JetOpenApiAnnotationsTask, set the JetOpenApiAnnotationsExtension.GenerateOperationId configuration.
abstract org.gradle.api.provider.SetProperty<org.gradle.api.tasks.compile.JavaCompile>	getJavaCompileTasks()	The JavaCompile tasks that are used to read compiled class files and classpaths from in JetOpenApiAnnotationsTask.
abstract org.gradle.api.provider.Property<Boolean>	getMoveClassSchemasToComponents()	For the JetOpenApiAnnotationsTask, set to true to move the JSON schema generated from OpenApiSchema.fromClass() to OpenApiComponents.schemas(), set to false otherwise.
abstract org.gradle.api.file.DirectoryProperty	getOutputDirectory()	The JetOpenApiAnnotationsTask output directory.
abstract org.gradle.api.provider.Property<Boolean>	getOutputDirectoryIncludeInJar()	Set to true to include the getOutputDirectory() in each Jar Task, set to false otherwise.
abstract org.gradle.api.provider.Property<SchemaGeneratorConfigBuilderProvider>	getSchemaGeneratorConfigBuilderProvider()	The SchemaGeneratorConfigBuilderProvider for the JetOpenApiAnnotationsTask.
abstract org.gradle.api.provider.MapProperty<String,String>	getSchemaGeneratorSimpleTypeMappings()	For the JetOpenApiAnnotationsTask, a Map containing simple type mappings with the fully qualified class name as the key and the raw JSON schema as the value.
abstract org.gradle.api.provider.Property<Boolean>	getSchemaGeneratorUseGsonModule()	For the JetOpenApiAnnotationsTask, set to true to use GsonSchemaModule the, set to false otherwise.
abstract org.gradle.api.provider.Property<Boolean>	getSchemaGeneratorUseJacksonModule()	For the JetOpenApiAnnotationsTask, set to true to use the JacksonSchemaModule, set to false otherwise.
abstract org.gradle.api.provider.Property<Boolean>	getSchemaGeneratorUseNullableModule()	For the JetOpenApiAnnotationsTask, set to true to use the NullableSchemaModule, set to false otherwise.
abstract org.gradle.api.provider.Property<Boolean>	getSchemaGeneratorUseSchemaNameModule()	For the JetOpenApiAnnotationsTask, set to true to use the SchemaNameSchemaModule, set to false otherwise.
abstract org.gradle.api.provider.Property<Boolean>	getSchemaValidation()	For the JetOpenApiAnnotationsTask, set to true to validate the OpenAPI specification JSON output generated from OpenApi annotations using the OpenApi.DEFAULT_$SCHEMA, set to false otherwise.

Methods inherited from class Object

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

Constructor Details

JetOpenApiAnnotationsExtension

public JetOpenApiAnnotationsExtension()

Method Details

getJavaCompileTasks

public abstract org.gradle.api.provider.SetProperty<org.gradle.api.tasks.compile.JavaCompile> getJavaCompileTasks()

The JavaCompile tasks that are used to read compiled class files and classpaths from in JetOpenApiAnnotationsTask.

getSchemaGeneratorConfigBuilderProvider

public abstract org.gradle.api.provider.Property<SchemaGeneratorConfigBuilderProvider> getSchemaGeneratorConfigBuilderProvider()

The SchemaGeneratorConfigBuilderProvider for the JetOpenApiAnnotationsTask.

getSchemaGeneratorUseNullableModule

public abstract org.gradle.api.provider.Property<Boolean> getSchemaGeneratorUseNullableModule()

For the JetOpenApiAnnotationsTask, set to true to use the NullableSchemaModule, set to false otherwise.

Defaults to true.

getSchemaGeneratorUseSchemaNameModule

public abstract org.gradle.api.provider.Property<Boolean> getSchemaGeneratorUseSchemaNameModule()

For the JetOpenApiAnnotationsTask, set to true to use the SchemaNameSchemaModule, set to false otherwise.

Defaults to true.

getSchemaGeneratorUseGsonModule

public abstract org.gradle.api.provider.Property<Boolean> getSchemaGeneratorUseGsonModule()

For the JetOpenApiAnnotationsTask, set to true to use GsonSchemaModule the, set to false otherwise.

Defaults to false.

getSchemaGeneratorUseJacksonModule

public abstract org.gradle.api.provider.Property<Boolean> getSchemaGeneratorUseJacksonModule()

For the JetOpenApiAnnotationsTask, set to true to use the JacksonSchemaModule, set to false otherwise.

Defaults to false.

getSchemaGeneratorSimpleTypeMappings

public abstract org.gradle.api.provider.MapProperty<String,String> getSchemaGeneratorSimpleTypeMappings()

For the JetOpenApiAnnotationsTask, a Map containing simple type mappings with the fully qualified class name as the key and the raw JSON schema as the value.

getGenerateOperationId

public abstract org.gradle.api.provider.Property<JetOpenApiAnnotationsExtension.GenerateOperationId> getGenerateOperationId()

For the JetOpenApiAnnotationsTask, set the JetOpenApiAnnotationsExtension.GenerateOperationId configuration.

Defaults to JetOpenApiAnnotationsExtension.GenerateOperationId.BOTH.

getMoveClassSchemasToComponents

public abstract org.gradle.api.provider.Property<Boolean> getMoveClassSchemasToComponents()

For the JetOpenApiAnnotationsTask, set to true to move the JSON schema generated from OpenApiSchema.fromClass() to OpenApiComponents.schemas(), set to false otherwise.

Defaults to true.

getSchemaValidation

public abstract org.gradle.api.provider.Property<Boolean> getSchemaValidation()

For the JetOpenApiAnnotationsTask, set to true to validate the OpenAPI specification JSON output generated from OpenApi annotations using the OpenApi.DEFAULT_$SCHEMA, set to false otherwise.

Defaults to true.

getOutputDirectory

public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()

The JetOpenApiAnnotationsTask output directory.

getOutputDirectoryIncludeInJar

public abstract org.gradle.api.provider.Property<Boolean> getOutputDirectoryIncludeInJar()

Set to true to include the getOutputDirectory() in each Jar Task, set to false otherwise.

Defaults to true.