Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.project
Class MavenProject

java.lang.Object
  extended by org.apache.maven.project.MavenProject

public class MavenProject
extends java.lang.Object

The concern of the project is provide runtime values based on the model.

The values in the model remain untouched but during the process of building a project notions like inheritance and interpolation can be added. This allows to have an entity which is useful in a runtime while preserving the model so that it can be marshalled and unmarshalled without being tainted by runtime requirements.

We need to leave the model intact because we don't want the following:

  1. We don't want interpolated values being written back into the model.
  2. We don't want inherited values being written back into the model.

Field Summary
static java.lang.String EMPTY_PROJECT_ARTIFACT_ID
           
static java.lang.String EMPTY_PROJECT_GROUP_ID
           
static java.lang.String EMPTY_PROJECT_VERSION
           
 
Constructor Summary
MavenProject()
           
MavenProject(MavenProject project)
           
MavenProject(org.apache.maven.model.Model model)
           
 
Method Summary
 void addAttachedArtifact(org.apache.maven.artifact.Artifact artifact)
           
 void addCompileSourceRoot(java.lang.String path)
           
 void addContributor(org.apache.maven.model.Contributor contributor)
           
 void addDeveloper(org.apache.maven.model.Developer developer)
           
 void addLicense(org.apache.maven.model.License license)
           
 void addMailingList(org.apache.maven.model.MailingList mailingList)
           
 void addPlugin(org.apache.maven.model.Plugin plugin)
           
 void addProjectReference(MavenProject project)
           
 void addResource(org.apache.maven.model.Resource resource)
           
 void addScriptSourceRoot(java.lang.String path)
           
 void addTestCompileSourceRoot(java.lang.String path)
           
 void addTestResource(org.apache.maven.model.Resource testResource)
           
 void attachArtifact(java.lang.String type, java.lang.String classifier, java.io.File file)
          Deprecated. Use MavenProjectHelper.attachArtifact(..) instead.
 java.util.Set createArtifacts(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, java.lang.String inheritedScope, org.apache.maven.artifact.resolver.filter.ArtifactFilter dependencyFilter)
           
 boolean equals(java.lang.Object other)
           
 java.util.List getActiveProfiles()
           
 org.apache.maven.artifact.Artifact getArtifact()
           
 java.lang.String getArtifactId()
           
 java.util.Map getArtifactMap()
           
 java.util.Set getArtifacts()
          All dependencies that this project has, including transitive ones.
 java.util.List getAttachedArtifacts()
           
 java.io.File getBasedir()
           
 org.apache.maven.model.Build getBuild()
           
 java.util.List getBuildExtensions()
           
 java.util.List getBuildPlugins()
           
 org.apache.maven.model.CiManagement getCiManagement()
           
 java.util.List getCollectedProjects()
           
 java.util.List getCompileArtifacts()
           
 java.util.List getCompileClasspathElements()
           
 java.util.List getCompileDependencies()
           
 java.util.List getCompileSourceRoots()
           
 java.util.List getContributors()
           
 java.lang.String getDefaultGoal()
           
 java.util.List getDependencies()
           
 java.util.Set getDependencyArtifacts()
          Direct dependencies that this project has.
 org.apache.maven.model.DependencyManagement getDependencyManagement()
           
 java.lang.String getDescription()
           
 java.util.List getDevelopers()
           
 org.apache.maven.model.DistributionManagement getDistributionManagement()
           
 org.apache.maven.artifact.repository.ArtifactRepository getDistributionManagementArtifactRepository()
           
 MavenProject getExecutionProject()
           
 java.util.Map getExtensionArtifactMap()
           
 java.util.Set getExtensionArtifacts()
           
 java.io.File getFile()
           
 java.util.List getFilters()
           
 org.codehaus.plexus.util.xml.Xpp3Dom getGoalConfiguration(java.lang.String pluginGroupId, java.lang.String pluginArtifactId, java.lang.String executionId, java.lang.String goalId)
           
 java.lang.String getGroupId()
           
 java.lang.String getId()
           
 java.lang.String getInceptionYear()
           
 org.apache.maven.model.IssueManagement getIssueManagement()
           
 java.util.List getLicenses()
           
 java.util.List getMailingLists()
           
 java.util.Map getManagedVersionMap()
           
 org.apache.maven.model.Model getModel()
           
 java.lang.String getModelVersion()
           
 java.lang.String getModulePathAdjustment(MavenProject moduleProject)
           
 java.util.List getModules()
           
 java.lang.String getName()
           
 org.apache.maven.model.Organization getOrganization()
           
 org.apache.maven.model.Model getOriginalModel()
           
 java.lang.String getPackaging()
           
 MavenProject getParent()
           
 org.apache.maven.artifact.Artifact getParentArtifact()
           
 java.util.Map getPluginArtifactMap()
           
 java.util.List getPluginArtifactRepositories()
           
 java.util.Set getPluginArtifacts()
           
 org.apache.maven.model.PluginManagement getPluginManagement()
           
 java.util.List getPluginRepositories()
           
 org.apache.maven.model.Prerequisites getPrerequisites()
           
 java.util.Map getProjectReferences()
           
 java.util.Properties getProperties()
           
 java.util.List getRemoteArtifactRepositories()
           
 java.util.Map getReportArtifactMap()
           
 java.util.Set getReportArtifacts()
           
 org.codehaus.plexus.util.xml.Xpp3Dom getReportConfiguration(java.lang.String pluginGroupId, java.lang.String pluginArtifactId, java.lang.String reportSetId)
           
 org.apache.maven.model.Reporting getReporting()
           
 java.util.List getReportPlugins()
           
 java.util.List getRepositories()
           
 java.util.List getResources()
           
 java.util.List getRuntimeArtifacts()
           
 java.util.List getRuntimeClasspathElements()
           
 java.util.List getRuntimeDependencies()
           
 org.apache.maven.model.Scm getScm()
           
 java.util.List getScriptSourceRoots()
           
 java.util.List getSystemArtifacts()
           
 java.util.List getSystemClasspathElements()
           
 java.util.List getSystemDependencies()
           
 java.util.List getTestArtifacts()
           
 java.util.List getTestClasspathElements()
           
 java.util.List getTestCompileSourceRoots()
           
 java.util.List getTestDependencies()
           
 java.util.List getTestResources()
           
 java.lang.String getUrl()
           
 java.lang.String getVersion()
           
 int hashCode()
           
 boolean hasParent()
           
 void injectPluginManagementInfo(org.apache.maven.model.Plugin plugin)
           
 boolean isExecutionRoot()
           
 org.apache.maven.artifact.Artifact replaceWithActiveArtifact(org.apache.maven.artifact.Artifact pluginArtifact)
           
 void setActiveProfiles(java.util.List activeProfiles)
           
 void setArtifact(org.apache.maven.artifact.Artifact artifact)
           
 void setArtifactId(java.lang.String artifactId)
           
 void setArtifacts(java.util.Set artifacts)
           
 void setBuild(org.apache.maven.model.Build build)
           
 void setCiManagement(org.apache.maven.model.CiManagement ciManagement)
           
 void setCollectedProjects(java.util.List collectedProjects)
           
 void setContributors(java.util.List contributors)
           
 void setDependencies(java.util.List dependencies)
           
 void setDependencyArtifacts(java.util.Set dependencyArtifacts)
           
 void setDescription(java.lang.String description)
           
 void setDevelopers(java.util.List developers)
           
 void setDistributionManagement(org.apache.maven.model.DistributionManagement distributionManagement)
           
 void setExecutionProject(MavenProject executionProject)
           
 void setExecutionRoot(boolean executionRoot)
           
 void setExtensionArtifacts(java.util.Set extensionArtifacts)
           
 void setFile(java.io.File file)
           
 void setGroupId(java.lang.String groupId)
           
 void setInceptionYear(java.lang.String inceptionYear)
           
 void setIssueManagement(org.apache.maven.model.IssueManagement issueManagement)
           
 void setLicenses(java.util.List licenses)
           
 void setMailingLists(java.util.List mailingLists)
           
 void setManagedVersionMap(java.util.Map map)
           
 void setModelVersion(java.lang.String pomVersion)
           
 void setName(java.lang.String name)
           
 void setOrganization(org.apache.maven.model.Organization organization)
           
 void setOriginalModel(org.apache.maven.model.Model originalModel)
           
 void setPackaging(java.lang.String packaging)
           
 void setParent(MavenProject parent)
           
 void setParentArtifact(org.apache.maven.artifact.Artifact parentArtifact)
           
 void setPluginArtifactRepositories(java.util.List pluginArtifactRepositories)
           
 void setPluginArtifacts(java.util.Set pluginArtifacts)
           
 void setReleaseArtifactRepository(org.apache.maven.artifact.repository.ArtifactRepository releaseArtifactRepository)
           
 void setRemoteArtifactRepositories(java.util.List remoteArtifactRepositories)
           
 void setReportArtifacts(java.util.Set reportArtifacts)
           
 void setReporting(org.apache.maven.model.Reporting reporting)
           
 void setScm(org.apache.maven.model.Scm scm)
           
 void setSnapshotArtifactRepository(org.apache.maven.artifact.repository.ArtifactRepository snapshotArtifactRepository)
           
 void setUrl(java.lang.String url)
           
 void setVersion(java.lang.String version)
           
 void writeModel(java.io.Writer writer)
           
 void writeOriginalModel(java.io.Writer writer)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EMPTY_PROJECT_GROUP_ID

