org.apache.maven.model.profile
Class DefaultProfileActivationContext

java.lang.Object
  org.apache.maven.model.profile.DefaultProfileActivationContext

All Implemented Interfaces:

ProfileActivationContext

public class DefaultProfileActivationContext
extends Object
implements ProfileActivationContext

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

Author:

Benjamin Bentmann

Constructor Summary

DefaultProfileActivationContext()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProfileActivationContext

public DefaultProfileActivationContext()

Method Detail

getActiveProfileIds

public List<String> getActiveProfileIds()

Description copied from interface: ProfileActivationContext

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

Specified by:

getActiveProfileIds in interface ProfileActivationContext

Returns:

The identifiers of those profiles to activate, never null.

setActiveProfileIds

public DefaultProfileActivationContext setActiveProfileIds(List<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

public List<String> getInactiveProfileIds()

Description copied from interface: ProfileActivationContext

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

Specified by:

getInactiveProfileIds in interface ProfileActivationContext

Returns:

The identifiers of those profiles to deactivate, never null.

setInactiveProfileIds

public DefaultProfileActivationContext setInactiveProfileIds(List<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

public Map<String,String> getSystemProperties()

Description copied from interface: ProfileActivationContext

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.

Specified by:

getSystemProperties in interface ProfileActivationContext

Returns:

The execution properties, never null.

setSystemProperties

public DefaultProfileActivationContext setSystemProperties(Properties systemProperties)

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:

systemProperties - The system properties, may be null.

Returns:

This context, never null.

setSystemProperties

public DefaultProfileActivationContext setSystemProperties(Map<String,String> systemProperties)

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:

systemProperties - The system properties, may be null.

Returns:

This context, never null.

getUserProperties

public Map<String,String> getUserProperties()

Description copied from interface: ProfileActivationContext

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.

Specified by:

getUserProperties in interface ProfileActivationContext

Returns:

The user properties, never null.

setUserProperties

public DefaultProfileActivationContext setUserProperties(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.

setUserProperties

public DefaultProfileActivationContext setUserProperties(Map<String,String> 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

public File getProjectDirectory()

Description copied from interface: ProfileActivationContext

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

Specified by:

getProjectDirectory in interface ProfileActivationContext

Returns:

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

setProjectDirectory

public DefaultProfileActivationContext setProjectDirectory(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.