Package org.apache.maven.toolchain

Interface ToolchainManager

All Known Implementing Classes:

DefaultToolchainManager, DefaultToolchainManagerPrivate

public interface ToolchainManager

Public API for a toolchain-aware plugin to get expected toolchain instance.

Since:

2.0.9

Author:

mkleint, Robert Scholte

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ROLE	Deprecated.

Method Summary

Modifier and Type	Method	Description
Toolchain	getToolchainFromBuildContext(java.lang.String type, MavenSession context)	Retrieve toolchain of specified type from build context.
java.util.List<Toolchain>	getToolchains(MavenSession session, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> requirements)	Select all toolchains available in user settings matching the type and requirements, independently from maven-toolchains-plugin.

Field Detail

ROLE

@Deprecated
static final java.lang.String ROLE

Deprecated.

Method Detail

getToolchainFromBuildContext

Toolchain getToolchainFromBuildContext(java.lang.String type,
                                       MavenSession context)

Retrieve toolchain of specified type from build context. It is expected that maven-toolchains-plugin contains the configuration to select the appropriate toolchain and is executed at the beginning of the build.

Parameters:

type - the type, must not be null

context - the Maven session, must not be null

Returns:

the toolchain selected by maven-toolchains-plugin

getToolchains

java.util.List<Toolchain> getToolchains(MavenSession session,
                                        java.lang.String type,
                                        java.util.Map<java.lang.String,java.lang.String> requirements)

Select all toolchains available in user settings matching the type and requirements, independently from maven-toolchains-plugin.

Parameters:

session - the Maven session, must not be null

type - the type, must not be null

requirements - the requirements, may be null

Returns:

the matching toolchains, never null

Since:

3.3.0