Package org.apache.maven.enforcer.rules
Class RequireActiveProfile
- java.lang.Object
-
- org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
-
- 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.
-
-
Constructor Summary
Constructors Constructor Description RequireActiveProfile(org.apache.maven.project.MavenProject project)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
This is the interface into the rule.java.lang.String
getProfiles()
boolean
isAll()
private boolean
isProfileActive(org.apache.maven.project.MavenProject project, java.lang.String profileId)
Checks if profile is active.void
setAll(boolean all)
void
setProfiles(java.lang.String profiles)
java.lang.String
toString()
-
Methods inherited from class org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule
formatLocation, getMessage, setMessage
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRule
getCacheId, getLevel, getRuleName
-
Methods inherited from class org.apache.maven.enforcer.rule.api.AbstractEnforcerRuleBase
getLog, setLog
-
-
-
-
Method Detail
-
getProfiles
public java.lang.String getProfiles()
-
setProfiles
public void setProfiles(java.lang.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 classAbstractEnforcerRule
- Throws:
EnforcerRuleException
- the enforcer rule exceptionEnforcerRuleError
- in order to brake a build immediately
-
isProfileActive
private boolean isProfileActive(org.apache.maven.project.MavenProject project, java.lang.String profileId)
Checks if profile is active.- Parameters:
project
- the projectprofileId
- the profile name- Returns:
true
if profile is active, otherwisefalse
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-