Package org.apache.maven.api.services

Interface ModelBuilderRequest

@Experimental
@Immutable
public interface ModelBuilderRequest

Request used to build a Project using the ProjectBuilder service. TODO: replace ModelRepositoryHolder with just the enum for the strategy TODO: replace validation level with an enum (though, we usually need just a boolean)

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ModelBuilderRequest.ModelBuilderRequestBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VALIDATION_LEVEL_MAVEN_2_0	Denotes validation as performed by Maven 2.0.
static final int	VALIDATION_LEVEL_MAVEN_3_0	Denotes validation as performed by Maven 3.0.
static final int	VALIDATION_LEVEL_MAVEN_3_1	Denotes validation as performed by Maven 3.1.
static final int	VALIDATION_LEVEL_MAVEN_4_0	Denotes validation as performed by Maven 4.0.
static final int	VALIDATION_LEVEL_MINIMAL	Denotes minimal validation of POMs.
static final int	VALIDATION_LEVEL_STRICT	Denotes strict validation as recommended by the current Maven version.

Method Summary

Modifier and Type	Method	Description
static ModelBuilderRequest	build(ModelBuilderRequest request, ModelSource source)
static ModelBuilderRequest	build(Session session, Path path)
static ModelBuilderRequest	build(Session session, ModelSource source)
static ModelBuilderRequest.ModelBuilderRequestBuilder	builder()
static ModelBuilderRequest.ModelBuilderRequestBuilder	builder(ModelBuilderRequest request)
List<String>	getActiveProfileIds()	List of profile ids that have been explicitly activated by the user.
List<String>	getInactiveProfileIds()	List of profile ids that have been explicitly deactivated by the user.
ModelBuilderResult	getInterimResult()
Object	getListener()
ModelCache	getModelCache()
ModelRepositoryHolder	getModelRepositoryHolder()
ModelResolver	getModelResolver()
Collection<Profile>	getProfiles()	Defines external profiles that may be activated for the given model.
Session	getSession()
ModelSource	getSource()
Map<String,String>	getSystemProperties()	Provides a map of system properties.
ModelTransformerContextBuilder	getTransformerContextBuilder()
Map<String,String>	getUserProperties()	Provides a map of user properties.
int	getValidationLevel()
boolean	isLocationTracking()
boolean	isProcessPlugins()	Specifies whether plugin processing should take place for the built model.
boolean	isProjectBuild()	Indicates if the model to be built is a local project or a dependency.
boolean	isTwoPhaseBuilding()

Field Details

VALIDATION_LEVEL_MINIMAL

static final int VALIDATION_LEVEL_MINIMAL

Denotes minimal validation of POMs. This validation level is meant for processing of POMs from repositories during metadata retrieval.

See Also:

• Constant Field Values

VALIDATION_LEVEL_MAVEN_2_0

static final int VALIDATION_LEVEL_MAVEN_2_0

Denotes validation as performed by Maven 2.0. This validation level is meant as a compatibility mode to allow users to migrate their projects.

See Also:

• Constant Field Values

VALIDATION_LEVEL_MAVEN_3_0

static final int VALIDATION_LEVEL_MAVEN_3_0

Denotes validation as performed by Maven 3.0. This validation level is meant for existing projects.

See Also:

• Constant Field Values

VALIDATION_LEVEL_MAVEN_3_1

static final int VALIDATION_LEVEL_MAVEN_3_1

Denotes validation as performed by Maven 3.1. This validation level is meant for existing projects.

See Also:

• Constant Field Values

VALIDATION_LEVEL_MAVEN_4_0

static final int VALIDATION_LEVEL_MAVEN_4_0

Denotes validation as performed by Maven 4.0. This validation level is meant for new projects.

See Also:

• Constant Field Values

VALIDATION_LEVEL_STRICT

static final int VALIDATION_LEVEL_STRICT

Denotes strict validation as recommended by the current Maven version.

See Also:

• Constant Field Values

Method Details

getSession

@Nonnull
Session getSession()

getSource

@Nonnull
ModelSource getSource()

getValidationLevel

int getValidationLevel()

isTwoPhaseBuilding

boolean isTwoPhaseBuilding()

isLocationTracking

boolean isLocationTracking()

isProjectBuild

boolean isProjectBuild()

Indicates if the model to be built is a local project or a dependency. In case the project is loaded externally from a remote repository (as a dependency or even as an external parent), the POM will be parsed in a lenient way. Local POMs are parsed more strictly.

isProcessPlugins

boolean isProcessPlugins()

Specifies whether plugin processing should take place for the built model. This involves merging plugins specified by the Packaging, configuration expansion (merging configuration defined globally for a given plugin using ConfigurationContainer.getConfiguration() into the configuration for each PluginExecution.

getProfiles

@Nonnull
Collection<Profile> getProfiles()

Defines external profiles that may be activated for the given model. Those are external profiles usually defined in Settings.getProfiles().

getActiveProfileIds

@Nonnull
List<String> getActiveProfileIds()

List of profile ids that have been explicitly activated by the user.

getInactiveProfileIds

@Nonnull
List<String> getInactiveProfileIds()

List of profile ids that have been explicitly deactivated by the user.

getSystemProperties

@Nonnull
Map<String,String> getSystemProperties()

Provides a map of system properties.

getUserProperties

@Nonnull
Map<String,String> getUserProperties()

Provides a map of user properties. User properties

getModelResolver

@Nonnull
ModelResolver getModelResolver()

getModelRepositoryHolder

@Nonnull
ModelRepositoryHolder getModelRepositoryHolder()

getModelCache

@Nullable
ModelCache getModelCache()

getListener

@Nullable
Object getListener()

getInterimResult

@Nullable
ModelBuilderResult getInterimResult()

getTransformerContextBuilder

@Nullable
ModelTransformerContextBuilder getTransformerContextBuilder()

build

@Nonnull
static ModelBuilderRequest build(@Nonnull
 ModelBuilderRequest request,
 @Nonnull
 ModelSource source)

build

@Nonnull
static ModelBuilderRequest build(@Nonnull
 Session session,
 @Nonnull
 ModelSource source)

build

@Nonnull
static ModelBuilderRequest build(@Nonnull
 Session session,
 @Nonnull
 Path path)

builder

@Nonnull
static ModelBuilderRequest.ModelBuilderRequestBuilder builder()

builder

@Nonnull
static ModelBuilderRequest.ModelBuilderRequestBuilder builder(ModelBuilderRequest request)