DefaultProjectBuildingRequest (Maven Core 3.6.0 API)

java.lang.Object
- org.apache.maven.project.DefaultProjectBuildingRequest

All Implemented Interfaces:: ProjectBuildingRequest

public class DefaultProjectBuildingRequest
extends Object
implements ProjectBuildingRequest

DefaultProjectBuildingRequest

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.maven.project.ProjectBuildingRequest
  ProjectBuildingRequest.RepositoryMerging

Constructor Summary

Constructors
Constructor and Description

DefaultProjectBuildingRequest()

DefaultProjectBuildingRequest(ProjectBuildingRequest request)

Constructors
Constructor and Description
`DefaultProjectBuildingRequest()`
`DefaultProjectBuildingRequest(ProjectBuildingRequest request)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProfile(Profile profile)` Add a `Profile` 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 request
`org.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. Commit 6cf9320942c34bc68205425ab696b1712ace9ba4 updated the way 'MavenProject' objects are initialized.
`void`	`setActiveProfileIds(List<String> activeProfileIds)` Set any active profiles that the `ProjectBuilder` should consider while constructing a `MavenProject`.
`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)`
`DefaultProjectBuildingRequest`	`setRepositoryMerging(ProjectBuildingRequest.RepositoryMerging repositoryMerging)` Sets the merge mode used to combine repositories declared in the POM with the repositories specified in this request.
`DefaultProjectBuildingRequest`	`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. Commit 6cf9320942c34bc68205425ab696b1712ace9ba4 updated the way 'MavenProject' objects are initialized.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultProjectBuildingRequest
```
public DefaultProjectBuildingRequest()
```
  - DefaultProjectBuildingRequest
```
public DefaultProjectBuildingRequest(ProjectBuildingRequest request)
```
- Method Detail
  - getProject
```
public MavenProject getProject()
```
    Specified by:
    
    getProject in interface ProjectBuildingRequest
  - setProject
```
public void setProject(MavenProject mavenProject)
```
    Specified by:
    
    setProject in interface ProjectBuildingRequest
  - setLocalRepository
```
public ProjectBuildingRequest setLocalRepository(ArtifactRepository localRepository)
```
    Specified by:
    
    setLocalRepository in interface ProjectBuildingRequest
  - getLocalRepository
```
public ArtifactRepository getLocalRepository()
```
    Specified by:
    
    getLocalRepository in interface ProjectBuildingRequest
  - getRemoteRepositories
```
public List<ArtifactRepository> getRemoteRepositories()
```
    Specified by:
    
    getRemoteRepositories in interface ProjectBuildingRequest
  - setRemoteRepositories
```
public ProjectBuildingRequest setRemoteRepositories(List<ArtifactRepository> remoteRepositories)
```
    Specified by:
    
    setRemoteRepositories in interface ProjectBuildingRequest
  - getPluginArtifactRepositories
```
public List<ArtifactRepository> getPluginArtifactRepositories()
```
    Specified by:
    
    getPluginArtifactRepositories in interface ProjectBuildingRequest
  - setPluginArtifactRepositories
```
public ProjectBuildingRequest setPluginArtifactRepositories(List<ArtifactRepository> pluginArtifactRepositories)
```
    Specified by:
    
    setPluginArtifactRepositories in interface ProjectBuildingRequest
  - getSystemProperties
```
public Properties getSystemProperties()
```
    Description copied from interface: ProjectBuildingRequest
    
    Gets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
    
    Specified by:
    
    getSystemProperties in interface ProjectBuildingRequest
    
    Returns:
    The system properties, never null.
  - setSystemProperties
```
public ProjectBuildingRequest setSystemProperties(Properties systemProperties)
```
    Description copied from interface: ProjectBuildingRequest
    
    Sets the system properties to use for interpolation and profile activation. The system properties are collected from the runtime environment like System.getProperties() and environment variables.
    
    Specified by:
    
    setSystemProperties in interface ProjectBuildingRequest
    
    Parameters:
    systemProperties - The system properties, may be null.
    
    Returns:
    This request, never null.
  - getUserProperties
```
public Properties getUserProperties()
```
    Description copied from interface: ProjectBuildingRequest
    
    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.
    
    Specified by:
    
    getUserProperties in interface ProjectBuildingRequest
    
    Returns:
    The user properties, never null.
  - setUserProperties
```
public ProjectBuildingRequest setUserProperties(Properties userProperties)
```
    Description copied from interface: ProjectBuildingRequest
    
    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.
    
    Specified by:
    
    setUserProperties in interface ProjectBuildingRequest
    
    Parameters:
    userProperties - The user properties, may be null.
    
    Returns:
    This request, never null.
  - isProcessPlugins
```
public boolean isProcessPlugins()
```
    Specified by:
    
    isProcessPlugins in interface ProjectBuildingRequest
  - setProcessPlugins
```
public ProjectBuildingRequest setProcessPlugins(boolean processPlugins)
```
    Specified by:
    
    setProcessPlugins in interface ProjectBuildingRequest
  - setResolveDependencies
```
public ProjectBuildingRequest setResolveDependencies(boolean resolveDependencies)
```
    Specified by:
    
    setResolveDependencies in interface ProjectBuildingRequest
  - isResolveDependencies
```
public boolean isResolveDependencies()
```
    Specified by:
    
    isResolveDependencies in interface ProjectBuildingRequest
  - setResolveVersionRanges
