Package io.micronaut.projectgen.core.buildtools.maven

Class Maven

java.lang.Object

io.micronaut.projectgen.core.buildtools.maven.Maven

All Implemented Interfaces:

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

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

Maven Feature.

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	addMavenWrapper(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(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	generatePom(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
boolean	isMaven()

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, isGradle, isVisible

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

getDescription

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

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

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(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

isMaven

public boolean isMaven()

Specified by:

isMaven in interface BuildFeature

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

generatePom

protected void generatePom(GeneratorContext generatorContext)

Parameters:

generatorContext - Generator Context

addMavenWrapper

protected void addMavenWrapper(GeneratorContext generatorContext)

Parameters:

generatorContext - Generator Context

createBuild

protected MavenBuild createBuild(GeneratorContext generatorContext)

Parameters:

generatorContext - Generator Context

Returns:

Maven Build