Package eu.maveniverse.maven.mima.context

Class ContextOverrides.Builder

java.lang.Object

eu.maveniverse.maven.mima.context.ContextOverrides.Builder

Enclosing class:

ContextOverrides

public static final class ContextOverrides.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContextOverrides.Builder	appendRepositories(boolean appendRepositories)	If true, the repositories(List) provided non-null list will be appended to repositories coming from Maven (read from user settings.xml or current project), otherwise they are replacing them.
ContextOverrides	build()	Builds an immutable instance of ContextOverrides using so far applied settings and configuration.
ContextOverrides.Builder	checksumPolicy(ContextOverrides.ChecksumPolicy checksumPolicy)	Sets the checksum update policy.
ContextOverrides.Builder	configProperties(Map<String,Object> configProperties)	Sets Maven Configuration Properties to be used.
static ContextOverrides.Builder	create()	Creates a "default" builder instance (that will NOT discover settings.xml).
ContextOverrides.Builder	localRepository(Path localRepository)	Deprecated. Use withLocalRepositoryOverride(Path) instead.
ContextOverrides.Builder	offline(boolean offline)	Sets session offline.
ContextOverrides.Builder	repositories(List<org.eclipse.aether.repository.RemoteRepository> repositories)	Sets the list of RemoteRepository instance you want to use.
ContextOverrides.Builder	repositoryListener(org.eclipse.aether.RepositoryListener repositoryListener)	Sets RepositoryListener instance to be used.
ContextOverrides.Builder	settingsXml(Path settingsXml)	Deprecated. Use withSettingsXmlOverride(Path) instead.
ContextOverrides.Builder	snapshotUpdatePolicy(ContextOverrides.SnapshotUpdatePolicy snapshotUpdatePolicy)	Sets the snapshot update policy.
ContextOverrides.Builder	systemProperties(Map<String,String> systemProperties)	Sets Maven System Properties to be used.
ContextOverrides.Builder	transferListener(org.eclipse.aether.transfer.TransferListener transferListener)	Sets TransferListener instance to be used.
ContextOverrides.Builder	userProperties(Map<String,String> userProperties)	Sets Maven User Properties to be used.
ContextOverrides.Builder	withActiveProfileIds(List<String> activeProfileIds)	Sets explicitly activated profile IDs.
ContextOverrides.Builder	withBasedir(Path basedir)	Sets basedir path, it must be non-null and point to an existing directory.
ContextOverrides.Builder	withEffectiveSettings(Object effectiveSettings)	Sets Maven Effective Settings.
ContextOverrides.Builder	withGlobalSettingsXmlOverride(Path globalSettingsXmlOverride)	Overrides Maven Global settings.xml location.
ContextOverrides.Builder	withInactiveProfileIds(List<String> inactiveProfileIds)	Sets explicitly inactivated profile IDs.
ContextOverrides.Builder	withLocalRepositoryOverride(Path localRepositoryOverride)	Overrides Maven User local repository location.
ContextOverrides.Builder	withMavenSystemHome(Path mavenSystemHome)	Sets Maven System Home location.
ContextOverrides.Builder	withMavenUserHome(Path mavenUserHome)	Overrides Maven User Home, does not accept null.
ContextOverrides.Builder	withSettingsSecurityXmlOverride(Path settingsSecurityXmlOverride)	Deprecated. See withUserSettingsSecurityXmlOverride(Path)
ContextOverrides.Builder	withSettingsXmlOverride(Path settingsXmlOverride)	Deprecated. See withUserSettingsXmlOverride(Path)
ContextOverrides.Builder	withUserSettings(boolean withUserSettings)	Enables or disables use of settings.xml, used to find out location of local repository, authentication, remote repositories and many more.
ContextOverrides.Builder	withUserSettingsSecurityXmlOverride(Path userSettingsSecurityXmlOverride)	Overrides Maven User settings-security.xml location.
ContextOverrides.Builder	withUserSettingsXmlOverride(Path userSettingsXmlOverride)	Overrides Maven User settings.xml location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

create

public static ContextOverrides.Builder create()

Creates a "default" builder instance (that will NOT discover settings.xml).

Note: if you want to obey "Maven environment", you must invoke withUserSettings(boolean) with true parameter at least.

withBasedir

public ContextOverrides.Builder withBasedir(Path basedir)

Sets basedir path, it must be non-null and point to an existing directory. If these are not met, this method will throw. Basedir by default is initialized with ContextOverrides.DEFAULT_BASEDIR that is "current working directory" of the process.

Since:

2.3.0

systemProperties

public ContextOverrides.Builder systemProperties(Map<String,String> systemProperties)

Sets Maven System Properties to be used. Users usually don't want to tamper with this.

For defaults see ContextOverrides.defaultSystemProperties().

userProperties

public ContextOverrides.Builder userProperties(Map<String,String> userProperties)

Sets Maven User Properties to be used. These override the Maven System Properties.

