org.apache.maven.model
Class Model

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

All Implemented Interfaces:

java.io.Serializable

public class Model

extends ModelBase

implements java.io.Serializable

The <project> element specifies various attributes about a project. This is the root element of the project descriptor. The following table lists all of the possible child elements. Child elements with children are then documented further in subsequent sections.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Model()

Method Summary

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	addProfile(Profile profile) Method addProfile
java.lang.String	getArtifactId() Get The short name of the project.
Build	getBuild() Get Information required to build the project.
CiManagement	getCiManagement() Get The project's continuous integration management information.
java.util.List	getContributors() Method getContributors
java.lang.String	getDescription() Get Optional.
java.util.List	getDevelopers() Method getDevelopers
java.lang.String	getGroupId() Get The short name of the project group.
java.lang.String	getId()
java.lang.String	getInceptionYear() Get The year of the project's inception specified with 4 digits.
IssueManagement	getIssueManagement() Get The project's issue management information.
java.util.List	getLicenses() Method getLicenses
java.util.List	getMailingLists() Method getMailingLists
java.lang.String	getModelEncoding()
java.lang.String	getModelVersion() Get Declares to which version of project descriptor this POM conforms.
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	getPackaging() Get The type of artifact this project produces.
Parent	getParent() Get Information on which parent POM to extend.
Prerequisites	getPrerequisites() Get Describes the prerequisites in the build environment for this project.
java.util.List	getProfiles() Method getProfiles
Scm	getScm() Get Specification for the SCM used by the project.
java.lang.String	getUrl() Get The URL to the project's homepage.
java.lang.String	getVersion() Get The current version of the artifact produced by this project.
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	removeProfile(Profile profile) Method removeProfile
void	setArtifactId(java.lang.String artifactId) Set The short name of the project.
void	setBuild(Build build) Set Information required to build the project.
void	setCiManagement(CiManagement ciManagement) Set The project's continuous integration management information.
void	setContributors(java.util.List contributors) Set Describes the contributors to a project.
void	setDescription(java.lang.String description) Set Optional.
void	setDevelopers(java.util.List developers) Set Describes the committers to a project.
void	setGroupId(java.lang.String groupId) Set The short name of the project group.
void	setInceptionYear(java.lang.String inceptionYear) Set The year of the project's inception specified with 4 digits.
void	setIssueManagement(IssueManagement issueManagement) Set The project's issue management information.
void	setLicenses(java.util.List licenses) Set This element describes all of the licenses for this project.
void	setMailingLists(java.util.List mailingLists) Set Contains information about a project's mailing lists.
void	setModelEncoding(java.lang.String modelEncoding)
void	setModelVersion(java.lang.String modelVersion) Set Declares to which version of project descriptor this POM conforms.
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	setPackaging(java.lang.String packaging) Set The type of artifact this project produces.
void	setParent(Parent parent) Set Information on which parent POM to extend.
void	setPrerequisites(Prerequisites prerequisites) Set Describes the prerequisites in the build environment for this project.
void	setProfiles(java.util.List profiles) Set Listing of project-local build profiles which will modify the build process when activated.
void	setScm(Scm scm) Set Specification for the SCM used by the project.
void	setUrl(java.lang.String url) Set The URL to the project's homepage.
void	setVersion(java.lang.String version) Set The current version of the artifact produced by this project.

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

addDependency, addModule, addPluginRepository, addProperty, addRepository, getDependencies, getDependencyManagement, getDistributionManagement, getModules, getPluginRepositories, getProperties, getReporting, getReports, getRepositories, removeDependency, removeModule, removePluginRepository, removeRepository, setDependencies, setDependencyManagement, setDistributionManagement, setModules, setPluginRepositories, setProperties, setReporting, setReports, setRepositories

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

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 -

addProfile

public void addProfile(Profile profile)

Method addProfile

Parameters:

profile -

getArtifactId

public java.lang.String getArtifactId()

Get The short name of the project. This value is used in conjunction with groupId when naming jars and distribution files.

getBuild

public Build getBuild()

Get Information required to build the project.

getCiManagement

public CiManagement getCiManagement()

Get The project's continuous integration management information.

getContributors

public java.util.List getContributors()

Method getContributors

getDescription

public java.lang.String getDescription()

Get Optional. A detailed description of the project. This description is used as the default to generate the Mailing Lists of the project's web site, and is shown when maven --usage is called on the project. While this element can be specified as CDATA to enable the use of HTML tags within the description, you are encouraged to provide an alternative home page using xdocs/index.xml if this is required.

getDevelopers

public java.util.List getDevelopers()

Method getDevelopers

