org.apache.maven.plugins.enforcer
Class RequireActiveProfile

java.lang.Object
  extended by org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
      extended by org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
          extended by org.apache.maven.plugins.enforcer.RequireActiveProfile
All Implemented Interfaces:
EnforcerRule

public class RequireActiveProfile
extends AbstractNonCacheableEnforcerRule

This rule checks that some profiles are active.

Author:
Brian Fox

Field Summary
 boolean all
          If all profiles must be active.
 java.lang.String profiles
          Comma separated list of profiles to check.
 
Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
message
 
Constructor Summary
RequireActiveProfile()
           
 
Method Summary
 void execute(EnforcerRuleHelper theHelper)
          This is the interface into the rule.
protected  boolean isProfileActive(org.apache.maven.project.MavenProject project, java.lang.String profileName)
          Checks if profile is active.
 
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

profiles

public java.lang.String profiles
Comma separated list of profiles to check.


all

public boolean all
If all profiles must be active. If false, only one must be active

Constructor Detail

RequireActiveProfile

public RequireActiveProfile()
Method Detail

execute

public void execute(EnforcerRuleHelper theHelper)
             throws EnforcerRuleException
Description copied from interface: EnforcerRule
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 if it should stop or just log the message as a warning.

Parameters:
theHelper - The helper provides access to the log, MavenSession and has helpers to get common components. It is also able to lookup components by class name.
Throws:
EnforcerRuleException - the enforcer rule exception

isProfileActive

protected boolean isProfileActive(org.apache.maven.project.MavenProject project,
                                  java.lang.String profileName)
Checks if profile is active.

Parameters:
project - the project
profileName - the profile name
Returns:
true if profile is active


Copyright © 2007-2012 Apache Software Foundation. All Rights Reserved.