Package io.micronaut.starter.feature.buildtools

Class GradleEnterprise

java.lang.Object

io.micronaut.starter.feature.buildtools.GradleEnterprise

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, GradleEnterpriseConfiguration

Direct Known Subclasses:

MicronautGradleEnterprise

@Requires(property="micronaut.starter.feature.gradle.enterprise.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class GradleEnterprise
extends Object
implements Feature, GradleEnterpriseConfiguration

Feature to add Gradle Enterprise plugin support, enabling integration with Gradle Enterprise and scans.gradle.com.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GRADLE_ENTERPRISE_ARTIFACT_ID
static final String	GRADLE_ENTERPRISE_PLUGIN_ID

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
GradleEnterprise()

Method Summary

Modifier and Type	Method	Description
protected void	addMavenTemplate(GeneratorContext generatorContext, String name, com.fizzed.rocker.RockerModel rockerModel)	Adds a Maven template to the root module using the given name and RockerModel.
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	applyMaven(GeneratorContext generatorContext, GradleEnterpriseConfiguration server)	Applies the necessary Maven templates to enable Gradle Enterprise support.
String	getCategory()
@NonNull String	getDescription()
@NonNull String	getName()	The name of the feature.
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
@NonNull String	getTitle()
protected GradlePlugin	gradlePlugin(GradleEnterpriseConfiguration configuration)	Creates a GradlePlugin instance configured with the Gradle Enterprise plugin.

Methods inherited from class java.lang.Object

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

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

getDescription

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

getFrameworkDocumentation, getOrder, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Methods inherited from interface io.micronaut.starter.feature.buildtools.GradleEnterpriseConfiguration

aggreeWithTermsOfService, allowTrustedServer, getServer, getTermsOfServiceUrl

Field Details

GRADLE_ENTERPRISE_PLUGIN_ID

public static final String GRADLE_ENTERPRISE_PLUGIN_ID

See Also:

• Constant Field Values

GRADLE_ENTERPRISE_ARTIFACT_ID

public static final String GRADLE_ENTERPRISE_ARTIFACT_ID

See Also:

• Constant Field Values

Constructor Details

GradleEnterprise

public GradleEnterprise()

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

getTitle

@NonNull
public @NonNull String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface 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

gradlePlugin

protected GradlePlugin gradlePlugin(GradleEnterpriseConfiguration configuration)

Creates a GradlePlugin instance configured with the Gradle Enterprise plugin.

Parameters:

configuration - The Gradle Enterprise configuration to apply.

Returns:

A GradlePlugin configured with the Gradle Enterprise plugin.

applyMaven

protected void applyMaven(GeneratorContext generatorContext,
 GradleEnterpriseConfiguration server)

Applies the necessary Maven templates to enable Gradle Enterprise support.

Parameters:

generatorContext - The generator context containing the project state.

server - The Gradle Enterprise configuration to use for the templates.

addMavenTemplate

protected void addMavenTemplate(GeneratorContext generatorContext,
 String name,
 com.fizzed.rocker.RockerModel rockerModel)

Adds a Maven template to the root module using the given name and RockerModel.

Parameters:

generatorContext - The generator context containing the project state.

name - The name of the template file.

rockerModel - The rocker model used to generate the template content.

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org