Package org.codehaus.mojo.extraenforcer.model

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 Details

    • requiredRoles

      private String requiredRoles
      Specify the required roles as comma separated list.

    • validRoles

      private String 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.EnforcerRuleException
      Execute the rule.
      Specified by:
      execute in class org.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

      final Set<String> getRolesFromProject(org.apache.maven.project.MavenProject mavenProject)
      Returns the roles from the POM.
      Parameters:
      mavenProject -
      Returns:
      roles from POM.

    • getRoleName

      protected abstract String getRoleName()
      Returns the rolename.
      Returns:
      rolename.

    • getRoles

      protected abstract List<T> getRoles(org.apache.maven.project.MavenProject mavenProject)
      Returns the roles from the POM.
      Parameters:
      mavenProject -
      Returns:
      the list of Contributors or Developers.

    • getRolesFromString

      Set<String> getRolesFromString(String csRoles)
      Returns the set of required roles from the property.
      Parameters:
      csRoles - comma-separated roles to be split
      Returns:

    • splitCsvToSet

      static Set<String> splitCsvToSet(String csv)

    • setRequiredRoles

      void setRequiredRoles(String requiredRoles)
      Parameters:
      requiredRoles - the requiredRoles to set.

    • setValidRoles

      void setValidRoles(String validRoles)

    • setLog

      public void setLog(org.apache.maven.enforcer.rule.api.EnforcerLogger arg0)
      Specified by:
      setLog in interface org.apache.maven.enforcer.rule.api.EnforcerRuleBase

    • getLog

      public org.apache.maven.enforcer.rule.api.EnforcerLogger getLog()