public static final java.lang.String EMPTY_PROJECT_GROUP_ID
See Also:
Constant Field Values

EMPTY_PROJECT_ARTIFACT_ID

public static final java.lang.String EMPTY_PROJECT_ARTIFACT_ID
See Also:
Constant Field Values

EMPTY_PROJECT_VERSION

public static final java.lang.String EMPTY_PROJECT_VERSION
See Also:
Constant Field Values
Constructor Detail

MavenProject

public MavenProject()

MavenProject

public MavenProject(org.apache.maven.model.Model model)

MavenProject

public MavenProject(MavenProject project)
Method Detail

getModulePathAdjustment

public java.lang.String getModulePathAdjustment(MavenProject moduleProject)
                                         throws java.io.IOException
Throws:
java.io.IOException

getArtifact

public org.apache.maven.artifact.Artifact getArtifact()

setArtifact

public void setArtifact(org.apache.maven.artifact.Artifact artifact)

getModel

public org.apache.maven.model.Model getModel()

getParent

public MavenProject getParent()

setParent

public void setParent(MavenProject parent)

setRemoteArtifactRepositories

public void setRemoteArtifactRepositories(java.util.List remoteArtifactRepositories)

getRemoteArtifactRepositories

public java.util.List getRemoteArtifactRepositories()

