Class RequireActiveProfile

java.lang.Object
org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
org.apache.maven.enforcer.rules.RequireActiveProfile
All Implemented Interfaces:
EnforcerRuleBase
@Named("requireActiveProfile") public final class RequireActiveProfile extends AbstractStandardEnforcerRule
This rule checks that some profiles are active.
Author:
Brian Fox

  • Constructor Details

    • RequireActiveProfile

      @Inject public RequireActiveProfile(org.apache.maven.project.MavenProject project)

  • Method Details

    • getProfiles

      public String getProfiles()

    • setProfiles

      public void setProfiles(String profiles)

    • isAll

      public boolean isAll()

    • setAll

      public void setAll(boolean all)

    • 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 class AbstractEnforcerRule
      Throws:
      EnforcerRuleException - the enforcer rule exception

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setLog

      public void setLog(EnforcerLogger log)
      Used by EnforcerMojo to inject logger instance
      Specified by:
      setLog in interface EnforcerRuleBase
      Parameters:
      log - an EnforcerLogger instance

    • getLog

      public EnforcerLogger getLog()
      Provide an EnforcerLogger instance for Rule

      NOTICE A logger is not available in constructors.

      Returns:
      an EnforcerLogger instance