Package org.apache.maven.api.services

Interface SettingsBuilder

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultSettingsBuilder

@Experimental
public interface SettingsBuilder
extends Service

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

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
SettingsBuilderResult	build(SettingsBuilderRequest request)	Builds the effective settings of the specified settings files.
default SettingsBuilderResult	build(Session session, Path globalSettingsPath, Path userSettingsPath)	Builds the effective settings of the specified settings paths.
default SettingsBuilderResult	build(Session session, Path globalSettingsPath, Path projectSettingsPath, Path userSettingsPath)	Builds the effective settings of the specified settings paths.
default SettingsBuilderResult	build(Session session, Source globalSettingsSource, Source userSettingsSource)	Builds the effective settings of the specified settings sources.
default SettingsBuilderResult	build(Session session, Source globalSettingsSource, Source projectSettingsSource, Source userSettingsSource)	Builds the effective settings of the specified settings sources.
Profile	convert(Profile profile)	Convert a model profile to a settings profile.
Profile	convert(Profile profile)	Convert a settings profile to a model profile.
default List<BuilderProblem>	validate(Settings settings)	Validate the specified settings.
List<BuilderProblem>	validate(Settings settings, boolean isProjectSettings)	Validate the specified settings.

Method Details

build

@Nonnull
SettingsBuilderResult build(@Nonnull
 SettingsBuilderRequest request)

Builds the effective settings of the specified settings files.

Parameters:

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

Returns:

the result of the settings building, never null

Throws:

SettingsBuilderException - if the effective settings could not be built

build

@Nonnull
default SettingsBuilderResult build(@Nonnull
 Session session,
 @Nonnull
 Source globalSettingsSource,
 @Nonnull
 Source userSettingsSource)

Builds the effective settings of the specified settings sources.

Returns:

the result of the settings building, never null

Throws:

SettingsBuilderException - if the effective settings could not be built

build

@Nonnull
default SettingsBuilderResult build(@Nonnull
 Session session,
 @Nonnull
 Path globalSettingsPath,
 @Nonnull
 Path userSettingsPath)

Builds the effective settings of the specified settings paths.

Returns:

the result of the settings building, never null

Throws:

SettingsBuilderException - if the effective settings could not be built

build

@Nonnull
default SettingsBuilderResult build(@Nonnull
 Session session,
 @Nonnull
 Source globalSettingsSource,
 @Nonnull
 Source projectSettingsSource,
 @Nonnull
 Source userSettingsSource)

Builds the effective settings of the specified settings sources.

Returns:

the result of the settings building, never null

Throws:

SettingsBuilderException - if the effective settings could not be built

build

@Nonnull
default SettingsBuilderResult build(@Nonnull
 Session session,
 @Nonnull
 Path globalSettingsPath,
 @Nonnull
 Path projectSettingsPath,
 @Nonnull
 Path userSettingsPath)

Builds the effective settings of the specified settings paths.

Returns:

the result of the settings building, never null

Throws:

SettingsBuilderException - if the effective settings could not be built

validate

@Nonnull
default List<BuilderProblem> validate(@Nonnull
 Settings settings)

Validate the specified settings.

Parameters:

settings - The settings to validate, must not be null.

Returns:

The list of problems that were encountered, must not be null.

validate

@Nonnull
List<BuilderProblem> validate(@Nonnull
 Settings settings,
 boolean isProjectSettings)

Validate the specified settings.

Parameters:

settings - The settings to validate, must not be null.

isProjectSettings - Boolean indicating if the validation is for project settings or user / global settings.

Returns:

The list of problems that were encountered, must not be null.

convert

@Nonnull
Profile convert(@Nonnull
 Profile profile)

Convert a model profile to a settings profile.

convert

@Nonnull
Profile convert(@Nonnull
 Profile profile)

Convert a settings profile to a model profile.