Package io.micronaut.starter.feature.build.maven

Class Maven

java.lang.Object

io.micronaut.starter.feature.build.maven.Maven

All Implemented Interfaces:

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

@Requires(property="micronaut.starter.feature.maven.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class Maven
extends Object
implements BuildFeature

Field Summary

Fields

Modifier and Type	Field	Description
protected final MavenBuildCreator	dependencyResolver
protected static final String	MAVEN_PREFIX
static final String	MICRONAUT_MAVEN_DOCS_URL
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
Maven(MavenBuildCreator dependencyResolver, RepositoryResolver repositoryResolver)

Method Summary

Modifier and Type	Method	Description
protected void	addGitIgnore(GeneratorContext generatorContext)
protected void	addMavenWrapper(GeneratorContext generatorContext)
protected void	addPom(GeneratorContext generatorContext)
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 MavenBuild	createBuild(GeneratorContext generatorContext)
protected void	generateNoneMicronautFrameworkBuild(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
protected com.fizzed.rocker.RockerModel	gitIgnore(GeneratorContext generatorContext)
boolean	isMaven()
protected com.fizzed.rocker.RockerModel	pom(GeneratorContext generatorContext, MavenBuild mavenBuild)
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, isGradle, 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

MICRONAUT_MAVEN_DOCS_URL

public static final String MICRONAUT_MAVEN_DOCS_URL

See Also:

• Constant Field Values

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

MAVEN_PREFIX

protected static final String MAVEN_PREFIX

See Also:

• Constant Field Values

dependencyResolver

protected final MavenBuildCreator dependencyResolver

repositoryResolver

protected final RepositoryResolver repositoryResolver

Constructor Details

Maven

public Maven(MavenBuildCreator 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)

addMavenWrapper

protected void addMavenWrapper(GeneratorContext generatorContext)

addPom

protected void addPom(GeneratorContext generatorContext)

createBuild

protected MavenBuild createBuild(GeneratorContext generatorContext)

pom

protected com.fizzed.rocker.RockerModel pom(GeneratorContext generatorContext,
 MavenBuild mavenBuild)

addGitIgnore

protected void addGitIgnore(GeneratorContext generatorContext)

gitIgnore

protected com.fizzed.rocker.RockerModel gitIgnore(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

isMaven

public boolean isMaven()

Specified by:

isMaven in interface BuildFeature