Class RequireMatchingCoordinates

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.RequireMatchingCoordinates
All Implemented Interfaces:
EnforcerRuleBase
@Named("requireMatchingCoordinates") public final class RequireMatchingCoordinates extends AbstractStandardEnforcerRule
This rule checks that the Maven coordinates (i.e. the project's groupId and artifactId) each match a given pattern.
Since:
3.5.0

  • Field Details

    • groupIdPattern

      private Pattern groupIdPattern

    • artifactIdPattern

      private Pattern artifactIdPattern

    • moduleNameMustMatchArtifactId

      private boolean moduleNameMustMatchArtifactId

    • project

      private final org.apache.maven.project.MavenProject project

  • Constructor Details

    • RequireMatchingCoordinates

      @Inject public RequireMatchingCoordinates(org.apache.maven.project.MavenProject project)

  • Method Details

    • execute

      public void execute() throws EnforcerRuleException
      Description copied from class: AbstractEnforcerRule
      This is the interface into the rule. This method should throw an exception containing a reason message if the rule fails the check. The plugin will then decide based on the fail flag and rule level if it should stop or just log the message as a warning.
      Specified by:
      execute in class AbstractEnforcerRule
      Throws:
      EnforcerRuleException - the enforcer rule exception

    • setGroupIdPattern

      public void setGroupIdPattern(String groupIdPattern)

    • setArtifactIdPattern

      public void setArtifactIdPattern(String artifactIdPattern)

    • setModuleNameMustMatchArtifactId

      public void setModuleNameMustMatchArtifactId(boolean moduleNameMustMatchArtifactId)

    • toString

      public String toString()
      Overrides:
      toString in class Object