Package org.apache.maven.model.profile.activation

Class FileProfileActivator

java.lang.Object

org.apache.maven.model.profile.activation.FileProfileActivator

All Implemented Interfaces:

ProfileActivator

@Named("file")
@Singleton
public class FileProfileActivator
extends java.lang.Object
implements ProfileActivator

Determines profile activation based on the existence/absence of some file. File name interpolation support is limited to ${basedir} (since Maven 3, see MNG-2363), System properties and request properties. ${project.basedir} is intentionally not supported as this form would suggest that other ${project.*} expressions can be used, which is however beyond the design.

See Also:

ActivationFile, DefaultModelValidator.validateRawModel(org.apache.maven.model.Model, org.apache.maven.model.building.ModelBuildingRequest, org.apache.maven.model.building.ModelProblemCollector)

Field Summary

Fields

Modifier and Type	Field	Description
private PathTranslator	pathTranslator

Constructor Summary

Constructors

Constructor	Description
FileProfileActivator()

Method Summary

Modifier and Type	Method	Description
boolean	isActive(Profile profile, ProfileActivationContext context, ModelProblemCollector problems)	Determines whether the specified profile is active in the given activator context.
boolean	presentInConfig(Profile profile, ProfileActivationContext context, ModelProblemCollector problems)	Determines whether specified activation method is present in configuration or not.
FileProfileActivator	setPathTranslator(PathTranslator pathTranslator)

Methods inherited from class java.lang.Object

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

Field Detail

pathTranslator

@Inject
private PathTranslator pathTranslator

Constructor Detail

FileProfileActivator

public FileProfileActivator()

Method Detail

setPathTranslator

public FileProfileActivator setPathTranslator(PathTranslator pathTranslator)

isActive

public boolean isActive(Profile profile,
                        ProfileActivationContext context,
                        ModelProblemCollector problems)

Description copied from interface: ProfileActivator

Determines whether the specified profile is active in the given activator context.

Specified by:

isActive in interface ProfileActivator

Parameters:

profile - The profile whose activation status should be determined, must not be null.

context - The environmental context used to determine the activation status of the profile, must not be null.

problems - The container used to collect problems (e.g. bad syntax) that were encountered, must not be null.

Returns:

true if the profile is active, false otherwise.

presentInConfig

public boolean presentInConfig(Profile profile,
                               ProfileActivationContext context,
                               ModelProblemCollector problems)

Description copied from interface: ProfileActivator

Determines whether specified activation method is present in configuration or not. It should help to have AND between activation conditions Need for solving https://issues.apache.org/jira/browse/MNG-4565

Specified by:

presentInConfig in interface ProfileActivator

Parameters:

profile - The profile whose activation status should be determined, must not be null.

context - The environmental context used to determine the activation status of the profile, must not be null.

problems - The container used to collect problems (e.g. bad syntax) that were encountered, must not be null.

Returns:

true if the profile is active, false otherwise.