org.apache.maven.model
Class Model

java.lang.Object
  extended byorg.apache.maven.model.ModelBase
      extended byorg.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

Field Summary
private  java.lang.String artifactId
          Field artifactId
private  java.util.List branches
          Field branches
private  Build build
          Field build
private  java.util.List contributors
          Field contributors
private  java.lang.String currentVersion
          Field currentVersion
private  java.lang.String description
          Field description
private  java.util.List developers
          Field developers
private  java.lang.String distributionDirectory
          Field distributionDirectory
private  java.lang.String distributionSite
          Field distributionSite
private  java.lang.String extend
          Field extend
private  java.lang.String groupId
          Field groupId
private  java.lang.String gumpRepositoryId
          Field gumpRepositoryId
private  java.lang.String id
          Field id
private  java.lang.String inceptionYear
          Field inceptionYear
private  java.lang.String issueTrackingUrl
          Field issueTrackingUrl
private  java.util.List licenses
          Field licenses
private  java.lang.String logo
          Field logo
private  java.util.List mailingLists
          Field mailingLists
private  java.lang.String modelEncoding
           
private  java.lang.String name
          Field name
private  Organization organization
          Field organization
private  java.util.List packageGroups
          Field packageGroups
private  java.lang.String packageName
          Field packageName
private  java.lang.String pomVersion
          Field pomVersion
private  java.util.Properties properties
          Field properties
private  java.util.List reports
          Field reports
private  Repository repository
          Field repository
private  java.lang.String shortDescription
          Field shortDescription
private  java.lang.String siteAddress
          Field siteAddress
private  java.lang.String siteDirectory
          Field siteDirectory
private  java.lang.String url
          Field url
private  java.util.List versions
          Field versions
 
Fields inherited from class org.apache.maven.model.ModelBase
 
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 short name of the project.
 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 project.
 java.lang.String getDescription()
          Get Optional.
 java.util.List getDevelopers()
          Method getDevelopers
 java.lang.String getDistributionDirectory()
          Get Optional.
 java.lang.String getDistributionSite()
          Get Optional.
 java.lang.String getExtend()
          Get The location of the parent project, if one exists.
 java.lang.String getGroupId()
          Get The short name of the project group.
 java.lang.String getGumpRepositoryId()
          Get Optional.
 java.lang.String getId()
          Get The short name of the project.
 java.lang.String getInceptionYear()
          Get The year of the project's inception specified with 4 digits.
 java.lang.String getIssueTrackingUrl()
          Get Optional.
 java.util.List getLicenses()
          Method getLicenses
 java.lang.String getLogo()
          Get The URL to 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 The current version of the Maven project descriptor.
 java.util.Properties getProperties()
          Method getProperties
 java.util.List getReports()
          Method getReports
 Repository getRepository()
          Get Specification for the SCM used by the project.
 java.lang.String getShortDescription()
          Get A short description of the project.
 java.lang.String getSiteAddress()
          Get Optional.
 java.lang.String getSiteDirectory()
          Get Optional.
 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 short name of the project.
 void setBranches(java.util.List branches)
          Set Optional.
 void setBuild(Build build)
          Set Information required to build the project.
 void setContributors(java.util.List contributors)
          Set Describes the contributors to a project.
 void setCurrentVersion(java.lang.String currentVersion)
          Set The current version of the project.
 void setDescription(java.lang.String description)
          Set Optional.
 void setDevelopers(java.util.List developers)
          Set Describes the committers to a project.
 void setDistributionDirectory(java.lang.String distributionDirectory)
          Set Optional.
 void setDistributionSite(java.lang.String distributionSite)
          Set Optional.
 void setExtend(java.lang.String extend)
          Set The location of the parent project, if one exists.
 void setGroupId(java.lang.String groupId)
          Set The short name of the project group.
 void setGumpRepositoryId(java.lang.String gumpRepositoryId)
          Set Optional.
 void setId(java.lang.String id)
          Set The short name of the project.
 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 Optional.
 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 to 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 The current version of the Maven project descriptor.
 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.
 void setShortDescription(java.lang.String shortDescription)
          Set A short description of the project.
 void setSiteAddress(java.lang.String siteAddress)
          Set Optional.
 void setSiteDirectory(java.lang.String siteDirectory)
          Set Optional.
 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 Optional.
 
Methods inherited from class org.apache.maven.model.ModelBase
addDependency, getDependencies, removeDependency, setDependencies
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

extend

private java.lang.String extend
Field extend


pomVersion

private java.lang.String pomVersion
Field pomVersion


id

private java.lang.String id
Field id


groupId

private java.lang.String groupId
Field groupId


