org.apache.maven.plugins.enforcer

Class RequireActiveProfile

java.lang.Object

org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

org.apache.maven.plugins.enforcer.RequireActiveProfile

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule

public class RequireActiveProfile
extends AbstractNonCacheableEnforcerRule

This rule checks that some profiles are active.

Author:

Brian Fox

Field Summary

Fields

Modifier and Type	Field and Description
boolean	all Deprecated. the visibility will be reduced to private with the next major version
String	profiles Deprecated. the visibility will be reduced to private with the next major version

Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

message

Constructor Summary

Constructors

Constructor and Description
RequireActiveProfile()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper theHelper)
String	getProfiles()
boolean	isAll()
protected boolean	isProfileActive(org.apache.maven.project.MavenProject project, String profileName) Checks if profile is active.
void	setAll(boolean all)
void	setProfiles(String profiles)

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule

getCacheId, isCacheable, isResultValid

Methods inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule

getMessage, setMessage

Methods inherited from class java.lang.Object

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

Field Detail

profiles

public String profiles

Deprecated. the visibility will be reduced to private with the next major version

Comma separated list of profiles to check.

See Also:

#setProfiles(String)}, #getProfiles()}

all

public boolean all

Deprecated. the visibility will be reduced to private with the next major version

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

See Also:

#setAll(boolean)}, #isAll()}

Constructor Detail

RequireActiveProfile

public RequireActiveProfile()

Method Detail

getProfiles

public final String getProfiles()

setProfiles

public final void setProfiles(String profiles)

isAll

public final boolean isAll()

setAll

public final void setAll(boolean all)

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper theHelper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException

isProfileActive

protected boolean isProfileActive(org.apache.maven.project.MavenProject project,
                      String profileName)

Checks if profile is active.

Parameters:

project - the project

profileName - the profile name

Returns:

true if profile is active, otherwise false