org.apache.maven.toolchain

Interface ToolchainManagerPrivate

All Known Implementing Classes:

DefaultToolchainManagerPrivate

public interface ToolchainManagerPrivate

Component for use by the maven-toolchains-plugin only. It provides API:

1. to retrieve every toolchains available in user settings,
2. to store chosen toolchain into build context for later use by toolchain-aware plugins.

Since:

2.0.9

Author:

mkleint

See Also:

ToolchainManager.getToolchainFromBuildContext(String, MavenSession)

Method Summary

Modifier and Type	Method and Description
ToolchainPrivate[]	getToolchainsForType(String type, MavenSession context) Retrieves every toolchains of given type available in user settings.
void	storeToolchainToBuildContext(ToolchainPrivate toolchain, MavenSession context) Stores the toolchain into build context for later use by toolchain-aware plugins.

Method Detail

getToolchainsForType

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

Retrieves every toolchains of given type available in user settings.

Parameters:

type - the type, must not be null

context - the Maven session, must not be null

Throws:

MisconfiguredToolchainException

Since:

3.0 (addition of the MavenSession parameter)

storeToolchainToBuildContext

void storeToolchainToBuildContext(ToolchainPrivate toolchain,
                                  MavenSession context)

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

Parameters:

toolchain - the toolchain to store, must not be null

context - the Maven session, must not be null

Since:

2.0.9

See Also:

ToolchainManager.getToolchainFromBuildContext(String, MavenSession)