configProperties

public ContextOverrides.Builder configProperties(Map<String,Object> configProperties)

Sets Maven Configuration Properties to be used. These accept Object values, and may be used for advanced configuration of some Resolver aspect. Usually users don't want to tamper with these.

repositories

public ContextOverrides.Builder repositories(List<org.eclipse.aether.repository.RemoteRepository> repositories)

Sets the list of RemoteRepository instance you want to use. The list may replace or append the list of repositories coming from Maven, see appendRepositories(boolean).

If withUserSettings(boolean) invoked with true, the settings.xml discovered repositories (and many more) will be used to create context. Also, in case when MIMA runs within Maven, the current project repositories will be provided.

appendRepositories

public ContextOverrides.Builder appendRepositories(boolean appendRepositories)

If true, the repositories(List) provided non-null list will be appended to repositories coming from Maven (read from user settings.xml or current project), otherwise they are replacing them. Default is false.

offline

public ContextOverrides.Builder offline(boolean offline)

Sets session offline.

localRepository

@Deprecated
public ContextOverrides.Builder localRepository(Path localRepository)

Deprecated.

Use withLocalRepositoryOverride(Path) instead.

Overrides the (default ot discovered) location of local repository. This path "wins" always, even if withUserSettings(boolean) was invoked with true and it contains alternate local repository path.

snapshotUpdatePolicy

public ContextOverrides.Builder snapshotUpdatePolicy(ContextOverrides.SnapshotUpdatePolicy snapshotUpdatePolicy)

Sets the snapshot update policy.

checksumPolicy

public ContextOverrides.Builder checksumPolicy(ContextOverrides.ChecksumPolicy checksumPolicy)

Sets the checksum update policy.

withUserSettings

public ContextOverrides.Builder withUserSettings(boolean withUserSettings)

Enables or disables use of settings.xml, used to find out location of local repository, authentication, remote repositories and many more.

withActiveProfileIds

public ContextOverrides.Builder withActiveProfileIds(List<String> activeProfileIds)

Sets explicitly activated profile IDs.

Since:

2.3.0

withInactiveProfileIds

public ContextOverrides.Builder withInactiveProfileIds(List<String> inactiveProfileIds)

Sets explicitly inactivated profile IDs.

Since:

2.3.0

settingsXml

@Deprecated
public ContextOverrides.Builder settingsXml(Path settingsXml)

Deprecated.

Use withSettingsXmlOverride(Path) instead.

Overrides the default location of settings.xml. Setting this method only, without invoking withUserSettings(boolean) with true, makes the passed in path to this method ignored.

repositoryListener

public ContextOverrides.Builder repositoryListener(org.eclipse.aether.RepositoryListener repositoryListener)

Sets RepositoryListener instance to be used.

transferListener

public ContextOverrides.Builder transferListener(org.eclipse.aether.transfer.TransferListener transferListener)

Sets TransferListener instance to be used.

withMavenUserHome

public ContextOverrides.Builder withMavenUserHome(Path mavenUserHome)

Overrides Maven User Home, does not accept null.

Since:

2.1.0

withSettingsXmlOverride

public ContextOverrides.Builder withSettingsXmlOverride(Path settingsXmlOverride)

Deprecated.

See withUserSettingsXmlOverride(Path)

Overrides Maven User settings.xml location.

Since:

2.1.0

withUserSettingsXmlOverride

public ContextOverrides.Builder withUserSettingsXmlOverride(Path userSettingsXmlOverride)

Overrides Maven User settings.xml location.

Since:

2.3.0

withSettingsSecurityXmlOverride

public ContextOverrides.Builder withSettingsSecurityXmlOverride(Path settingsSecurityXmlOverride)

Deprecated.

See withUserSettingsSecurityXmlOverride(Path)

Overrides Maven User settings-security.xml location.

Since:

2.1.0

withUserSettingsSecurityXmlOverride

public ContextOverrides.Builder withUserSettingsSecurityXmlOverride(Path userSettingsSecurityXmlOverride)

Overrides Maven User settings-security.xml location.

Since:

2.3.0

withLocalRepositoryOverride

public ContextOverrides.Builder withLocalRepositoryOverride(Path localRepositoryOverride)

Overrides Maven User local repository location.

Since:

2.1.0

withGlobalSettingsXmlOverride

public ContextOverrides.Builder withGlobalSettingsXmlOverride(Path globalSettingsXmlOverride)

Overrides Maven Global settings.xml location.

Since:

2.3.0

withMavenSystemHome

public ContextOverrides.Builder withMavenSystemHome(Path mavenSystemHome)

Sets Maven System Home location.

Since:

2.1.0

withEffectiveSettings

public ContextOverrides.Builder withEffectiveSettings(Object effectiveSettings)

Sets Maven Effective Settings.

Since:

2.3.0

build

public ContextOverrides build()

Builds an immutable instance of ContextOverrides using so far applied settings and configuration.