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

@Singleton
public class Maven
extends java.lang.Object
implements BuildFeature

Field Summary

Fields

Modifier and Type	Field and Description
protected MavenBuildCreator	dependencyResolver
protected static java.lang.String	MAVEN_PREFIX
protected static java.lang.String	WRAPPER_DOWNLOADER
protected static java.lang.String	WRAPPER_JAR
protected static java.lang.String	WRAPPER_PROPS

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
Maven(MavenBuildCreator dependencyResolver)

Method Summary

Modifier and Type	Method and 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)
java.lang.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, java.util.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.Feature

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

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

getDescription

Field Detail

WRAPPER_JAR

protected static final java.lang.String WRAPPER_JAR

See Also:

Constant Field Values

WRAPPER_PROPS

protected static final java.lang.String WRAPPER_PROPS

See Also:

Constant Field Values

WRAPPER_DOWNLOADER

protected static final java.lang.String WRAPPER_DOWNLOADER

See Also:

Constant Field Values

MAVEN_PREFIX

protected static final java.lang.String MAVEN_PREFIX

See Also:

Constant Field Values

dependencyResolver

protected final MavenBuildCreator dependencyResolver

Constructor Detail

Maven

public Maven(MavenBuildCreator dependencyResolver)

Method Detail

getName

@NonNull
public java.lang.String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

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

Specified by:

getName in interface Feature

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

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,
                           java.util.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