getGroupId

public java.lang.String getGroupId()

Get The short name of the project group. This value is used to group all jars for a project in one directory. For more info look at the user guide.

getInceptionYear

public java.lang.String getInceptionYear()

Get The year of the project's inception specified with 4 digits. This value is used when generating JavaDoc copyright notices.

getIssueManagement

public IssueManagement getIssueManagement()

Get The project's issue management information.

getLicenses

public java.util.List getLicenses()

Method getLicenses

getMailingLists

public java.util.List getMailingLists()

Method getMailingLists

getModelVersion

public java.lang.String getModelVersion()

Get Declares to which version of project descriptor this POM conforms.

getName

public java.lang.String getName()

Get The full name of the project. This value is used when generating JavaDoc titles.

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).

getPackaging

public java.lang.String getPackaging()

Get The type of artifact this project produces.

getParent

public Parent getParent()

Get Information on which parent POM to extend.

getPrerequisites

public Prerequisites getPrerequisites()

Get Describes the prerequisites in the build environment for this project.

getProfiles

public java.util.List getProfiles()

Method getProfiles

getScm

public Scm getScm()

Get Specification for the SCM used by the project.

getUrl

public java.lang.String getUrl()

Get The URL to the project's homepage.

getVersion

public java.lang.String getVersion()

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

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 -

removeProfile

public void removeProfile(Profile profile)

Method removeProfile

Parameters:

profile -

setArtifactId

public void setArtifactId(java.lang.String artifactId)

Set The short name of the project. This value is used in conjunction with groupId when naming jars and distribution files.

Parameters:

artifactId -

setBuild

public void setBuild(Build build)

Set Information required to build the project.

Parameters:

build -

setCiManagement

public void setCiManagement(CiManagement ciManagement)

Set The project's continuous integration management information.

Parameters:

ciManagement -

setContributors

public void setContributors(java.util.List contributors)

Set Describes the contributors to a project. This is used to generate the Project Team page of the project's web site.

Parameters:

contributors -

setDescription

public void setDescription(java.lang.String description)

Set Optional. A detailed description of the project. This description is used as the default to generate the Mailing Lists of the project's web site, and is shown when maven --usage is called on the project. While this element can be specified as CDATA to enable the use of HTML tags within the description, you are encouraged to provide an alternative home page using xdocs/index.xml if this is required.

Parameters:

description -

setDevelopers

public void setDevelopers(java.util.List developers)

Set Describes the committers to a project. This is used to generate the Project Team page of the project's web site.

Parameters:

developers -

setGroupId

public void setGroupId(java.lang.String groupId)

Set The short name of the project group. This value is used to group all jars for a project in one directory. For more info look at the user guide.

Parameters:

groupId -

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 JavaDoc copyright notices.

Parameters:

inceptionYear -

setIssueManagement

public void setIssueManagement(IssueManagement issueManagement)

Set The project's issue management information.

Parameters:

issueManagement -

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 (described below). The auto-generated site documentation references this information. Projects should only list the license(s) that applies to the project and not the licenses that apply to dependencies.

Parameters:

licenses -

setMailingLists

public void setMailingLists(java.util.List mailingLists)

Set Contains information about a project's mailing lists. This is used to generate the front page of the site's web site.

Parameters:

mailingLists -

setModelVersion

public void setModelVersion(java.lang.String modelVersion)

Set Declares to which version of project descriptor this POM conforms.

Parameters:

modelVersion -

setName

public void setName(java.lang.String name)

Set The full name of the project. This value is used when generating JavaDoc titles.

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 -

setPackaging

public void setPackaging(java.lang.String packaging)

Set The type of artifact this project produces.

Parameters:

packaging -

setParent

public void setParent(Parent parent)

Set Information on which parent POM to extend.

Parameters:

parent -

setPrerequisites

public void setPrerequisites(Prerequisites prerequisites)

Set Describes the prerequisites in the build environment for this project.

Parameters:

prerequisites -

setProfiles

public void setProfiles(java.util.List profiles)

Set Listing of project-local build profiles which will modify the build process when activated.

Parameters:

profiles -

setScm

public void setScm(Scm scm)

Set Specification for the SCM used by the project.

Parameters:

scm -

setUrl

public void setUrl(java.lang.String url)

Set The URL to the project's homepage.

Parameters:

url -

setVersion

public void setVersion(java.lang.String version)

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

Parameters:

version -

getId

public java.lang.String getId()

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

Overrides:

setModelEncoding in class ModelBase

getModelEncoding

public java.lang.String getModelEncoding()

Overrides:

getModelEncoding in class ModelBase