```
@Deprecated
public 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.
    
    Specified by:
    
    setResolveVersionRanges in interface ProjectBuildingRequest
    
    Since:
    
    3.2.2
  - isResolveVersionRanges
```
@Deprecated
public boolean isResolveVersionRanges()
```
    Deprecated. This got added when implementing MNG-2199 and is no longer used. Commit 6cf9320942c34bc68205425ab696b1712ace9ba4 updated the way 'MavenProject' objects are initialized.
    
    Specified by:
    
    isResolveVersionRanges in interface ProjectBuildingRequest
    
    Since:
    
    3.2.2
  - setValidationLevel
```
public ProjectBuildingRequest setValidationLevel(int validationLevel)
```
    Description copied from interface: ProjectBuildingRequest
    
    Controls the level of validation to perform on processed models. By default, models are validated in strict mode.
    
    Specified by:
    
    setValidationLevel in interface ProjectBuildingRequest
    
    Parameters:
    validationLevel - The level of validation to perform on processed models, e.g. ModelBuildingRequest.VALIDATION_LEVEL_STRICT.
    
    Returns:
    This configuration, never null.
  - getValidationLevel
```
public int getValidationLevel()
```
    Description copied from interface: ProjectBuildingRequest
    
    Gets the level of validation to perform on processed models.
    
    Specified by:
    
    getValidationLevel in interface ProjectBuildingRequest
    
    Returns:
    The level of validation to perform on processed models.
  - getActiveProfileIds
```
public List<String> getActiveProfileIds()
```
    Specified by:
    
    getActiveProfileIds in interface ProjectBuildingRequest
  - setActiveProfileIds
```
public void setActiveProfileIds(List<String> activeProfileIds)
```
    Description copied from interface: ProjectBuildingRequest
    
    Set any active profiles that the ProjectBuilder should consider while constructing a MavenProject.
    
    Specified by:
    
    setActiveProfileIds in interface ProjectBuildingRequest
  - getInactiveProfileIds
```
public List<String> getInactiveProfileIds()
```
    Specified by:
    
    getInactiveProfileIds in interface ProjectBuildingRequest
  - setInactiveProfileIds
```
public void setInactiveProfileIds(List<String> inactiveProfileIds)
```
    Specified by:
    
    setInactiveProfileIds in interface ProjectBuildingRequest
  - setProfiles
```
public void setProfiles(List<Profile> profiles)
```
    Specified by:
    
    setProfiles in interface ProjectBuildingRequest
  - addProfile
```
public void addProfile(Profile profile)
```
    Description copied from interface: ProjectBuildingRequest
    
    Add a Profile 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.
    
    Specified by:
    
    addProfile in interface ProjectBuildingRequest
  - getProfiles
```
public List<Profile> getProfiles()
```
    Specified by:
    
    getProfiles in interface ProjectBuildingRequest
  - getBuildStartTime
```
public Date getBuildStartTime()
```
    Description copied from interface: ProjectBuildingRequest
    
    Gets the start time of the build.
    
    Specified by:
    
    getBuildStartTime in interface ProjectBuildingRequest
    
    Returns:
    The start time of the build or null if unknown.
  - setBuildStartTime
```
public void setBuildStartTime(Date buildStartTime)
```
    Description copied from interface: ProjectBuildingRequest
    
    Sets the start time of the build.
    
    Specified by:
    
    setBuildStartTime in interface ProjectBuildingRequest
    
    Parameters:
    buildStartTime - The start time of the build, may be null.
  - getRepositorySession
```
public org.eclipse.aether.RepositorySystemSession getRepositorySession()
```
    Specified by:
    
    getRepositorySession in interface ProjectBuildingRequest
  - setRepositorySession
```
public DefaultProjectBuildingRequest setRepositorySession(org.eclipse.aether.RepositorySystemSession repositorySession)
```
    Specified by:
    
    setRepositorySession in interface ProjectBuildingRequest
  - setRepositoryMerging
```
public DefaultProjectBuildingRequest setRepositoryMerging(ProjectBuildingRequest.RepositoryMerging repositoryMerging)
```
    Description copied from interface: ProjectBuildingRequest
    
    Sets the merge mode used to combine repositories declared in the POM with the repositories specified in this request.
    
    Specified by:
    
    setRepositoryMerging in interface ProjectBuildingRequest
    
    Parameters:
    repositoryMerging - The repository merge mode, must not be null.
    
    Returns:
    This request for chaining, never null.
    See Also:
    ProjectBuildingRequest.setRemoteRepositories(List)
  - getRepositoryMerging
```
public ProjectBuildingRequest.RepositoryMerging getRepositoryMerging()
```
    Description copied from interface: ProjectBuildingRequest
    
    Gets the merge mode used to combine repositories declared in the POM with the repositories specified in this request
    
    Specified by:
    
    getRepositoryMerging in interface ProjectBuildingRequest
    
    Returns:
    The merge mode, never null.

Class DefaultProjectBuildingRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.maven.project.ProjectBuildingRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultProjectBuildingRequest

DefaultProjectBuildingRequest

Method Detail

getProject

setProject

setLocalRepository

getLocalRepository

getRemoteRepositories

setRemoteRepositories

getPluginArtifactRepositories

setPluginArtifactRepositories

getSystemProperties

setSystemProperties

getUserProperties

setUserProperties

isProcessPlugins

setProcessPlugins

setResolveDependencies

isResolveDependencies

setResolveVersionRanges

isResolveVersionRanges

setValidationLevel

getValidationLevel

getActiveProfileIds

setActiveProfileIds

getInactiveProfileIds

setInactiveProfileIds

setProfiles

addProfile

getProfiles

getBuildStartTime

setBuildStartTime

getRepositorySession

setRepositorySession

setRepositoryMerging

getRepositoryMerging