org.apache.maven.execution

Class ProjectActivation

java.lang.Object

org.apache.maven.execution.ProjectActivation

public class ProjectActivation
extends Object

Container for storing the request from the user to activate or deactivate certain projects and optionally fail the build if those projects do not exist.

Constructor Summary

Constructors

Constructor and Description
ProjectActivation()

Method Summary

Modifier and Type	Method and Description
void	activateOptionalProject(String selector) Mark a project as optional and activated.
void	activateRequiredProject(String selector) Mark a project as required and activated.
void	addProjectActivation(String selector, boolean active, boolean optional) Adds a project activation to the request.
void	deactivateOptionalProject(String selector) Mark a project as optional and deactivated.
void	deactivateRequiredProject(String selector) Mark a project as required and deactivated.
List<String>	getExcludedProjects() Deprecated. Use getRequiredInactiveProjectSelectors() and getOptionalInactiveProjectSelectors() instead.
Set<String>	getOptionalActiveProjectSelectors()
Set<String>	getOptionalInactiveProjectSelectors()
Set<String>	getRequiredActiveProjectSelectors()
Set<String>	getRequiredInactiveProjectSelectors()
List<String>	getSelectedProjects() Deprecated. Use getRequiredActiveProjectSelectors() and getOptionalActiveProjectSelectors() instead.
boolean	isEmpty()
void	overwriteActiveProjects(List<String> activeProjectSelectors) Deprecated. Use activateOptionalProject(String) or activateRequiredProject(String) instead.
void	overwriteInactiveProjects(List<String> inactiveProjectSelectors) Deprecated. Use deactivateOptionalProject(String) or deactivateRequiredProject(String) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectActivation

public ProjectActivation()

Method Detail

addProjectActivation

public void addProjectActivation(String selector,
                                 boolean active,
                                 boolean optional)

Adds a project activation to the request.

Parameters:

selector - The selector of the project.

active - Should the project be activated?

optional - Can the build continue if the project does not exist?

getRequiredActiveProjectSelectors

public Set<String> getRequiredActiveProjectSelectors()

Returns:

Required active project selectors, never null.

getOptionalActiveProjectSelectors

public Set<String> getOptionalActiveProjectSelectors()

Returns:

Optional active project selectors, never null.

getRequiredInactiveProjectSelectors

public Set<String> getRequiredInactiveProjectSelectors()

Returns:

Required inactive project selectors, never null.

getOptionalInactiveProjectSelectors

public Set<String> getOptionalInactiveProjectSelectors()

Returns:

Optional inactive project selectors, never null.

getSelectedProjects

@Deprecated
public List<String> getSelectedProjects()

Deprecated. Use getRequiredActiveProjectSelectors() and getOptionalActiveProjectSelectors() instead.

Mimics the pre-Maven 4 "selected projects" list.

getExcludedProjects

@Deprecated
public List<String> getExcludedProjects()

Deprecated. Use getRequiredInactiveProjectSelectors() and getOptionalInactiveProjectSelectors() instead.

Mimics the pre-Maven 4 "excluded projects" list.

overwriteActiveProjects

@Deprecated
public void overwriteActiveProjects(List<String> activeProjectSelectors)

Deprecated. Use activateOptionalProject(String) or activateRequiredProject(String) instead.

Overwrites the active projects based on a pre-Maven 4 "active projects" list.

Parameters:

activeProjectSelectors - A List of project selectors that must be activated.

overwriteInactiveProjects

@Deprecated
public void overwriteInactiveProjects(List<String> inactiveProjectSelectors)

Deprecated. Use deactivateOptionalProject(String) or deactivateRequiredProject(String) instead.

Overwrites the inactive projects based on a pre-Maven 4 "inactive projects" list.

Parameters:

inactiveProjectSelectors - A List of project selectors that must be deactivated.

activateRequiredProject

public void activateRequiredProject(String selector)

Mark a project as required and activated.

Parameters:

selector - The selector of the project.

activateOptionalProject

public void activateOptionalProject(String selector)

Mark a project as optional and activated.

Parameters:

selector - The selector of the project.

deactivateRequiredProject

public void deactivateRequiredProject(String selector)

Mark a project as required and deactivated.

Parameters:

selector - The selector of the project.

deactivateOptionalProject

public void deactivateOptionalProject(String selector)

Mark a project as optional and deactivated.

Parameters:

selector - The selector of the project.

isEmpty

public boolean isEmpty()