Package org.apache.maven.api.services

Interface SettingsBuilderRequest

@Experimental
@Immutable
public interface SettingsBuilderRequest

Collects settings that control the building of effective settings.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SettingsBuilderRequest.SettingsBuilderRequestBuilder

Method Summary

Modifier and Type	Method	Description
static SettingsBuilderRequest	build(ProtoSession session, Path installationSettingsPath, Path userSettingsPath)
static SettingsBuilderRequest	build(ProtoSession session, Path installationSettingsPath, Path projectSettingsPath, Path userSettingsPath)
static SettingsBuilderRequest	build(ProtoSession session, Source installationSettingsSource, Source userSettingsSource)
static SettingsBuilderRequest	build(ProtoSession session, Source installationSettingsSource, Source projectSettingsSource, Source userSettingsSource)
static SettingsBuilderRequest.SettingsBuilderRequestBuilder	builder()
Optional<Source>	getInstallationSettingsSource()	Gets the installation settings source.
Optional<Function<String,String>>	getInterpolationSource()	The optional interpolation source used for interpolation.
Optional<Source>	getProjectSettingsSource()	Gets the project settings source.
ProtoSession	getSession()
Optional<Source>	getUserSettingsSource()	Gets the user settings source.

Method Details

getSession

@Nonnull
ProtoSession getSession()

getInstallationSettingsSource

@Nonnull
Optional<Source> getInstallationSettingsSource()

Gets the installation settings source.

Returns:

the installation settings source or null if none

getProjectSettingsSource

@Nonnull
Optional<Source> getProjectSettingsSource()

Gets the project settings source.

Returns:

the project settings source or null if none

getUserSettingsSource

@Nonnull
Optional<Source> getUserSettingsSource()

Gets the user settings source.

Returns:

the user settings source or null if none

getInterpolationSource

@Nonnull
Optional<Function<String,String>> getInterpolationSource()

The optional interpolation source used for interpolation.

Returns:

the interpolation source for interpolation

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 ProtoSession session,
 @Nonnull
 Source installationSettingsSource,
 @Nonnull
 Source userSettingsSource)

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 ProtoSession session,
 @Nonnull
 Path installationSettingsPath,
 @Nonnull
 Path userSettingsPath)

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 ProtoSession session,
 @Nullable
 Source installationSettingsSource,
 @Nullable
 Source projectSettingsSource,
 @Nullable
 Source userSettingsSource)

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 ProtoSession session,
 @Nullable
 Path installationSettingsPath,
 @Nullable
 Path projectSettingsPath,
 @Nullable
 Path userSettingsPath)

builder

@Nonnull
static SettingsBuilderRequest.SettingsBuilderRequestBuilder builder()