org.apache.maven.model.profile
Interface ProfileActivationContext

All Known Implementing Classes:

DefaultProfileActivationContext

public interface ProfileActivationContext

Describes the environmental context used to determine the activation status of profiles.

Author:

Benjamin Bentmann

Method Summary

java.util.List<java.lang.String>	getActiveProfileIds() Gets the identifiers of those profiles that should be activated by explicit demand.
java.util.List<java.lang.String>	getInactiveProfileIds() Gets the identifiers of those profiles that should be deactivated by explicit demand.
java.io.File	getProjectDirectory() Gets the base directory of the current project (if any).
java.util.Properties	getSystemProperties() Gets the system properties to use for interpolation and profile activation.
java.util.Properties	getUserProperties() Gets the user properties to use for interpolation and profile activation.
ProfileActivationContext	setActiveProfileIds(java.util.List<java.lang.String> activeProfileIds) Sets the identifiers of those profiles that should be activated by explicit demand.
ProfileActivationContext	setInactiveProfileIds(java.util.List<java.lang.String> inactiveProfileIds) Sets the identifiers of those profiles that should be deactivated by explicit demand.
ProfileActivationContext	setProjectDirectory(java.io.File projectDirectory) Sets the base directory of the current project.
ProfileActivationContext	setSystemProperties(java.util.Properties executionProperties) Sets the system properties to use for interpolation and profile activation.
ProfileActivationContext	setUserProperties(java.util.Properties userProperties) Sets the user properties to use for interpolation and profile activation.

Method Detail

getActiveProfileIds

java.util.List<java.lang.String> getActiveProfileIds()

Gets the identifiers of those profiles that should be activated by explicit demand.

Returns:

The identifiers of those profiles to activate, never null.

setActiveProfileIds

ProfileActivationContext setActiveProfileIds(java.util.List<java.lang.String> activeProfileIds)

Sets the identifiers of those profiles that should be activated by explicit demand.

Parameters:

activeProfileIds - The identifiers of those profiles to activate, may be null.

Returns:

This context, never null.

getInactiveProfileIds

java.util.List<java.lang.String> getInactiveProfileIds()

Gets the identifiers of those profiles that should be deactivated by explicit demand.

Returns:

The identifiers of those profiles to deactivate, never null.

setInactiveProfileIds

ProfileActivationContext setInactiveProfileIds(java.util.List<java.lang.String> inactiveProfileIds)

Sets the identifiers of those profiles that should be deactivated by explicit demand.

Parameters:

inactiveProfileIds - The identifiers of those profiles to deactivate, may be null.

Returns:

This context, never null.

getSystemProperties

java.util.Properties getSystemProperties()

Gets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.

Returns:

The execution properties, never null.

setSystemProperties

ProfileActivationContext setSystemProperties(java.util.Properties executionProperties)

Sets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.

Parameters:

executionProperties - The execution properties, may be null.

Returns:

This context, never null.

getUserProperties

java.util.Properties getUserProperties()

Gets 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.

Returns:

The user properties, never null.

setUserProperties

ProfileActivationContext setUserProperties(java.util.Properties userProperties)

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 be null.

Returns:

This context, never null.

getProjectDirectory

java.io.File getProjectDirectory()

Gets the base directory of the current project (if any).

Returns:

The base directory of the current project or null if none.

setProjectDirectory

ProfileActivationContext setProjectDirectory(java.io.File projectDirectory)

Sets the base directory of the current project.

Parameters:

projectDirectory - The base directory of the current project, may be null if profile activation happens in the context of metadata retrieval rather than project building.

Returns:

This context, never null.