artifactId

private java.lang.String artifactId
Field artifactId


name

private java.lang.String name
Field name


currentVersion

private java.lang.String currentVersion
Field currentVersion


shortDescription

private java.lang.String shortDescription
Field shortDescription


description

private java.lang.String description
Field description


url

private java.lang.String url
Field url


logo

private java.lang.String logo
Field logo


issueTrackingUrl

private java.lang.String issueTrackingUrl
Field issueTrackingUrl


inceptionYear

private java.lang.String inceptionYear
Field inceptionYear


gumpRepositoryId

private java.lang.String gumpRepositoryId
Field gumpRepositoryId


siteAddress

private java.lang.String siteAddress
Field siteAddress


siteDirectory

private java.lang.String siteDirectory
Field siteDirectory


distributionSite

private java.lang.String distributionSite
Field distributionSite


distributionDirectory

private java.lang.String distributionDirectory
Field distributionDirectory


mailingLists

private java.util.List mailingLists
Field mailingLists


developers

private java.util.List developers
Field developers


contributors

private java.util.List contributors
Field contributors


licenses

private java.util.List licenses
Field licenses


versions

private java.util.List versions
Field versions


branches

private java.util.List branches
Field branches


packageGroups

private java.util.List packageGroups
Field packageGroups


reports

private java.util.List reports
Field reports


repository

private Repository repository
Field repository


organization

private Organization organization
Field organization


properties

private java.util.Properties properties
Field properties


packageName

private java.lang.String packageName
Field packageName


build

private Build build
Field build


modelEncoding

private java.lang.String modelEncoding
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 short name of the project. This value is used in conjunction with groupId when naming jars and distribution files.


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 project. This value is used when naming jars and distribution files.


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


getDistributionDirectory

public java.lang.String getDistributionDirectory()
Get Optional. 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 Optional. The server 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.
<extend>${basedir}/../project.xml</extend>


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.


getGumpRepositoryId

public java.lang.String getGumpRepositoryId()
Get Optional. This is the Id of the Gump repository that this project is part of (assuming it participates in the Gump integration effort).


getId

public java.lang.String getId()
Get The short name of the project. This value is used when naming jars and distribution files.


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.


getIssueTrackingUrl

public java.lang.String getIssueTrackingUrl()
Get Optional. The URL to the project's issue tracking system.


getLicenses

public java.util.List getLicenses()
Method getLicenses


getLogo

public java.lang.String getLogo()
Get The URL to 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. 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).


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 The current version of the Maven project descriptor. This version number enables Maven to automatically update an out-of-date project descriptor when a new version is available. This version number should not be changed after the descriptor has been created. Maven will update it automatically.


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.


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 Optional. 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 Optional. 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 short name of the project. This value is used in conjunction with groupId when naming jars and distribution files.

Parameters:
artifactId -

setBranches

public void setBranches(java.util.List branches)
Set Optional. Contains information on branches of the project. This information is used when invoking the maven:dist target.

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. This is used to generate the Project Team page of the project's web site.

Parameters:
contributors -

setCurrentVersion

public void setCurrentVersion(java.lang.String currentVersion)
Set The current version of the project. This value is used when naming jars and distribution files.

Parameters:
currentVersion -

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 -

setDistributionDirectory

public void setDistributionDirectory(java.lang.String distributionDirectory)
Set Optional. 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 Optional. The server 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.
<extend>${basedir}/../project.xml</extend>

Parameters:
extend -

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 -

setGumpRepositoryId

public void setGumpRepositoryId(java.lang.String gumpRepositoryId)
Set Optional. This is the Id of the Gump repository that this project is part of (assuming it participates in the Gump integration effort).

Parameters:
gumpRepositoryId -

setId

public void setId(java.lang.String id)
Set The short name of the project. This value is used when naming jars and distribution files.

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

Parameters:
inceptionYear -

setIssueTrackingUrl

public void setIssueTrackingUrl(java.lang.String issueTrackingUrl)
Set Optional. The URL to 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 (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 -

setLogo

public void setLogo(java.lang.String logo)
Set The URL to 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. This is used to generate the front page of the site's web site.

Parameters:
mailingLists -

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 -

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 The current version of the Maven project descriptor. This version number enables Maven to automatically update an out-of-date project descriptor when a new version is available. This version number should not be changed after the descriptor has been created. Maven will update it automatically.

Parameters:
pomVersion -

setProperties

public void setProperties(java.util.Properties properties)
Set Project properties that will be used by various plugins

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.

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 Optional. 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 Optional. 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 Optional. Contains information on previous versions of the project. This information is used when invoking the maven:dist target.

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