public class Model extends ModelBase implements java.io.Serializable
<project>
element is the root of
the descriptor.
The following table lists all of the possible child
elements.Modifier and Type | Field and Description |
---|---|
private java.lang.String |
artifactId
The identifier for this artifact that is unique
within the group given by the group ID.
|
private java.util.List<Branch> |
branches
Field branches.
|
private Build |
build
Information required to build the project.
|
private java.util.List<Contributor> |
contributors
Field contributors.
|
private java.lang.String |
currentVersion
The current version of the artifact produced by
this project.
|
private java.lang.String |
description
A detailed description of the project, used by
Maven whenever it needs to describe the project,
such as on the web site.
|
private java.util.List<Developer> |
developers
Field developers.
|
private java.lang.String |
distributionDirectory
The directory on the web server where the final
distributions will be published.
|
private java.lang.String |
distributionSite
The server where the final distributions will be
published.
|
private java.lang.String |
extend
The location of the parent project, if one
exists.
|
private java.lang.String |
groupId
A universally unique identifier for a project.
|
private java.lang.String |
gumpRepositoryId
This is the repository identifier in Gump that
this project is part of.
|
private java.lang.String |
id
Deprecated.
|
private java.lang.String |
inceptionYear
The year of the project's inception, specified
with 4 digits.
|
private java.lang.String |
issueTrackingUrl
The URL of the project's issue tracking system.
|
private java.util.List<License> |
licenses
Field licenses.
|
private java.lang.String |
logo
The URL of the project's logo image.
|
private java.util.List<MailingList> |
mailingLists
Field mailingLists.
|
private java.lang.String |
modelEncoding
Field modelEncoding.
|
private java.lang.String |
name
The full name of the project.
|
private Organization |
organization
This element describes various attributes of the
organization to
which the project belongs.
|
private java.util.List<PackageGroup> |
packageGroups
Field packageGroups.
|
private java.lang.String |
packageName
The Java package name of the project.
|
private java.lang.String |
pomVersion
Declares to which version of project descriptor
this POM conforms.
|
private java.util.Properties |
properties
Field properties.
|
private java.util.List<java.lang.String> |
reports
Field reports.
|
private Repository |
repository
Specification for the SCM used by the project,
such as CVS, Subversion, etc.
|
private java.lang.String |
shortDescription
A short description of the project.
|
private java.lang.String |
siteAddress
The hostname of the web server that hosts the
project's web site.
|
private java.lang.String |
siteDirectory
The directory on the web server where the public
web site
for this project resides.
|
private java.lang.String |
url
The URL to the project's homepage.
|
private java.util.List<Version> |
versions
Field versions.
|
Constructor and Description |
---|
Model() |
Modifier and Type | Method and Description |
---|---|
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<Branch> |
getBranches()
Method getBranches.
|
Build |
getBuild()
Get information required to build the project.
|
java.util.List<Contributor> |
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<Developer> |
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<License> |
getLicenses()
Method getLicenses.
|
java.lang.String |
getLogo()
Get the URL of the project's logo image.
|
java.util.List<MailingList> |
getMailingLists()
Method getMailingLists.
|
java.lang.String |
getModelEncoding()
Get the modelEncoding field.
|
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<PackageGroup> |
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<java.lang.String> |
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<Version> |
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<Branch> 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<Contributor> 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<Developer> 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<License> 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<MailingList> mailingLists)
Set contains information about a project's mailing lists.
|
void |
setModelEncoding(java.lang.String modelEncoding)
Set the modelEncoding field.
|
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<PackageGroup> 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<java.lang.String> 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<Version> versions)
Set contains information on previous versions of the
project.
|
addDependency, getDependencies, removeDependency, setDependencies
private java.lang.String extend
project.xml
file. For
example,
<extend>${basedir}/../project.xml</extend>
.private java.lang.String pomVersion
3
.private java.lang.String groupId
org.apache.maven
).private java.lang.String artifactId
private java.lang.String id
groupId
and artifactId
elements
if they were previously empty.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
/images/project-logo.png
) or
an absolute URL
(e.g.,
http://my.corp/project-logo.png
). This is used
when generating the project documentation.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
maven.repo.central
and maven.repo.central.directory
.private java.lang.String distributionDirectory
private java.util.List<MailingList> mailingLists
private java.util.List<Developer> developers
private java.util.List<Contributor> contributors
private java.util.List<License> licenses
private java.util.List<Version> versions
private java.util.List<Branch> branches
private java.util.List<PackageGroup> packageGroups
private java.util.List<java.lang.String> 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
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()
public java.util.List<Branch> getBranches()
public Build getBuild()
public java.util.List<Contributor> getContributors()
public java.lang.String getCurrentVersion()
public java.lang.String getDescription()
public java.util.List<Developer> getDevelopers()
public java.lang.String getDistributionDirectory()
public java.lang.String getDistributionSite()
maven.repo.central
and maven.repo.central.directory
.public java.lang.String getExtend()
project.xml
file. For
example,
<extend>${basedir}/../project.xml</extend>
.public java.lang.String getGroupId()
org.apache.maven
).public java.lang.String getGumpRepositoryId()
public java.lang.String getId()
groupId
and artifactId
elements
if they were previously empty.public java.lang.String getInceptionYear()
public java.lang.String getIssueTrackingUrl()
public java.util.List<License> 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<MailingList> getMailingLists()
public java.lang.String getModelEncoding()
public java.lang.String getName()
public Organization getOrganization()
public java.util.List<PackageGroup> getPackageGroups()
public java.lang.String getPackageName()
public java.lang.String getPomVersion()
3
.public java.util.Properties getProperties()
public java.util.List<java.lang.String> 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<Version> 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)
artifactId
- public void setBranches(java.util.List<Branch> branches)
branches
- public void setBuild(Build build)
build
- public void setContributors(java.util.List<Contributor> contributors)
contributors
- public void setCurrentVersion(java.lang.String currentVersion)
currentVersion
- public void setDescription(java.lang.String description)
description
- public void setDevelopers(java.util.List<Developer> developers)
developers
- public void setDistributionDirectory(java.lang.String distributionDirectory)
distributionDirectory
- public void setDistributionSite(java.lang.String distributionSite)
maven.repo.central
and maven.repo.central.directory
.distributionSite
- public void setExtend(java.lang.String extend)
project.xml
file. For
example,
<extend>${basedir}/../project.xml</extend>
.extend
- public void setGroupId(java.lang.String groupId)
org.apache.maven
).groupId
- public void setGumpRepositoryId(java.lang.String gumpRepositoryId)
gumpRepositoryId
- public void setId(java.lang.String id)
groupId
and artifactId
elements
if they were previously empty.id
- public void setInceptionYear(java.lang.String inceptionYear)
inceptionYear
- public void setIssueTrackingUrl(java.lang.String issueTrackingUrl)
issueTrackingUrl
- public void setLicenses(java.util.List<License> licenses)
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.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<MailingList> mailingLists)
mailingLists
- public void setModelEncoding(java.lang.String modelEncoding)
modelEncoding
- public void setName(java.lang.String name)
name
- public void setOrganization(Organization organization)
organization
- public void setPackageGroups(java.util.List<PackageGroup> packageGroups)
packageGroups
- public void setPackageName(java.lang.String packageName)
packageName
- public void setPomVersion(java.lang.String pomVersion)
3
.pomVersion
- public void setProperties(java.util.Properties properties)
<name>value</name>
.properties
- public void setReports(java.util.List<java.lang.String> 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<Version> versions)
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()