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'sgroupId
andartifactId
) each match a given pattern.- Since:
- 3.5.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.regex.Pattern
artifactIdPattern
private java.util.regex.Pattern
groupIdPattern
private boolean
moduleNameMustMatchArtifactId
private org.apache.maven.project.MavenProject
project
-
Constructor Summary
Constructors Constructor Description RequireMatchingCoordinates(org.apache.maven.project.MavenProject project)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
This is the interface into the rule.void
setArtifactIdPattern(java.lang.String artifactIdPattern)
void
setGroupIdPattern(java.lang.String groupIdPattern)
void
setModuleNameMustMatchArtifactId(boolean moduleNameMustMatchArtifactId)
java.lang.String
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, getRuleName
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
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 classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- 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 classjava.lang.Object
-
-