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(Session session, Path globalSettingsPath, Path userSettingsPath)
static SettingsBuilderRequest	build(Session session, Path globalSettingsPath, Path projectSettingsPath, Path userSettingsPath)
static SettingsBuilderRequest	build(Session session, Source globalSettingsSource, Source userSettingsSource)
static SettingsBuilderRequest	build(Session session, Source globalSettingsSource, Source projectSettingsSource, Source userSettingsSource)
static SettingsBuilderRequest.SettingsBuilderRequestBuilder	builder()
Optional<Path>	getGlobalSettingsPath()	Gets the global settings path.
Optional<Source>	getGlobalSettingsSource()	Gets the global settings source.
Optional<Path>	getProjectSettingsPath()	Gets the project settings path.
Optional<Source>	getProjectSettingsSource()	Gets the project settings source.
Session	getSession()
Optional<Path>	getUserSettingsPath()	Gets the user settings path.
Optional<Source>	getUserSettingsSource()	Gets the user settings source.

Method Details

getSession

@Nonnull
Session getSession()

getGlobalSettingsPath

@Nonnull
Optional<Path> getGlobalSettingsPath()

Gets the global settings path.

Returns:

the global settings path or null if none

getGlobalSettingsSource

@Nonnull
Optional<Source> getGlobalSettingsSource()

Gets the global settings source.

Returns:

the global 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

getProjectSettingsPath

@Nonnull
Optional<Path> getProjectSettingsPath()

Gets the project settings path.

Returns:

the project settings path or null if none

getUserSettingsPath

@Nonnull
Optional<Path> getUserSettingsPath()

Gets the user settings path.

Returns:

the user settings path or null if none

getUserSettingsSource

@Nonnull
Optional<Source> getUserSettingsSource()

Gets the user settings source.

Returns:

the user settings source or null if none

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 Session session,
 @Nonnull
 Source globalSettingsSource,
 @Nonnull
 Source userSettingsSource)

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 Session session,
 @Nonnull
 Path globalSettingsPath,
 @Nonnull
 Path userSettingsPath)

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 Session session,
 @Nonnull
 Source globalSettingsSource,
 @Nonnull
 Source projectSettingsSource,
 @Nonnull
 Source userSettingsSource)

build

@Nonnull
static SettingsBuilderRequest build(@Nonnull
 Session session,
 @Nonnull
 Path globalSettingsPath,
 @Nonnull
 Path projectSettingsPath,
 @Nonnull
 Path userSettingsPath)

builder

@Nonnull
static SettingsBuilderRequest.SettingsBuilderRequestBuilder builder()