hasParent

public boolean hasParent()

getFile

public java.io.File getFile()

setFile

public void setFile(java.io.File file)

getBasedir

public java.io.File getBasedir()

setDependencies

public void setDependencies(java.util.List dependencies)

getDependencies

public java.util.List getDependencies()

getDependencyManagement

public org.apache.maven.model.DependencyManagement getDependencyManagement()

addCompileSourceRoot

public void addCompileSourceRoot(java.lang.String path)

addScriptSourceRoot

public void addScriptSourceRoot(java.lang.String path)

addTestCompileSourceRoot

public void addTestCompileSourceRoot(java.lang.String path)

getCompileSourceRoots

public java.util.List getCompileSourceRoots()

getScriptSourceRoots

public java.util.List getScriptSourceRoots()

getTestCompileSourceRoots

public java.util.List getTestCompileSourceRoots()

getCompileClasspathElements

public java.util.List getCompileClasspathElements()
                                           throws org.apache.maven.artifact.DependencyResolutionRequiredException
Throws:
org.apache.maven.artifact.DependencyResolutionRequiredException

getCompileArtifacts

public java.util.List getCompileArtifacts()

getCompileDependencies

public java.util.List getCompileDependencies()

getTestClasspathElements

public java.util.List getTestClasspathElements()
                                        throws org.apache.maven.artifact.DependencyResolutionRequiredException
Throws:
org.apache.maven.artifact.DependencyResolutionRequiredException

getTestArtifacts

public java.util.List getTestArtifacts()

getTestDependencies

public java.util.List getTestDependencies()

getRuntimeClasspathElements

public java.util.List getRuntimeClasspathElements()
                                           throws org.apache.maven.artifact.DependencyResolutionRequiredException
Throws:
org.apache.maven.artifact.DependencyResolutionRequiredException

getRuntimeArtifacts

public java.util.List getRuntimeArtifacts()

getRuntimeDependencies

public java.util.List getRuntimeDependencies()

getSystemClasspathElements

public java.util.List getSystemClasspathElements()
                                          throws org.apache.maven.artifact.DependencyResolutionRequiredException
Throws:
org.apache.maven.artifact.DependencyResolutionRequiredException

getSystemArtifacts

public java.util.List getSystemArtifacts()

getSystemDependencies

public java.util.List getSystemDependencies()

setModelVersion

public void setModelVersion(java.lang.String pomVersion)

