Package org.apache.maven.enforcer.rules
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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
This is the interface into the rule.void
setArtifactIdPattern
(String artifactIdPattern) void
setGroupIdPattern
(String groupIdPattern) void
setModuleNameMustMatchArtifactId
(boolean moduleNameMustMatchArtifactId) toString()
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
Field Details
-
groupIdPattern
-
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
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 classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exception
-
setGroupIdPattern
-
setArtifactIdPattern
-
setModuleNameMustMatchArtifactId
public void setModuleNameMustMatchArtifactId(boolean moduleNameMustMatchArtifactId) -
toString
-