org.apache.maven.project
Class Model

java.lang.Object
  org.apache.maven.project.ModelBase
      org.apache.maven.project.Model

All Implemented Interfaces:

java.io.Serializable

public class Model
extends ModelBase
implements java.io.Serializable

The <project> element is the root of the descriptor. The following table lists all of the possible child elements.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Model()

Method Summary

void	addBranch(Branch branch) Method addBranch
void	addContributor(Contributor contributor) Method addContributor
void	addDeveloper(Developer developer) Method addDeveloper
void	addLicense(License license) Method addLicense
void	addMailingList(MailingList mailingList) Method addMailingList
void	addPackageGroup(PackageGroup packageGroup) Method addPackageGroup
void	addProperty(java.lang.String key, java.lang.String value) Method addProperty
void	addReport(java.lang.String string) Method addReport
void	addVersion(Version version) Method addVersion
java.lang.String	getArtifactId() Get The identifier for this artifact that is unique within the group given by the group ID.
java.util.List	getBranches() Method getBranches
Build	getBuild() Get Information required to build the project.
java.util.List	getContributors() Method getContributors
java.lang.String	getCurrentVersion() Get The current version of the artifact produced by this project.
java.lang.String	getDescription() Get A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.
java.util.List	getDevelopers() Method getDevelopers
java.lang.String	getDistributionDirectory() Get The directory on the web server where the final distributions will be published.
java.lang.String	getDistributionSite() Get The server where the final distributions will be published.
java.lang.String	getExtend() Get The location of the parent project, if one exists.
java.lang.String	getGroupId() Get A universally unique identifier for a project.
java.lang.String	getGumpRepositoryId() Get This is the repository identifier in Gump that this project is part of.
java.lang.String	getId() Get Deprecated.
java.lang.String	getInceptionYear() Get The year of the project's inception, specified with 4 digits.
java.lang.String	getIssueTrackingUrl() Get The URL of the project's issue tracking system.
java.util.List	getLicenses() Method getLicenses
java.lang.String	getLogo() Get The URL of the project's logo image.
java.util.List	getMailingLists() Method getMailingLists
java.lang.String	getModelEncoding()
java.lang.String	getName() Get The full name of the project.
Organization	getOrganization() Get This element describes various attributes of the organization to which the project belongs.
java.lang.String	getPackage()
java.util.List	getPackageGroups() Method getPackageGroups
java.lang.String	getPackageName() Get The Java package name of the project.
java.lang.String	getPomVersion() Get Declares to which version of project descriptor this POM conforms.
java.util.Properties	getProperties() Method getProperties
java.util.List	getReports() Method getReports
Repository	getRepository() Get Specification for the SCM used by the project, such as CVS, Subversion, etc.
java.lang.String	getShortDescription() Get A short description of the project.
java.lang.String	getSiteAddress() Get The hostname of the web server that hosts the project's web site.
java.lang.String	getSiteDirectory() Get The directory on the web server where the public web site for this project resides.
java.lang.String	getUrl() Get The URL to the project's homepage.
java.lang.String	getVersion()
java.util.List	getVersions() Method getVersions
void	removeBranch(Branch branch) Method removeBranch
void	removeContributor(Contributor contributor) Method removeContributor
void	removeDeveloper(Developer developer) Method removeDeveloper
void	removeLicense(License license) Method removeLicense
void	removeMailingList(MailingList mailingList) Method removeMailingList
void	removePackageGroup(PackageGroup packageGroup) Method removePackageGroup
void	removeReport(java.lang.String string) Method removeReport
void	removeVersion(Version version) Method removeVersion
void	setArtifactId(java.lang.String artifactId) Set The identifier for this artifact that is unique within the group given by the group ID.
void	setBranches(java.util.List branches) Set Contains information on SCM branches of the project.
void	setBuild(Build build) Set Information required to build the project.
void	setContributors(java.util.List contributors) Set Describes the contributors to a project that are not yet committers.
void	setCurrentVersion(java.lang.String currentVersion) Set The current version of the artifact produced by this project.
void	setDescription(java.lang.String description) Set A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.
void	setDevelopers(java.util.List developers) Set Describes the committers of a project.
void	setDistributionDirectory(java.lang.String distributionDirectory) Set The directory on the web server where the final distributions will be published.
void	setDistributionSite(java.lang.String distributionSite) Set The server where the final distributions will be published.
void	setExtend(java.lang.String extend) Set The location of the parent project, if one exists.
void	setGroupId(java.lang.String groupId) Set A universally unique identifier for a project.
void	setGumpRepositoryId(java.lang.String gumpRepositoryId) Set This is the repository identifier in Gump that this project is part of.
void	setId(java.lang.String id) Set Deprecated.
void	setInceptionYear(java.lang.String inceptionYear) Set The year of the project's inception, specified with 4 digits.
void	setIssueTrackingUrl(java.lang.String issueTrackingUrl) Set The URL of the project's issue tracking system.
void	setLicenses(java.util.List licenses) Set This element describes all of the licenses for this project.
void	setLogo(java.lang.String logo) Set The URL of the project's logo image.
void	setMailingLists(java.util.List mailingLists) Set Contains information about a project's mailing lists.
void	setModelEncoding(java.lang.String modelEncoding)
void	setName(java.lang.String name) Set The full name of the project.
void	setOrganization(Organization organization) Set This element describes various attributes of the organization to which the project belongs.
void	setPackage(java.lang.String packageName)
void	setPackageGroups(java.util.List packageGroups) Set Package groups required for complete javadocs.
void	setPackageName(java.lang.String packageName) Set The Java package name of the project.
void	setPomVersion(java.lang.String pomVersion) Set Declares to which version of project descriptor this POM conforms.
void	setProperties(java.util.Properties properties) Set Project properties that will be used by various plugins.
void	setReports(java.util.List reports) Set This element includes the specification of reports to be included in a Maven-generated site.
void	setRepository(Repository repository) Set Specification for the SCM used by the project, such as CVS, Subversion, etc.
void	setShortDescription(java.lang.String shortDescription) Set A short description of the project.
void	setSiteAddress(java.lang.String siteAddress) Set The hostname of the web server that hosts the project's web site.
void	setSiteDirectory(java.lang.String siteDirectory) Set The directory on the web server where the public web site for this project resides.
void	setUrl(java.lang.String url) Set The URL to the project's homepage.
void	setVersion(java.lang.String version)
void	setVersions(java.util.List versions) Set Contains information on previous versions of the project.