getModelVersion

public java.lang.String getModelVersion()

getId

public java.lang.String getId()

setGroupId

public void setGroupId(java.lang.String groupId)

getGroupId

public java.lang.String getGroupId()

setArtifactId

public void setArtifactId(java.lang.String artifactId)

getArtifactId

public java.lang.String getArtifactId()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setVersion

public void setVersion(java.lang.String version)

getVersion

public java.lang.String getVersion()

getPackaging

public java.lang.String getPackaging()

setPackaging

public void setPackaging(java.lang.String packaging)

setInceptionYear

public void setInceptionYear(java.lang.String inceptionYear)

getInceptionYear

public java.lang.String getInceptionYear()

setUrl

public void setUrl(java.lang.String url)

getUrl

public java.lang.String getUrl()

getPrerequisites

public org.apache.maven.model.Prerequisites getPrerequisites()

setIssueManagement

public void setIssueManagement(org.apache.maven.model.IssueManagement issueManagement)

getCiManagement

public org.apache.maven.model.CiManagement getCiManagement()

setCiManagement

public void setCiManagement(org.apache.maven.model.CiManagement ciManagement)

getIssueManagement

public org.apache.maven.model.IssueManagement getIssueManagement()

setDistributionManagement

public void setDistributionManagement(org.apache.maven.model.DistributionManagement distributionManagement)

getDistributionManagement

public org.apache.maven.model.DistributionManagement getDistributionManagement()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setOrganization

public void setOrganization(org.apache.maven.model.Organization organization)

getOrganization

public org.apache.maven.model.Organization getOrganization()

setScm

public void setScm(org.apache.maven.model.Scm scm)

getScm

public org.apache.maven.model.Scm getScm()

setMailingLists

public void setMailingLists(java.util.List mailingLists)

getMailingLists

public java.util.List getMailingLists()

addMailingList

public void addMailingList(org.apache.maven.model.MailingList mailingList)

setDevelopers

public void setDevelopers(java.util.List developers)

getDevelopers

public java.util.List getDevelopers()

addDeveloper

public void addDeveloper(org.apache.maven.model.Developer developer)

setContributors

public void setContributors(java.util.List contributors)

getContributors

public java.util.List getContributors()

addContributor

public void addContributor(org.apache.maven.model.Contributor contributor)

setBuild

public void setBuild(org.apache.maven.model.Build build)

getBuild

public org.apache.maven.model.Build getBuild()

getResources

public java.util.List getResources()

getTestResources

public java.util.List getTestResources()

addResource

public void addResource(org.apache.maven.model.Resource resource)

addTestResource

public void addTestResource(org.apache.maven.model.Resource testResource)

setReporting

public void setReporting(org.apache.maven.model.Reporting reporting)

getReporting

public org.apache.maven.model.Reporting getReporting()

setLicenses

public void setLicenses(java.util.List licenses)

getLicenses

public java.util.List getLicenses()

addLicense

public void addLicense(org.apache.maven.model.License license)

setArtifacts

public void setArtifacts(java.util.Set artifacts)

getArtifacts

public java.util.Set getArtifacts()
All dependencies that this project has, including transitive ones. Contents are lazily populated, so depending on what phases have run dependencies in some scopes won't be included. eg. if only compile phase has run, dependencies with scope test won't be included.

Returns:
Set < Artifact >
See Also:
to get only direct dependencies

getArtifactMap

public java.util.Map getArtifactMap()

setPluginArtifacts

public void setPluginArtifacts(java.util.Set pluginArtifacts)

getPluginArtifacts

public java.util.Set getPluginArtifacts()

getPluginArtifactMap

public java.util.Map getPluginArtifactMap()

setReportArtifacts

public void setReportArtifacts(java.util.Set reportArtifacts)

getReportArtifacts

public java.util.Set getReportArtifacts()

getReportArtifactMap

public java.util.Map getReportArtifactMap()

setExtensionArtifacts

public void setExtensionArtifacts(java.util.Set extensionArtifacts)

getExtensionArtifacts

public java.util.Set getExtensionArtifacts()

getExtensionArtifactMap

public java.util.Map getExtensionArtifactMap()

setParentArtifact

public void setParentArtifact(org.apache.maven.artifact.Artifact parentArtifact)

getParentArtifact

public org.apache.maven.artifact.Artifact getParentArtifact()

getRepositories

public java.util.List getRepositories()

getReportPlugins

