|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.project.ModelBase
org.apache.maven.project.Model
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.
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.project.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.project.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 |
private java.lang.String extend
private java.lang.String pomVersion
private java.lang.String id
private java.lang.String groupId
private java.lang.String artifactId
private java.lang.String name
private java.lang.String currentVersion
private java.lang.String shortDescription
private java.lang.String description
private java.lang.String url
private java.lang.String logo
private java.lang.String issueTrackingUrl
private java.lang.String inceptionYear
private java.lang.String gumpRepositoryId
private java.lang.String siteAddress
private java.lang.String siteDirectory
private java.lang.String distributionSite
private java.lang.String distributionDirectory
private java.util.List mailingLists
private java.util.List developers
private java.util.List contributors
private java.util.List licenses
private java.util.List versions
private java.util.List branches
private java.util.List packageGroups
private java.util.List reports
private Repository repository
private Organization organization
private java.util.Properties properties
private java.lang.String packageName
private Build build
private java.lang.String modelEncoding
Constructor Detail |
public Model()
Method Detail |
public void addBranch(Branch branch)
branch
- public void addContributor(Contributor contributor)
contributor
- public void addDeveloper(Developer developer)
developer
- public void addLicense(License license)
license
- public void addMailingList(MailingList mailingList)
mailingList
- public void addPackageGroup(PackageGroup packageGroup)
packageGroup
- public void addProperty(java.lang.String key, java.lang.String value)
key
- value
- public void addReport(java.lang.String string)
string
- public void addVersion(Version version)
version
- public java.lang.String getArtifactId()
groupId
when naming jars and
distribution
files.
public java.util.List getBranches()
public Build getBuild()
public java.util.List getContributors()
public java.lang.String getCurrentVersion()
public java.lang.String getDescription()
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.
public java.util.List getDevelopers()
public java.lang.String getDistributionDirectory()
public java.lang.String getDistributionSite()
If this isn't defined, the central repository
is used instead as
determined by maven.repo.central
and
maven.repo.central.directory
public java.lang.String getExtend()
<extend>${basedir}/../project.xml</extend>
public java.lang.String getGroupId()
public java.lang.String getGumpRepositoryId()
public java.lang.String getId()
public java.lang.String getInceptionYear()
public java.lang.String getIssueTrackingUrl()
public java.util.List getLicenses()
public java.lang.String getLogo()
/images/project-logo.png
) or
an absolute URL
(e.g.,
http://my.corp/project-logo.png
). This is used
when generating the project documentation.
public java.util.List getMailingLists()
public java.lang.String getName()
public Organization getOrganization()
public java.util.List getPackageGroups()
public java.lang.String getPackageName()
public java.lang.String getPomVersion()
public java.util.Properties getProperties()
public java.util.List getReports()
public Repository getRepository()
public java.lang.String getShortDescription()
public java.lang.String getSiteAddress()
public java.lang.String getSiteDirectory()
public java.lang.String getUrl()
public java.util.List getVersions()
public void removeBranch(Branch branch)
branch
- public void removeContributor(Contributor contributor)
contributor
- public void removeDeveloper(Developer developer)
developer
- public void removeLicense(License license)
license
- public void removeMailingList(MailingList mailingList)
mailingList
- public void removePackageGroup(PackageGroup packageGroup)
packageGroup
- public void removeReport(java.lang.String string)
string
- public void removeVersion(Version version)
version
- public void setArtifactId(java.lang.String artifactId)
groupId
when naming jars and
distribution
files.
artifactId
- public void setBranches(java.util.List branches)
maven:dist
target.
branches
- public void setBuild(Build build)
build
- public void setContributors(java.util.List contributors)
contributors
- public void setCurrentVersion(java.lang.String currentVersion)
currentVersion
- public void setDescription(java.lang.String description)
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.
description
- public void setDevelopers(java.util.List developers)
developers
- public void setDistributionDirectory(java.lang.String distributionDirectory)
distributionDirectory
- public void setDistributionSite(java.lang.String distributionSite)
If this isn't defined, the central repository
is used instead as
determined by maven.repo.central
and
maven.repo.central.directory
distributionSite
- public void setExtend(java.lang.String extend)
<extend>${basedir}/../project.xml</extend>
extend
- public void setGroupId(java.lang.String groupId)
groupId
- public void setGumpRepositoryId(java.lang.String gumpRepositoryId)
gumpRepositoryId
- public void setId(java.lang.String id)
id
- public void setInceptionYear(java.lang.String inceptionYear)
inceptionYear
- public void setIssueTrackingUrl(java.lang.String issueTrackingUrl)
issueTrackingUrl
- public void setLicenses(java.util.List licenses)
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.
licenses
- public void setLogo(java.lang.String logo)
/images/project-logo.png
) or
an absolute URL
(e.g.,
http://my.corp/project-logo.png
). This is used
when generating the project documentation.
logo
- public void setMailingLists(java.util.List mailingLists)
mailingLists
- public void setName(java.lang.String name)
name
- public void setOrganization(Organization organization)
organization
- public void setPackageGroups(java.util.List packageGroups)
packageGroups
- public void setPackageName(java.lang.String packageName)
packageName
- public void setPomVersion(java.lang.String pomVersion)
pomVersion
- public void setProperties(java.util.Properties properties)
properties
- public void setReports(java.util.List reports)
maven site
.
All of the
reports will be included in the navigation bar
for browsing in
the order they are specified.
reports
- public void setRepository(Repository repository)
repository
- public void setShortDescription(java.lang.String shortDescription)
shortDescription
- public void setSiteAddress(java.lang.String siteAddress)
siteAddress
- public void setSiteDirectory(java.lang.String siteDirectory)
siteDirectory
- public void setUrl(java.lang.String url)
url
- public void setVersions(java.util.List versions)
maven:dist
target.
versions
- public void setVersion(java.lang.String version)
public java.lang.String getVersion()
public void setPackage(java.lang.String packageName)
public java.lang.String getPackage()
public void setModelEncoding(java.lang.String modelEncoding)
setModelEncoding
in class ModelBase
public java.lang.String getModelEncoding()
getModelEncoding
in class ModelBase
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |