Class DefaultProfileActivationContext
java.lang.Object
org.apache.maven.internal.impl.model.DefaultProfileActivationContext
- All Implemented Interfaces:
ProfileActivationContext
Describes the environmental context used to determine the activation status of profiles.
-
Constructor Summary
ConstructorDescriptionDefaultProfileActivationContext
(PathTranslator pathTranslator, RootLocator rootLocator, Interpolator interpolator) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if a file or directory matching the given glob pattern exists at the specified path.Gets the artifactId from the current model.Gets the base directory of the current model.Gets the packaging type from the current model.getModelProperty
(String key) Gets the model property to use for interpolation and profile activation.Gets the root directory of the current model.getSystemProperty
(String key) Gets the system property to use for interpolation and profile activation.getUserProperty
(String key) Gets the user property to use for interpolation and profile activation.interpolatePath
(String path) Interpolates the given path string using the current context's properties.boolean
isProfileActive
(String profileId) Checks if the specified profile has been explicitly activated.boolean
isProfileInactive
(String profileId) Checks if the specified profile has been explicitly deactivated.setActiveProfileIds
(List<String> activeProfileIds) Sets the identifiers of those profiles that should be activated by explicit demand.setInactiveProfileIds
(List<String> inactiveProfileIds) Sets the identifiers of those profiles that should be deactivated by explicit demand.setSystemProperties
(Map<String, String> systemProperties) Sets the system properties to use for interpolation and profile activation.setUserProperties
(Map<String, String> userProperties) Sets the user properties to use for interpolation and profile activation.
-
Constructor Details
-
DefaultProfileActivationContext
public DefaultProfileActivationContext(PathTranslator pathTranslator, RootLocator rootLocator, Interpolator interpolator)
-
-
Method Details
-
isProfileActive
Description copied from interface:ProfileActivationContext
Checks if the specified profile has been explicitly activated.- Specified by:
isProfileActive
in interfaceProfileActivationContext
- Parameters:
profileId
- the profile id- Returns:
- whether the profile has been activated
-
setActiveProfileIds
Sets the identifiers of those profiles that should be activated by explicit demand.- Parameters:
activeProfileIds
- The identifiers of those profiles to activate, may benull
.- Returns:
- This context, never
null
.
-
isProfileInactive
Description copied from interface:ProfileActivationContext
Checks if the specified profile has been explicitly deactivated.- Specified by:
isProfileInactive
in interfaceProfileActivationContext
- Parameters:
profileId
- the profile id- Returns:
- whether the profile has been deactivated
-
setInactiveProfileIds
Sets the identifiers of those profiles that should be deactivated by explicit demand.- Parameters:
inactiveProfileIds
- The identifiers of those profiles to deactivate, may benull
.- Returns:
- This context, never
null
.
-
getSystemProperty
Description copied from interface:ProfileActivationContext
Gets the system property to use for interpolation and profile activation. The system properties are collected from the runtime environment likeSystem.getProperties()
and environment variables.- Specified by:
getSystemProperty
in interfaceProfileActivationContext
- Parameters:
key
- the name of the system property- Returns:
- the system property for the specified key, or
null
-
setSystemProperties
Sets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment likeSystem.getProperties()
and environment variables.- Parameters:
systemProperties
- The system properties, may benull
.- Returns:
- This context, never
null
.
-
getUserProperty
Description copied from interface:ProfileActivationContext
Gets the user property to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the-Dkey=value
parameter on the command line.- Specified by:
getUserProperty
in interfaceProfileActivationContext
- Parameters:
key
- the name of the user property- Returns:
- The user property for the specified key, or
null
.
-
setUserProperties
Sets the user properties to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the-Dkey=value
parameter on the command line.- Parameters:
userProperties
- The user properties, may benull
.- Returns:
- This context, never
null
.
-
getModelArtifactId
Description copied from interface:ProfileActivationContext
Gets the artifactId from the current model.- Specified by:
getModelArtifactId
in interfaceProfileActivationContext
- Returns:
- The artifactId of the current model, or
null
if not set.
-
getModelPackaging
Description copied from interface:ProfileActivationContext
Gets the packaging type from the current model.- Specified by:
getModelPackaging
in interfaceProfileActivationContext
- Returns:
- The packaging type of the current model, or
null
if not set.
-
getModelProperty
Description copied from interface:ProfileActivationContext
Gets the model property to use for interpolation and profile activation.- Specified by:
getModelProperty
in interfaceProfileActivationContext
- Parameters:
key
- the name of the model property- Returns:
- The model property for the specified key, or
null
;
-
getModelBaseDirectory
Description copied from interface:ProfileActivationContext
Gets the base directory of the current model.- Specified by:
getModelBaseDirectory
in interfaceProfileActivationContext
- Returns:
- The base directory path of the current model, or
null
if not set.
-
getModelRootDirectory
Description copied from interface:ProfileActivationContext
Gets the root directory of the current model.- Specified by:
getModelRootDirectory
in interfaceProfileActivationContext
- Returns:
- The root directory path of the current model, or
null
if not set.
-
setModel
-
interpolatePath
Description copied from interface:ProfileActivationContext
Interpolates the given path string using the current context's properties.- Specified by:
interpolatePath
in interfaceProfileActivationContext
- Parameters:
path
- The path string to interpolate- Returns:
- The interpolated path string
- Throws:
InterpolatorException
- if an error occurs during interpolation
-
exists
Description copied from interface:ProfileActivationContext
Checks if a file or directory matching the given glob pattern exists at the specified path.- Specified by:
exists
in interfaceProfileActivationContext
- Parameters:
path
- the base path to checkenableGlob
- whether the path can be a glob expression- Returns:
true
if a matching file exists,false
otherwise- Throws:
ModelBuilderException
- if an error occurs while checking the path
-