org.apache.maven.execution

Interface MavenExecutionRequestPopulator

All Known Implementing Classes:

DefaultMavenExecutionRequestPopulator

public interface MavenExecutionRequestPopulator

Assists in populating an execution request for invocation of Maven.

Author:

Benjamin Bentmann

Method Summary

Modifier and Type	Method and Description
MavenExecutionRequest	populateDefaults(MavenExecutionRequest request) Injects default values like plugin groups or repositories into the specified execution request.
MavenExecutionRequest	populateFromSettings(MavenExecutionRequest request, Settings settings) Deprecated.
MavenExecutionRequest	populateFromToolchains(MavenExecutionRequest request, PersistedToolchains toolchains) Copies the values from the given toolchains into the specified execution request.

Method Detail

populateFromToolchains

MavenExecutionRequest populateFromToolchains(MavenExecutionRequest request,
                                             PersistedToolchains toolchains)
                                      throws MavenExecutionRequestPopulationException

Copies the values from the given toolchains into the specified execution request. This method will replace any existing values in the execution request that are controlled by the toolchains. Hence, it is expected that this method is called on a new/empty execution request before the caller mutates it to fit its needs.

Parameters:

request - The execution request to populate, must not be null.

toolchains - The toolchains to copy into the execution request, may be null.

Returns:

The populated execution request, never null.

Throws:

MavenExecutionRequestPopulationException - If the execution request could not be populated.

Since:

3.3.0

populateDefaults

MavenExecutionRequest populateDefaults(MavenExecutionRequest request)
                                throws MavenExecutionRequestPopulationException

Injects default values like plugin groups or repositories into the specified execution request.

Parameters:

request - The execution request to populate, must not be null.

Returns:

The populated execution request, never null.

Throws:

MavenExecutionRequestPopulationException - If the execution request could not be populated.

populateFromSettings

@Deprecated
MavenExecutionRequest populateFromSettings(MavenExecutionRequest request,
                                                        Settings settings)
                                                 throws MavenExecutionRequestPopulationException

Deprecated.

Copies the values from the given settings into the specified execution request. This method will replace any existing values in the execution request that are controlled by the settings. Hence, it is expected that this method is called on a new/empty execution request before the caller mutates it to fit its needs.

Parameters:

request - The execution request to populate, must not be null.

settings - The settings to copy into the execution request, may be null.

Returns:

The populated execution request, never null.

Throws:

MavenExecutionRequestPopulationException - If the execution request could not be populated.