public java.util.List getReportPlugins()

getBuildPlugins

public java.util.List getBuildPlugins()

getModules

public java.util.List getModules()

getPluginManagement

public org.apache.maven.model.PluginManagement getPluginManagement()

addPlugin

public void addPlugin(org.apache.maven.model.Plugin plugin)

injectPluginManagementInfo

public void injectPluginManagementInfo(org.apache.maven.model.Plugin plugin)

getCollectedProjects

public java.util.List getCollectedProjects()

setCollectedProjects

public void setCollectedProjects(java.util.List collectedProjects)

setPluginArtifactRepositories

public void setPluginArtifactRepositories(java.util.List pluginArtifactRepositories)

getPluginArtifactRepositories

public java.util.List getPluginArtifactRepositories()
Returns:
a list of ArtifactRepository objects constructed from the Repository objects returned by getPluginRepositories.

getDistributionManagementArtifactRepository

public org.apache.maven.artifact.repository.ArtifactRepository getDistributionManagementArtifactRepository()

getPluginRepositories

public java.util.List getPluginRepositories()

setActiveProfiles

public void setActiveProfiles(java.util.List activeProfiles)

getActiveProfiles

public java.util.List getActiveProfiles()

addAttachedArtifact

public void addAttachedArtifact(org.apache.maven.artifact.Artifact artifact)

getAttachedArtifacts

public java.util.List getAttachedArtifacts()

getGoalConfiguration

public org.codehaus.plexus.util.xml.Xpp3Dom getGoalConfiguration(java.lang.String pluginGroupId,
                                                                 java.lang.String pluginArtifactId,
                                                                 java.lang.String executionId,
                                                                 java.lang.String goalId)

getReportConfiguration

public org.codehaus.plexus.util.xml.Xpp3Dom getReportConfiguration(java.lang.String pluginGroupId,
                                                                   java.lang.String pluginArtifactId,
                                                                   java.lang.String reportSetId)

getExecutionProject

public MavenProject getExecutionProject()

setExecutionProject

public void setExecutionProject(MavenProject executionProject)

writeModel

public void writeModel(java.io.Writer writer)
                throws java.io.IOException
Throws:
java.io.IOException

writeOriginalModel

public void writeOriginalModel(java.io.Writer writer)
                        throws java.io.IOException
Throws:
java.io.IOException

getDependencyArtifacts

public java.util.Set getDependencyArtifacts()
Direct dependencies that this project has.

Returns:
Set < Artifact >
See Also:
to get all transitive dependencies

setDependencyArtifacts

public void setDependencyArtifacts(java.util.Set dependencyArtifacts)

setReleaseArtifactRepository

public void setReleaseArtifactRepository(org.apache.maven.artifact.repository.ArtifactRepository releaseArtifactRepository)

setSnapshotArtifactRepository

public void setSnapshotArtifactRepository(org.apache.maven.artifact.repository.ArtifactRepository snapshotArtifactRepository)

setOriginalModel

public void setOriginalModel(org.apache.maven.model.Model originalModel)

getOriginalModel

public org.apache.maven.model.Model getOriginalModel()

setManagedVersionMap

public void setManagedVersionMap(java.util.Map map)

getManagedVersionMap

public java.util.Map getManagedVersionMap()

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getBuildExtensions

public java.util.List getBuildExtensions()

createArtifacts

public java.util.Set createArtifacts(org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                                     java.lang.String inheritedScope,
                                     org.apache.maven.artifact.resolver.filter.ArtifactFilter dependencyFilter)
                              throws InvalidDependencyVersionException
Returns:
Set < Artifact >
Throws:
InvalidDependencyVersionException

addProjectReference

public void addProjectReference(MavenProject project)

attachArtifact

public void attachArtifact(java.lang.String type,
                           java.lang.String classifier,
                           java.io.File file)
Deprecated. Use MavenProjectHelper.attachArtifact(..) instead.

getProperties

public java.util.Properties getProperties()

getFilters

public java.util.List getFilters()

getProjectReferences

public java.util.Map getProjectReferences()

isExecutionRoot

public boolean isExecutionRoot()

setExecutionRoot

public void setExecutionRoot(boolean executionRoot)

getDefaultGoal

public java.lang.String getDefaultGoal()

replaceWithActiveArtifact

public org.apache.maven.artifact.Artifact replaceWithActiveArtifact(org.apache.maven.artifact.Artifact pluginArtifact)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.