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.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	all	If all profiles must be active.
private java.lang.String	profiles	Comma separated list of profiles to check.
private org.apache.maven.project.MavenProject	project

Constructor Summary

Constructors

Constructor	Description
RequireActiveProfile(org.apache.maven.project.MavenProject project)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

profiles

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

RequireActiveProfile

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

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 class AbstractEnforcerRule

Throws:

EnforcerRuleException - the enforcer rule exception

EnforcerRuleError - 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 project

profileId - the profile name

Returns:

true if profile is active, otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object