Class RequireActiveProfile

All Implemented Interfaces:
EnforcerRuleBase

@Named("requireActiveProfile") public final class RequireActiveProfile extends AbstractStandardEnforcerRule
This rule checks that some profiles are active.
  • Field Details

    • profiles

      private String profiles
      Comma separated list of profiles to check.
    • all

      private boolean all
      If all profiles must be active. If false, only one must be active
    • project

      private final org.apache.maven.project.MavenProject project
  • 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
    • isProfileActive

      private boolean isProfileActive(org.apache.maven.project.MavenProject project, String profileId)
      Checks if profile is active.
      Parameters:
      project - the project
      profileId - the profile name
      Returns:
      true if profile is active, otherwise false
    • toString

      public String toString()
      Overrides:
      toString in class Object