Package org.apache.maven.api.services

Interface ToolchainManager

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultToolchainManager

@Experimental
public interface ToolchainManager
extends Service

Service to manage Toolchains.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
Optional<Toolchain>	getToolchainFromBuildContext(Session session, String type)
List<Toolchain>	getToolchains(Session session, String type, Map<String,String> requirements)
List<Toolchain>	getToolchainsForType(Session session, String type)
void	storeToolchainToBuildContext(Session session, Toolchain toolchain)

Method Details

getToolchains

@Nonnull
List<Toolchain> getToolchains(@Nonnull
 Session session,
 String type,
 Map<String,String> requirements)

Parameters:

session -

type -

requirements -

Returns:

the selected Toolchains

Throws:

ToolchainManagerException - if an exception occurs

getToolchainFromBuildContext

@Nonnull
Optional<Toolchain> getToolchainFromBuildContext(@Nonnull
 Session session,
 String type)
                                          throws ToolchainManagerException

Parameters:

session -

type -

Returns:

the selected Toolchain

Throws:

ToolchainManagerException - if an exception occurs

getToolchainsForType

@Nonnull
List<Toolchain> getToolchainsForType(@Nonnull
 Session session,
 String type)
                              throws ToolchainManagerException

Parameters:

session -

type -

Returns:

the selected Toolchains

Throws:

ToolchainManagerException - if an exception occurs

storeToolchainToBuildContext

void storeToolchainToBuildContext(@Nonnull
 Session session,
 Toolchain toolchain)
                           throws ToolchainManagerException

Parameters:

session -

toolchain -

Throws:

ToolchainManagerException - if an exception occurs