Class AbstractRequireRoles<T extends org.apache.maven.model.Contributor>

  • 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 
      Modifier and Type Field Description
      private org.apache.maven.project.MavenProject project  
      private java.lang.String requiredRoles
      Specify the required roles as comma separated list.
      private java.lang.String validRoles
      Specify the allowed roles as comma separated list.
    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractRequireRoles​(org.apache.maven.project.MavenProject project)  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      private void checkRequiredRoles​(java.util.Set<java.lang.String> requiredRolesSet, java.util.Set<java.lang.String> rolesFromProject)  
      private void checkValidRoles​(java.util.Set<java.lang.String> requiredRolesSet, java.util.Set<java.lang.String> rolesFromProject)  
      void execute()
      Execute the rule.
      org.apache.maven.enforcer.rule.api.EnforcerLogger getLog()  
      protected abstract java.lang.String getRoleName()
      Returns the rolename.
      protected abstract java.util.List<T> getRoles​(org.apache.maven.project.MavenProject mavenProject)
      Returns the roles from the POM.
      (package private) java.util.Set<java.lang.String> getRolesFromProject​(org.apache.maven.project.MavenProject mavenProject)
      Returns the roles from the POM.
      (package private) java.util.Set<java.lang.String> getRolesFromString​(java.lang.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​(java.lang.String requiredRoles)  
      (package private) void setValidRoles​(java.lang.String validRoles)  
      (package private) static java.util.Set<java.lang.String> splitCsvToSet​(java.lang.String csv)  
      • Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule

        getCacheId, getLevel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • requiredRoles

        private java.lang.String requiredRoles
        Specify the required roles as comma separated list.
      • validRoles

        private java.lang.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 Detail

      • AbstractRequireRoles

        AbstractRequireRoles​(org.apache.maven.project.MavenProject project)
    • Method Detail

      • 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​(java.util.Set<java.lang.String> requiredRolesSet,
                                        java.util.Set<java.lang.String> rolesFromProject)
                                 throws org.apache.maven.enforcer.rule.api.EnforcerRuleException
        Throws:
        org.apache.maven.enforcer.rule.api.EnforcerRuleException
      • checkValidRoles

        private void checkValidRoles​(java.util.Set<java.lang.String> requiredRolesSet,
                                     java.util.Set<java.lang.String> rolesFromProject)
                              throws org.apache.maven.enforcer.rule.api.EnforcerRuleException
        Throws:
        org.apache.maven.enforcer.rule.api.EnforcerRuleException
      • getRolesFromProject

        final java.util.Set<java.lang.String> getRolesFromProject​(org.apache.maven.project.MavenProject mavenProject)
        Returns the roles from the POM.
        Parameters:
        mavenProject -
        Returns:
        roles from POM.
      • getRoleName

        protected abstract java.lang.String getRoleName()
        Returns the rolename.
        Returns:
        rolename.
      • getRoles

        protected abstract java.util.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

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

        static java.util.Set<java.lang.String> splitCsvToSet​(java.lang.String csv)
      • setRequiredRoles

        void setRequiredRoles​(java.lang.String requiredRoles)
        Parameters:
        requiredRoles - the requiredRoles to set.
      • setValidRoles

        void setValidRoles​(java.lang.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()