Package io.micronaut.starter.feature.buildtools.maven

Class EnforcerPlugin

java.lang.Object
io.micronaut.starter.feature.buildtools.maven.EnforcerPlugin
All Implemented Interfaces:
io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, DefaultFeature, Feature, OpenRewriteFeature
@Requires(property="micronaut.starter.feature.maven.enforcer.plugin.enabled", value="true", defaultValue="true") @Singleton public class EnforcerPlugin extends Object implements DefaultFeature, OpenRewriteFeature
Adds the Maven Enforcer plugin to control environmental constraints such as Maven version, JDK version, OS family, and supports built-in and custom rules.

  • Constructor Details

    • EnforcerPlugin

      public EnforcerPlugin()

  • 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

      public String getTitle()
      Specified by:
      getTitle in interface Feature
      Returns:
      The title of the feature

    • isVisible

      public boolean isVisible()
      Description copied from interface: Feature
      Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
      Specified by:
      isVisible in interface Feature
      Returns:
      True if the feature should be able to be selected by the user

    • getDescription

      @NonNull public @NonNull String getDescription()
      Specified by:
      getDescription in interface io.micronaut.core.naming.Described
      Specified by:
      getDescription in interface Feature

    • getCategory

      public String getCategory()
      Specified by:
      getCategory in interface Feature
      Returns:
      The Category to which the feature belongs to.

    • getRecipes

      public List<String> getRecipes(GeneratorContext generatorContext)
      Specified by:
      getRecipes in interface OpenRewriteFeature

    • 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