Package org.apache.maven.api.services

Interface ModelBuilderRequest

All Superinterfaces:

RepositoryAwareRequest, Request<Session>

@Experimental
@Immutable
public interface ModelBuilderRequest
extends RepositoryAwareRequest

Request used to build a Project using the ProjectBuilder service.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ModelBuilderRequest.ModelBuilderRequestBuilder
static enum	ModelBuilderRequest.RepositoryMerging	The possible merge modes for combining remote repositories.
static enum	ModelBuilderRequest.RequestType	The possible request types for building a model.

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.
ModelTransformer	getLifecycleBindingsInjector()
Collection<Profile>	getProfiles()	Defines external profiles that may be activated for the given model.
ModelBuilderRequest.RepositoryMerging	getRepositoryMerging()
ModelBuilderRequest.RequestType	getRequestType()
ModelSource	getSource()
Map<String,String>	getSystemProperties()	Provides a map of system properties.
Map<String,String>	getUserProperties()	Provides a map of user properties.
boolean	isLocationTracking()
boolean	isRecursive()

Methods inherited from interface org.apache.maven.api.services.RepositoryAwareRequest

getRepositories, validate

Methods inherited from interface org.apache.maven.api.services.Request

equals, getSession, getTrace, hashCode, toString

Method Details

getSource

@Nonnull
ModelSource getSource()

getRequestType

@Nonnull
ModelBuilderRequest.RequestType getRequestType()

isLocationTracking

boolean isLocationTracking()

isRecursive

boolean isRecursive()

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

getRepositoryMerging

@Nonnull
ModelBuilderRequest.RepositoryMerging getRepositoryMerging()

getLifecycleBindingsInjector

@Nullable
ModelTransformer getLifecycleBindingsInjector()

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)