Package org.apache.maven.project
Interface ProjectBuildingRequest
-
- All Known Implementing Classes:
DefaultProjectBuildingRequest
public interface ProjectBuildingRequest
ProjectBuildingRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ProjectBuildingRequest.RepositoryMerging
The possible merge modes for combining remote repositories.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addProfile(Profile profile)
Add aProfile
that has come from an external source.List<String>
getActiveProfileIds()
Date
getBuildStartTime()
Gets the start time of the build.List<String>
getInactiveProfileIds()
ArtifactRepository
getLocalRepository()
List<ArtifactRepository>
getPluginArtifactRepositories()
List<Profile>
getProfiles()
MavenProject
getProject()
List<ArtifactRepository>
getRemoteRepositories()
ProjectBuildingRequest.RepositoryMerging
getRepositoryMerging()
Gets the merge mode used to combine repositories declared in the POM with the repositories specified in this requestorg.eclipse.aether.RepositorySystemSession
getRepositorySession()
Properties
getSystemProperties()
Gets the system properties to use for interpolation and profile activation.Properties
getUserProperties()
Gets the user properties to use for interpolation and profile activation.int
getValidationLevel()
Gets the level of validation to perform on processed models.boolean
isProcessPlugins()
boolean
isResolveDependencies()
boolean
isResolveVersionRanges()
Deprecated.This got added when implementing MNG-2199 and is no longer used.void
setActiveProfileIds(List<String> activeProfileIds)
Set any active profiles that theProjectBuilder
should consider while constructing aMavenProject
.void
setBuildStartTime(Date buildStartTime)
Sets the start time of the build.void
setInactiveProfileIds(List<String> inactiveProfileIds)
ProjectBuildingRequest
setLocalRepository(ArtifactRepository localRepository)
ProjectBuildingRequest
setPluginArtifactRepositories(List<ArtifactRepository> pluginArtifactRepositories)
ProjectBuildingRequest
setProcessPlugins(boolean processPlugins)
void
setProfiles(List<Profile> profiles)
void
setProject(MavenProject mavenProject)
ProjectBuildingRequest
setRemoteRepositories(List<ArtifactRepository> remoteRepositories)
ProjectBuildingRequest
setRepositoryMerging(ProjectBuildingRequest.RepositoryMerging mode)
Sets the merge mode used to combine repositories declared in the POM with the repositories specified in this request.ProjectBuildingRequest
setRepositorySession(org.eclipse.aether.RepositorySystemSession repositorySession)
ProjectBuildingRequest
setResolveDependencies(boolean resolveDependencies)
ProjectBuildingRequest
setResolveVersionRanges(boolean value)
Deprecated.This got added when implementing MNG-2199 and is no longer used.ProjectBuildingRequest
setSystemProperties(Properties systemProperties)
Sets the system properties to use for interpolation and profile activation.ProjectBuildingRequest
setUserProperties(Properties userProperties)
Sets the user properties to use for interpolation and profile activation.ProjectBuildingRequest
setValidationLevel(int validationLevel)
Controls the level of validation to perform on processed models.
-
-
-
Method Detail
-
setLocalRepository
ProjectBuildingRequest setLocalRepository(ArtifactRepository localRepository)
-
getLocalRepository
ArtifactRepository getLocalRepository()
-
setRemoteRepositories
ProjectBuildingRequest setRemoteRepositories(List<ArtifactRepository> remoteRepositories)
-
getRemoteRepositories
List<ArtifactRepository> getRemoteRepositories()
-
setPluginArtifactRepositories
ProjectBuildingRequest setPluginArtifactRepositories(List<ArtifactRepository> pluginArtifactRepositories)
-
getPluginArtifactRepositories
List<ArtifactRepository> getPluginArtifactRepositories()
-
setSystemProperties
ProjectBuildingRequest setSystemProperties(Properties systemProperties)
Sets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment likeSystem.getProperties()
and environment variables.- Parameters:
systemProperties
- The system properties, may benull
.- Returns:
- This request, never
null
.
-
getSystemProperties
Properties getSystemProperties()
Gets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment likeSystem.getProperties()
and environment variables.- Returns:
- The system properties, never
null
.
-
setUserProperties
ProjectBuildingRequest setUserProperties(Properties userProperties)
Sets the user properties to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the-Dkey=value
parameter on the command line.- Parameters:
userProperties
- The user properties, may benull
.- Returns:
- This request, never
null
.
-
getUserProperties
Properties getUserProperties()
Gets the user properties to use for interpolation and profile activation. The user properties have been configured directly by the user on his discretion, e.g. via the-Dkey=value
parameter on the command line.- Returns:
- The user properties, never
null
.
-
setProject
void setProject(MavenProject mavenProject)
-
getProject
MavenProject getProject()
-
setProcessPlugins
ProjectBuildingRequest setProcessPlugins(boolean processPlugins)
-
isProcessPlugins
boolean isProcessPlugins()
-
setResolveDependencies
ProjectBuildingRequest setResolveDependencies(boolean resolveDependencies)
-
isResolveDependencies
boolean isResolveDependencies()
-
setValidationLevel
ProjectBuildingRequest setValidationLevel(int validationLevel)
Controls the level of validation to perform on processed models. By default, models are validated in strict mode.- Parameters:
validationLevel
- The level of validation to perform on processed models, e.g.ModelBuildingRequest.VALIDATION_LEVEL_STRICT
.- Returns:
- This configuration, never
null
.
-
getValidationLevel
int getValidationLevel()
Gets the level of validation to perform on processed models.- Returns:
- The level of validation to perform on processed models.
-
setActiveProfileIds
void setActiveProfileIds(List<String> activeProfileIds)
Set any active profiles that theProjectBuilder
should consider while constructing aMavenProject
.
-
addProfile
void addProfile(Profile profile)
Add aProfile
that has come from an external source. This may be from a custom configuration like the MavenCLI settings.xml file, or from a custom dialog in an IDE integration like M2Eclipse.- Parameters:
profile
-
-
getBuildStartTime
Date getBuildStartTime()
Gets the start time of the build.- Returns:
- The start time of the build or
null
if unknown.
-
setBuildStartTime
void setBuildStartTime(Date buildStartTime)
Sets the start time of the build.- Parameters:
buildStartTime
- The start time of the build, may benull
.
-
getRepositorySession
org.eclipse.aether.RepositorySystemSession getRepositorySession()
-
setRepositorySession
ProjectBuildingRequest setRepositorySession(org.eclipse.aether.RepositorySystemSession repositorySession)
-
setRepositoryMerging
ProjectBuildingRequest setRepositoryMerging(ProjectBuildingRequest.RepositoryMerging mode)
Sets the merge mode used to combine repositories declared in the POM with the repositories specified in this request.- Parameters:
mode
- The repository merge mode, must not benull
.- Returns:
- This request for chaining, never
null
. - See Also:
setRemoteRepositories(List)
-
getRepositoryMerging
ProjectBuildingRequest.RepositoryMerging getRepositoryMerging()
Gets the merge mode used to combine repositories declared in the POM with the repositories specified in this request- Returns:
- The merge mode, never
null
.
-
isResolveVersionRanges
@Deprecated boolean isResolveVersionRanges()
Deprecated.This got added when implementing MNG-2199 and is no longer used. Commit 6cf9320942c34bc68205425ab696b1712ace9ba4 updated the way 'MavenProject' objects are initialized.- Since:
- 3.2.2
-
setResolveVersionRanges
@Deprecated ProjectBuildingRequest setResolveVersionRanges(boolean value)
Deprecated.This got added when implementing MNG-2199 and is no longer used. Commit 6cf9320942c34bc68205425ab696b1712ace9ba4 updated the way 'MavenProject' objects are initialized.- Since:
- 3.2.2
-
-