Class AbstractRequireRoles<T extends org.apache.maven.model.Contributor>
java.lang.Object
org.apache.maven.plugins.enforcer.AbstractMojoHausEnforcerRule
org.apache.maven.plugins.enforcer.AbstractRequireRoles<T>
- All Implemented Interfaces:
org.apache.maven.enforcer.rule.api.EnforcerRule
,org.apache.maven.enforcer.rule.api.EnforcerRule2
- Direct Known Subclasses:
RequireContributorRoles
,RequireDeveloperRoles
abstract class AbstractRequireRoles<T extends org.apache.maven.model.Contributor>
extends AbstractMojoHausEnforcerRule
This rule checks that certain roles are filled.
- Since:
- 1.0-alpha-3
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
checkRequiredRoles
(Set<String> requiredRolesSet, Set<String> rolesFromProject) private void
checkValidRoles
(Set<String> requiredRolesSet, Set<String> rolesFromProject) void
execute
(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Execute the rule.(package private) org.apache.maven.project.MavenProject
getMavenProject
(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) Extracted for easier testability.protected abstract String
Returns the rolename.getRoles
(org.apache.maven.project.MavenProject mavenProject) Returns the roles from the POM.getRolesFromProject
(org.apache.maven.project.MavenProject mavenProject) Returns the roles from the POM.getRolesFromString
(String csRoles) Returns the set of required roles from the property.boolean
boolean
isResultValid
(org.apache.maven.enforcer.rule.api.EnforcerRule cachedRule) (package private) void
setRequiredRoles
(String requiredRoles) (package private) void
setValidRoles
(String validRoles) splitCsvToSet
(String csv) Methods inherited from class org.apache.maven.plugins.enforcer.AbstractMojoHausEnforcerRule
getLevel, setLevel
-
Field Details
-
requiredRoles
Specify the required roles as comma separated list. -
validRoles
Specify the allowed roles as comma separated list. These are combined with the requiredRoles.
-
-
Constructor Details
-
AbstractRequireRoles
AbstractRequireRoles()
-
-
Method Details
-
execute
public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) throws org.apache.maven.enforcer.rule.api.EnforcerRuleException Execute the rule.- Parameters:
helper
- the helper- Throws:
org.apache.maven.enforcer.rule.api.EnforcerRuleException
- the enforcer rule exception
-
checkRequiredRoles
private void checkRequiredRoles(Set<String> requiredRolesSet, Set<String> rolesFromProject) throws org.apache.maven.enforcer.rule.api.EnforcerRuleException - Throws:
org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
checkValidRoles
private void checkValidRoles(Set<String> requiredRolesSet, Set<String> rolesFromProject) throws org.apache.maven.enforcer.rule.api.EnforcerRuleException - Throws:
org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
getRolesFromProject
Returns the roles from the POM.- Parameters:
mavenProject
-- Returns:
- roles from POM.
-
getRoleName
Returns the rolename.- Returns:
- rolename.
-
getRoles
Returns the roles from the POM.- Parameters:
mavenProject
-- Returns:
- the list of
Contributor
s orDeveloper
s.
-
getRolesFromString
Returns the set of required roles from the property.- Parameters:
csRoles
- comma-separated roles to be split- Returns:
-
splitCsvToSet
-
getMavenProject
org.apache.maven.project.MavenProject getMavenProject(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper) throws org.apache.maven.enforcer.rule.api.EnforcerRuleException Extracted for easier testability.- Parameters:
helper
-- Returns:
- the MavenProject enforcer is running on.
- Throws:
org.apache.maven.enforcer.rule.api.EnforcerRuleException
-
setRequiredRoles
- Parameters:
requiredRoles
- the requiredRoles to set.
-
setValidRoles
-
getCacheId
-
isCacheable
public boolean isCacheable() -
isResultValid
public boolean isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule cachedRule)
-