Package io.micronaut.sourcegen.annotations

Annotation Interface GenerateGradlePlugin

@Documented
@Retention(CLASS)
@Target(TYPE)
public @interface GenerateGradlePlugin

An annotation that triggers the generation of Gradle plugin and other types. Only single Gradle plugin should be generated. But a plugin may contain more than one task. Each task will have an corresponding extension method.

Since:

1.0.x

Author:

Andriy Dmytruk

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	GenerateGradlePlugin.GenerateGradleTask	A configuration for generating a gradle task as part of the plugin.
static enum	GenerateGradlePlugin.Type	Enum defining the types that could be generated.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
GenerateGradlePlugin.GenerateGradleTask[]	tasks	Configure gradle tasks that will be generated.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	dependency	The coordinate of dependency to add, like io.micronaut.jsonschema:micronaut-jsonschema-generator.
boolean	micronautPlugin
String	namePrefix	The prefix to use for all names.
String	taskGroup
GenerateGradlePlugin.Type[]	types	The types of classes to generate.

Element Details

tasks

GenerateGradlePlugin.GenerateGradleTask[] tasks

Configure gradle tasks that will be generated.

Returns:

gradle task configurations

namePrefix

String namePrefix

The prefix to use for all names. For example if the prefix is Test, task will be generated as TestTask. The default is the annotated class name.

Returns:

The prefix

Default:

""

types

GenerateGradlePlugin.Type[] types

The types of classes to generate. By default, all are generated.

Returns:

The plugin types to generate.

Default:

{GRADLE_TASK, GRADLE_EXTENSION, GRADLE_SPECIFICATION, GRADLE_PLUGIN}

taskGroup

String taskGroup

Returns:

The gradle task group that will be set for all tasks

Default:

""

micronautPlugin

boolean micronautPlugin

Returns:

Whether to extend the micronaut plugin

Default:

true

dependency

String dependency

The coordinate of dependency to add, like io.micronaut.jsonschema:micronaut-jsonschema-generator.

Returns:

The dependency

Default:

""