Package io.micronaut.projectgen.core.buildtools.gradle

Class Gradle

java.lang.Object

io.micronaut.projectgen.core.buildtools.gradle.Gradle

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, BuildFeature, DefaultFeature, Feature

@Requires(property="micronaut.projectgen.core.features.gradle.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Gradle
extends Object
implements BuildFeature, DefaultFeature

Gradle Feature.

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Gradle()

Method Summary

Modifier and Type	Method	Description
protected void	addGradleInitFiles(ModuleContext module)
protected void	addGradleProperties(ModuleContext module)
protected void	addSettingsFile(BuildTool buildTool, GeneratorContext generatorContext, GradleBuild build, ModuleContext module)
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
protected void	generateBuildFiles(GeneratorContext generatorContext, ModuleContext rootModule)
protected void	generateBuildFiles(GeneratorContext generatorContext, ModuleContext moduleContext, String module)
@NonNull String	getName()	The name of the feature.
boolean	isGradle()
boolean	shouldApply(Options options, Set<Feature> selectedFeatures)	Determines if the feature should be applied to the project.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.projectgen.core.feature.BuildFeature

getOrder, isMaven, isVisible

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getCategory, getDescription, getFrameworkDocumentation, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures, supports

Constructor Details

Gradle

public Gradle()

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

isGradle

public boolean isGradle()

Specified by:

isGradle in interface BuildFeature

generateBuildFiles

protected void generateBuildFiles(GeneratorContext generatorContext,
 ModuleContext rootModule)

Parameters:

generatorContext - Generator Context

generateBuildFiles

protected void generateBuildFiles(GeneratorContext generatorContext,
 ModuleContext moduleContext,
 String module)

addGradleInitFiles

protected void addGradleInitFiles(ModuleContext module)

Parameters:

module - Module

addGradleProperties

protected void addGradleProperties(ModuleContext module)

Parameters:

module - Module

addSettingsFile

protected void addSettingsFile(BuildTool buildTool,
 GeneratorContext generatorContext,
 GradleBuild build,
 ModuleContext module)

Parameters:

buildTool - Gradle Build Tool

generatorContext - Generator Context

build - Gradle Build

shouldApply

public boolean shouldApply(Options options,
 Set<Feature> selectedFeatures)

Description copied from interface: DefaultFeature

Determines if the feature should be applied to the project. Default features do not need to be concerned if the feature was already selected and therefore is already in the list of selected features. The addition to the set is based on the identity of the feature instance and all features are singletons.

Specified by:

shouldApply in interface DefaultFeature

Parameters:

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply