Package org.apache.maven.enforcer.rules

Class 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 Detail

      • groupIdPattern

        private java.util.regex.Pattern groupIdPattern

      • artifactIdPattern

        private java.util.regex.Pattern artifactIdPattern

      • moduleNameMustMatchArtifactId

        private boolean moduleNameMustMatchArtifactId

      • project

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

    • Constructor Detail

      • RequireMatchingCoordinates

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

    • Method Detail

      • 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
        EnforcerRuleError - in order to brake a build immediately

      • setGroupIdPattern

        public void setGroupIdPattern​(java.lang.String groupIdPattern)

      • setArtifactIdPattern

        public void setArtifactIdPattern​(java.lang.String artifactIdPattern)

      • setModuleNameMustMatchArtifactId

        public void setModuleNameMustMatchArtifactId​(boolean moduleNameMustMatchArtifactId)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object