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, DefaultFeature, Feature
@Requires(property="micronaut.starter.feature.maven.enabled", value="true", defaultValue="true") @Singleton public class Maven extends Object implements BuildFeature, DefaultFeature
Maven Feature.

  • Field Details

  • Constructor Details

  • Method Details

    • getOrder

      public int getOrder()
      Description copied from interface: Feature
      The order of a feature controls the order in which it applies. The order of a feature is important to ensure that any previous work done by other features that may be required is done. See FeaturePhase for a list of phases to choose from.
      Specified by:
      getOrder in interface BuildFeature
      Specified by:
      getOrder in interface Feature
      Specified by:
      getOrder in interface io.micronaut.core.order.Ordered
      Returns:
      The order of the feature

    • 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.
      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(ModuleContext moduleContext, Options options)
      Parameters:
      moduleContext - Generator Context
      options - Options
      Returns:
      Maven Build

    • shouldApply

      public boolean shouldApply(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:
      options - The options
      selectedFeatures - The features manually selected by the user
      Returns:
      True if the feature should apply