Class ToolchainManagerFactory.DefaultToolchainManagerV3

java.lang.Object

org.apache.maven.toolchain.ToolchainManagerFactory.DefaultToolchainManagerV3

All Implemented Interfaces:

ToolchainManager, ToolchainManagerPrivate

Enclosing class:

ToolchainManagerFactory

public class ToolchainManagerFactory.DefaultToolchainManagerV3
extends Object
implements ToolchainManager, ToolchainManagerPrivate

Field Summary

Fields inherited from interface org.apache.maven.toolchain.ToolchainManager

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultToolchainManagerV3()

Method Summary

Modifier and Type	Method	Description
Toolchain	getToolchainFromBuildContext(String type, MavenSession session)	Retrieve toolchain of specified type from build context.
List<Toolchain>	getToolchains(MavenSession session, String type, Map<String,String> requirements)	Select all toolchains available in user settings matching the type and requirements, independently from maven-toolchains-plugin.
ToolchainPrivate[]	getToolchainsForType(String type, MavenSession session)	Retrieves every toolchains of given type available in user settings.
void	storeToolchainToBuildContext(ToolchainPrivate toolchain, MavenSession session)	Stores the toolchain into build context for later use by toolchain-aware plugins.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultToolchainManagerV3

public DefaultToolchainManagerV3()

Method Details

getToolchainFromBuildContext

public Toolchain getToolchainFromBuildContext(String type,
 MavenSession session)

Description copied from interface: ToolchainManager

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.

Specified by:

getToolchainFromBuildContext in interface ToolchainManager

Parameters:

type - the type, must not be null

session - the Maven session, must not be null

Returns:

the toolchain selected by maven-toolchains-plugin

getToolchains

public List<Toolchain> getToolchains(MavenSession session,
 String type,
 Map<String,String> requirements)

Description copied from interface: ToolchainManager

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

Specified by:

getToolchains in interface ToolchainManager

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

getToolchainsForType

public ToolchainPrivate[] getToolchainsForType(String type,
 MavenSession session)
                                        throws MisconfiguredToolchainException

Description copied from interface: ToolchainManagerPrivate

Retrieves every toolchains of given type available in user settings.

Specified by:

getToolchainsForType in interface ToolchainManagerPrivate

Parameters:

type - the type, must not be null

session - the Maven session, must not be null

Throws:

MisconfiguredToolchainException

storeToolchainToBuildContext

public void storeToolchainToBuildContext(ToolchainPrivate toolchain,
 MavenSession session)

Description copied from interface: ToolchainManagerPrivate

Stores the toolchain into build context for later use by toolchain-aware plugins.

Specified by:

storeToolchainToBuildContext in interface ToolchainManagerPrivate

Parameters:

toolchain - the toolchain to store, must not be null

session - the Maven session, must not be null

See Also:

• ToolchainManager.getToolchainFromBuildContext(String, MavenSession)