Methods inherited from class org.apache.maven.project.ModelBase

addDependency, getDependencies, removeDependency, setDependencies

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Model

public Model()

Method Detail

addBranch

public void addBranch(Branch branch)

Method addBranch

Parameters:

branch -

addContributor

public void addContributor(Contributor contributor)

Method addContributor

Parameters:

contributor -

addDeveloper

public void addDeveloper(Developer developer)

Method addDeveloper

Parameters:

developer -

addLicense

public void addLicense(License license)

Method addLicense

Parameters:

license -

addMailingList

public void addMailingList(MailingList mailingList)

Method addMailingList

Parameters:

mailingList -

addPackageGroup

public void addPackageGroup(PackageGroup packageGroup)

Method addPackageGroup

Parameters:

packageGroup -

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

Method addProperty

Parameters:

key -

value -

addReport

public void addReport(java.lang.String string)

Method addReport

Parameters:

string -

addVersion

public void addVersion(Version version)

Method addVersion

Parameters:

version -

getArtifactId

public java.lang.String getArtifactId()

Get The identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs.

getBranches

public java.util.List getBranches()

Method getBranches

getBuild

public Build getBuild()

Get Information required to build the project.

getContributors

public java.util.List getContributors()

Method getContributors

getCurrentVersion

public java.lang.String getCurrentVersion()

Get The current version of the artifact produced by this project.

getDescription

public java.lang.String getDescription()

Get A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site, you are able to specify your own instead of adjusting this text.

getDevelopers

public java.util.List getDevelopers()

Method getDevelopers

getDistributionDirectory

public java.lang.String getDistributionDirectory()

Get The directory on the web server where the final distributions will be published. This is used when the distributions are deployed.

getDistributionSite

public java.lang.String getDistributionSite()

Get The server where the final distributions will be published. This is used when the distributions are deployed. If this isn't defined, the central repository is used instead as determined by maven.repo.central and maven.repo.central.directory.

getExtend

public java.lang.String getExtend()

Get The location of the parent project, if one exists. Values from the parent project will be the default for this project if they are left unspecified. The path may be absolute, or relative to the current project.xml file. For example, <extend>${basedir}/../project.xml</extend>.

getGroupId

public java.lang.String getGroupId()

Get A universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg. org.apache.maven).

