Package io.micronaut.starter.feature.build.gradle

Class Gradle

java.lang.Object

io.micronaut.starter.feature.build.gradle.Gradle

All Implemented Interfaces:

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

@Singleton
public class Gradle
extends Object
implements BuildFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_USER_VERSION_CATALOGUE
protected static final String	DEFAULT_VERSION
protected final GradleBuildCreator	dependencyResolver
protected static final GradlePlugin	GROOVY_GRADLE_PLUGIN
protected final RepositoryResolver	repositoryResolver
protected static final String	WRAPPER_JAR
protected static final String	WRAPPER_PROPS

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Gradle(GradleBuildCreator dependencyResolver, RepositoryResolver repositoryResolver)

Method Summary

Modifier and Type	Method	Description
protected void	addBuildFile(GeneratorContext generatorContext, GradleBuild build)
protected void	addGitignore(GeneratorContext generatorContext)
protected void	addGradleInitFiles(GeneratorContext generatorContext)
protected void	addGradleProperties(GeneratorContext generatorContext)
protected void	addSettingsFile(GeneratorContext generatorContext, GradleBuild build)
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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
protected com.fizzed.rocker.RockerModel	buildFile(GeneratorContext generatorContext, GradleBuild build)
protected GradleBuild	createBuild(GeneratorContext generatorContext)
protected List<GradlePlugin>	extraPlugins(GeneratorContext generatorContext)
protected void	generateNoneMicronautFrameworkBuild(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
protected com.fizzed.rocker.RockerModel	gitignore(GeneratorContext generatorContext)
protected @NonNull List<Property>	gradleProperties(@NonNull GeneratorContext generatorContext)
boolean	isGradle()
boolean	shouldApply(ApplicationType applicationType, 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.starter.feature.build.BuildFeature

getOrder, isMaven, isVisible, supports

Methods inherited from interface io.micronaut.starter.feature.DefaultFeature

getTargetFramework

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

getDescription

Methods inherited from interface io.micronaut.starter.feature.Feature

getCategory, getDescription, getMicronautDocumentation, getThirdPartyDocumentation, getTitle, isCommunity, isPreview, processSelectedFeatures

Field Details

DEFAULT_USER_VERSION_CATALOGUE

public static final boolean DEFAULT_USER_VERSION_CATALOGUE

See Also:

• Constant Field Values

GROOVY_GRADLE_PLUGIN

protected static final GradlePlugin GROOVY_GRADLE_PLUGIN

WRAPPER_JAR

protected static final String WRAPPER_JAR

See Also:

• Constant Field Values

WRAPPER_PROPS

protected static final String WRAPPER_PROPS

See Also:

• Constant Field Values

DEFAULT_VERSION

protected static final String DEFAULT_VERSION

See Also:

• Constant Field Values

dependencyResolver

protected final GradleBuildCreator dependencyResolver

repositoryResolver

protected final RepositoryResolver repositoryResolver

Constructor Details

Gradle

public Gradle(GradleBuildCreator dependencyResolver,
 RepositoryResolver repositoryResolver)

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(ApplicationType, 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. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

generateNoneMicronautFrameworkBuild

protected void generateNoneMicronautFrameworkBuild(GeneratorContext generatorContext)

shouldApply

public boolean shouldApply(ApplicationType applicationType,
 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:

applicationType - The application type

options - The options

selectedFeatures - The features manually selected by the user

Returns:

True if the feature should apply

addGradleInitFiles

protected void addGradleInitFiles(GeneratorContext generatorContext)

extraPlugins

protected List<GradlePlugin> extraPlugins(GeneratorContext generatorContext)

createBuild

protected GradleBuild createBuild(GeneratorContext generatorContext)

addBuildFile

protected void addBuildFile(GeneratorContext generatorContext,
 GradleBuild build)

buildFile

protected com.fizzed.rocker.RockerModel buildFile(GeneratorContext generatorContext,
 GradleBuild build)

addGitignore

protected void addGitignore(GeneratorContext generatorContext)

gitignore

protected com.fizzed.rocker.RockerModel gitignore(GeneratorContext generatorContext)

addGradleProperties

protected void addGradleProperties(GeneratorContext generatorContext)

gradleProperties

@NonNull
protected @NonNull List<Property> gradleProperties(@NonNull
 @NonNull GeneratorContext generatorContext)

addSettingsFile

protected void addSettingsFile(GeneratorContext generatorContext,
 GradleBuild build)

isGradle

public boolean isGradle()

Specified by:

isGradle in interface BuildFeature