Package org.apache.maven.api.services

Interface ToolchainsBuilder

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultToolchainsBuilder

@Experimental
public interface ToolchainsBuilder
extends Service

Builds the effective toolchains from a user toolchains file and/or a global toolchains file.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
ToolchainsBuilderResult	build(ToolchainsBuilderRequest request)	Builds the effective toolchains for the specified toolchains files.
default ToolchainsBuilderResult	build(Session session, Source globalToolchainsSource, Source userToolchainsSource)	Builds the effective toolchains for the specified toolchains sources.

Method Details

build

ToolchainsBuilderResult build(ToolchainsBuilderRequest request)

Builds the effective toolchains for the specified toolchains files.

Parameters:

request - the toolchains building request that holds the parameters, must not be null

Returns:

the result of the toolchains building, never null

Throws:

ToolchainsBuilderException - if the effective toolchains could not be built

build

@Nonnull
default ToolchainsBuilderResult build(@Nonnull
 Session session,
 @Nonnull
 Source globalToolchainsSource,
 @Nonnull
 Source userToolchainsSource)

Builds the effective toolchains for the specified toolchains sources.

Parameters:

session - the Session, must not be null

globalToolchainsSource - The Source pointing to the global toolchains, must not be null

userToolchainsSource - The Source pointing to the user toolchains, must not be null

Throws:

ToolchainsBuilderException - if the project cannot be created

IllegalArgumentException - if an argument is null or invalid

See Also:

• build(ToolchainsBuilderRequest)