getGumpRepositoryId

public java.lang.String getGumpRepositoryId()

Get This is the repository identifier in Gump that this project is part of.

getId

public java.lang.String getId()

Get Deprecated. When used, this sets both the groupId and artifactId elements if they were previously empty.

getInceptionYear

public java.lang.String getInceptionYear()

Get The year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.

getIssueTrackingUrl

public java.lang.String getIssueTrackingUrl()

Get The URL of the project's issue tracking system.

getLicenses

public java.util.List getLicenses()

Method getLicenses

getLogo

public java.lang.String getLogo()

Get The URL of the project's logo image. This can be an URL relative to the base directory of the generated web site, (e.g., /images/project-logo.png) or an absolute URL (e.g., http://my.corp/project-logo.png). This is used when generating the project documentation.

getMailingLists

public java.util.List getMailingLists()

Method getMailingLists

getName

public java.lang.String getName()

Get The full name of the project.

getOrganization

public Organization getOrganization()

Get This element describes various attributes of the organization to which the project belongs. These attributes are utilized when documentation is created (for copyright notices and links).

getPackageGroups

public java.util.List getPackageGroups()

Method getPackageGroups

getPackageName

public java.lang.String getPackageName()

Get The Java package name of the project. This value is used when generating JavaDoc.

getPomVersion

public java.lang.String getPomVersion()

Get Declares to which version of project descriptor this POM conforms. The only valid value is 3.

getProperties

public java.util.Properties getProperties()

Method getProperties

getReports

public java.util.List getReports()

Method getReports

getRepository

public Repository getRepository()

Get Specification for the SCM used by the project, such as CVS, Subversion, etc.

getShortDescription

public java.lang.String getShortDescription()

Get A short description of the project. The short description should be limited to a single line.

getSiteAddress

public java.lang.String getSiteAddress()

Get The hostname of the web server that hosts the project's web site. This is used when the web site is deployed.

getSiteDirectory

public java.lang.String getSiteDirectory()

Get The directory on the web server where the public web site for this project resides. This is used when the web site is deployed.

getUrl

public java.lang.String getUrl()

Get The URL to the project's homepage.

getVersions

public java.util.List getVersions()

Method getVersions

removeBranch

public void removeBranch(Branch branch)

Method removeBranch

Parameters:

branch -

removeContributor

public void removeContributor(Contributor contributor)

Method removeContributor

Parameters:

contributor -

removeDeveloper

public void removeDeveloper(Developer developer)

Method removeDeveloper

Parameters:

developer -

removeLicense

public void removeLicense(License license)

Method removeLicense

Parameters:

license -

removeMailingList

public void removeMailingList(MailingList mailingList)

Method removeMailingList

Parameters:

mailingList -

removePackageGroup

public void removePackageGroup(PackageGroup packageGroup)

Method removePackageGroup

Parameters:

packageGroup -

removeReport

public void removeReport(java.lang.String string)

Method removeReport

Parameters:

string -

removeVersion

public void removeVersion(Version version)

Method removeVersion

Parameters:

version -

setArtifactId

public void setArtifactId(java.lang.String artifactId)

Set The identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs.

Parameters:

artifactId -

setBranches

public void setBranches(java.util.List branches)

Set Contains information on SCM branches of the project.

Parameters:

branches -

setBuild

public void setBuild(Build build)

Set Information required to build the project.

Parameters:

build -

setContributors

public void setContributors(java.util.List contributors)

Set Describes the contributors to a project that are not yet committers.

Parameters:

contributors -

setCurrentVersion

public void setCurrentVersion(java.lang.String currentVersion)

Set The current version of the artifact produced by this project.

Parameters:

currentVersion -

setDescription

public void setDescription(java.lang.String description)

Set A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site, you are able to specify your own instead of adjusting this text.

Parameters:

description -

setDevelopers

public void setDevelopers(java.util.List developers)

Set Describes the committers of a project.

Parameters:

developers -

setDistributionDirectory

public void setDistributionDirectory(java.lang.String distributionDirectory)

Set The directory on the web server where the final distributions will be published. This is used when the distributions are deployed.

Parameters:

distributionDirectory -

setDistributionSite

public void setDistributionSite(java.lang.String distributionSite)

Set The server where the final distributions will be published. This is used when the distributions are deployed. If this isn't defined, the central repository is used instead as determined by maven.repo.central and maven.repo.central.directory.

