Class AbstractRequireRoles<T extends org.apache.maven.model.Contributor>
java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.codehaus.mojo.extraenforcer.model.AbstractRequireRoles<T>
- All Implemented Interfaces:
org.apache.maven.enforcer.rule.api.EnforcerRuleBase
- Direct Known Subclasses:
RequireContributorRoles
,RequireDeveloperRoles
abstract class AbstractRequireRoles<T extends org.apache.maven.model.Contributor>
extends org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
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()
Execute the rule.org.apache.maven.enforcer.rule.api.EnforcerLogger
getLog()
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.void
setLog
(org.apache.maven.enforcer.rule.api.EnforcerLogger arg0) (package private) void
setRequiredRoles
(String requiredRoles) (package private) void
setValidRoles
(String validRoles) splitCsvToSet
(String csv) Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel
-
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. -
project
private final org.apache.maven.project.MavenProject project
-
-
Constructor Details
-
AbstractRequireRoles
AbstractRequireRoles(org.apache.maven.project.MavenProject project)
-
-
Method Details
-
execute
public void execute() throws org.apache.maven.enforcer.rule.api.EnforcerRuleExceptionExecute the rule.- Specified by:
execute
in classorg.apache.maven.enforcer.rule.api.AbstractEnforcerRule
- 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
-
setRequiredRoles
- Parameters:
requiredRoles
- the requiredRoles to set.
-
setValidRoles
-
setLog
public void setLog(org.apache.maven.enforcer.rule.api.EnforcerLogger arg0) - Specified by:
setLog
in interfaceorg.apache.maven.enforcer.rule.api.EnforcerRuleBase
-
getLog
public org.apache.maven.enforcer.rule.api.EnforcerLogger getLog()
-