Parameters:

distributionSite -

setExtend

public void setExtend(java.lang.String extend)

Set The location of the parent project, if one exists. Values from the parent project will be the default for this project if they are left unspecified. The path may be absolute, or relative to the current project.xml file. For example, <extend>${basedir}/../project.xml</extend>.

Parameters:

extend -

setGroupId

public void setGroupId(java.lang.String groupId)

Set A universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg. org.apache.maven).

Parameters:

groupId -

setGumpRepositoryId

public void setGumpRepositoryId(java.lang.String gumpRepositoryId)

Set This is the repository identifier in Gump that this project is part of.

Parameters:

gumpRepositoryId -

setId

public void setId(java.lang.String id)

Set Deprecated. When used, this sets both the groupId and artifactId elements if they were previously empty.

Parameters:

id -

setInceptionYear

public void setInceptionYear(java.lang.String inceptionYear)

Set The year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.

Parameters:

inceptionYear -

setIssueTrackingUrl

public void setIssueTrackingUrl(java.lang.String issueTrackingUrl)

Set The URL of the project's issue tracking system.

Parameters:

issueTrackingUrl -

setLicenses

public void setLicenses(java.util.List licenses)

Set This element describes all of the licenses for this project. Each license is described by a license element, which is then described by additional elements. Projects should only list the license(s) that applies to the project and not the licenses that apply to dependencies. If multiple licenses are listed, it is assumed that the user can select any of them, not that they must accept all.

Parameters:

licenses -

setLogo

public void setLogo(java.lang.String logo)

Set The URL of the project's logo image. This can be an URL relative to the base directory of the generated web site, (e.g., /images/project-logo.png) or an absolute URL (e.g., http://my.corp/project-logo.png). This is used when generating the project documentation.

Parameters:

logo -

setMailingLists

public void setMailingLists(java.util.List mailingLists)

Set Contains information about a project's mailing lists.

Parameters:

mailingLists -

setName

public void setName(java.lang.String name)

Set The full name of the project.

Parameters:

name -

setOrganization

public void setOrganization(Organization organization)

Set This element describes various attributes of the organization to which the project belongs. These attributes are utilized when documentation is created (for copyright notices and links).

Parameters:

organization -

setPackageGroups

public void setPackageGroups(java.util.List packageGroups)

Set Package groups required for complete javadocs.

Parameters:

packageGroups -

setPackageName

public void setPackageName(java.lang.String packageName)

Set The Java package name of the project. This value is used when generating JavaDoc.

Parameters:

packageName -

setPomVersion

public void setPomVersion(java.lang.String pomVersion)

Set Declares to which version of project descriptor this POM conforms. The only valid value is 3.

Parameters:

pomVersion -

setProperties

public void setProperties(java.util.Properties properties)

Set Project properties that will be used by various plugins. The format is <name>value</name>.

Parameters:

properties -

setReports

public void setReports(java.util.List reports)

Set This element includes the specification of reports to be included in a Maven-generated site. These reports will be run when a user executes maven site. All of the reports will be included in the navigation bar for browsing in the order they are specified.

Parameters:

reports -

setRepository

public void setRepository(Repository repository)

Set Specification for the SCM used by the project, such as CVS, Subversion, etc.

Parameters:

repository -

setShortDescription

public void setShortDescription(java.lang.String shortDescription)

Set A short description of the project. The short description should be limited to a single line.

Parameters:

shortDescription -

setSiteAddress

public void setSiteAddress(java.lang.String siteAddress)

Set The hostname of the web server that hosts the project's web site. This is used when the web site is deployed.

Parameters:

siteAddress -

setSiteDirectory

public void setSiteDirectory(java.lang.String siteDirectory)

Set The directory on the web server where the public web site for this project resides. This is used when the web site is deployed.

Parameters:

siteDirectory -

setUrl

public void setUrl(java.lang.String url)

Set The URL to the project's homepage.

Parameters:

url -

setVersions

public void setVersions(java.util.List versions)

Set Contains information on previous versions of the project.

Parameters:

versions -

setVersion

public void setVersion(java.lang.String version)

getVersion

public java.lang.String getVersion()

setPackage

public void setPackage(java.lang.String packageName)

getPackage

public java.lang.String getPackage()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

Overrides:

setModelEncoding in class ModelBase

getModelEncoding

public java.lang.String getModelEncoding()

Overrides:

getModelEncoding in class ModelBase