public class Model extends ModelBase implements Serializable
<project>
element is the root of
the descriptor.
The following table lists all of the possible child
elements.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(String key,
String value)
Method addProperty.
|
void |
addReport(String string)
Method addReport.
|
void |
addVersion(Version version)
Method addVersion.
|
String |
getArtifactId()
Get the identifier for this artifact that is unique within
the group given by the
group ID.
|
List<Branch> |
getBranches()
Method getBranches.
|
Build |
getBuild()
Get information required to build the project.
|
List<Contributor> |
getContributors()
Method getContributors.
|
String |
getCurrentVersion()
Get the current version of the artifact produced by this
project.
|
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.
|
List<Developer> |
getDevelopers()
Method getDevelopers.
|
String |
getDistributionDirectory()
Get the directory on the web server where the final
distributions will be
published.
|
String |
getDistributionSite()
Get the server where the final distributions will be
published.
|
String |
getExtend()
Get the location of the parent project, if one exists.
|
String |
getGroupId()
Get a universally unique identifier for a project.
|
String |
getGumpRepositoryId()
Get this is the repository identifier in Gump that this
project is part of.
|
String |
getId()
Get Deprecated.
|
String |
getInceptionYear()
Get the year of the project's inception, specified with 4
digits.
|
String |
getIssueTrackingUrl()
Get the URL of the project's issue tracking system.
|
List<License> |
getLicenses()
Method getLicenses.
|
String |
getLogo()
Get the URL of the project's logo image.
|
List<MailingList> |
getMailingLists()
Method getMailingLists.
|
String |
getModelEncoding()
Get the modelEncoding field.
|
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.
|
String |
getPackage() |
List<PackageGroup> |
getPackageGroups()
Method getPackageGroups.
|
String |
getPackageName()
Get the Java package name of the project.
|
String |
getPomVersion()
Get declares to which version of project descriptor this POM
conforms.
|
Properties |
getProperties()
Method getProperties.
|
List<String> |
getReports()
Method getReports.
|
Repository |
getRepository()
Get specification for the SCM used by the project, such as
CVS, Subversion, etc.
|
String |
getShortDescription()
Get a short description of the project.
|
String |
getSiteAddress()
Get the hostname of the web server that hosts the project's
web site.
|
String |
getSiteDirectory()
Get the directory on the web server where the public web
site for this project
resides.
|
String |
getUrl()
Get the URL to the project's homepage.
|
String |
getVersion() |
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(String string)
Method removeReport.
|
void |
removeVersion(Version version)
Method removeVersion.
|
void |
setArtifactId(String artifactId)
Set the identifier for this artifact that is unique within
the group given by the
group ID.
|
void |
setBranches(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(List<Contributor> contributors)
Set describes the contributors to a project that are not yet
committers.
|
void |
setCurrentVersion(String currentVersion)
Set the current version of the artifact produced by this
project.
|
void |
setDescription(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(List<Developer> developers)
Set describes the committers of a project.
|
void |
setDistributionDirectory(String distributionDirectory)
Set the directory on the web server where the final
distributions will be
published.
|
void |
setDistributionSite(String distributionSite)
Set the server where the final distributions will be
published.
|
void |
setExtend(String extend)
Set the location of the parent project, if one exists.
|
void |
setGroupId(String groupId)
Set a universally unique identifier for a project.
|
void |
setGumpRepositoryId(String gumpRepositoryId)
Set this is the repository identifier in Gump that this
project is part of.
|
void |
setId(String id)
Set Deprecated.
|
void |
setInceptionYear(String inceptionYear)
Set the year of the project's inception, specified with 4
digits.
|
void |
setIssueTrackingUrl(String issueTrackingUrl)
Set the URL of the project's issue tracking system.
|
void |
setLicenses(List<License> licenses)
Set this element describes all of the licenses for this
project.
|
void |
setLogo(String logo)
Set the URL of the project's logo image.
|
void |
setMailingLists(List<MailingList> mailingLists)
Set contains information about a project's mailing lists.
|
void |
setModelEncoding(String modelEncoding)
Set the modelEncoding field.
|
void |
setName(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(String packageName) |
void |
setPackageGroups(List<PackageGroup> packageGroups)
Set package groups required for complete javadocs.
|
void |
setPackageName(String packageName)
Set the Java package name of the project.
|
void |
setPomVersion(String pomVersion)
Set declares to which version of project descriptor this POM
conforms.
|
void |
setProperties(Properties properties)
Set project properties that will be used by various plugins.
|
void |
setReports(List<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(String shortDescription)
Set a short description of the project.
|
void |
setSiteAddress(String siteAddress)
Set the hostname of the web server that hosts the project's
web site.
|
void |
setSiteDirectory(String siteDirectory)
Set the directory on the web server where the public web
site for this project
resides.
|
void |
setUrl(String url)
Set the URL to the project's homepage.
|
void |
setVersion(String version) |
void |
setVersions(List<Version> versions)
Set contains information on previous versions of the
project.
|
addDependency, getDependencies, removeDependency, setDependencies
public void addBranch(Branch branch)
branch
- a branch object.public void addContributor(Contributor contributor)
contributor
- a contributor object.public void addDeveloper(Developer developer)
developer
- a developer object.public void addLicense(License license)
license
- a license object.public void addMailingList(MailingList mailingList)
mailingList
- a mailingList object.public void addPackageGroup(PackageGroup packageGroup)
packageGroup
- a packageGroup object.public void addProperty(String key, String value)
key
- a key object.value
- a value object.public void addReport(String string)
string
- a string object.public void addVersion(Version version)
version
- a version object.public String getArtifactId()
public Build getBuild()
public List<Contributor> getContributors()
public String getCurrentVersion()
public String getDescription()
public String getDistributionDirectory()
public String getDistributionSite()
maven.repo.central
and maven.repo.central.directory
.public String getExtend()
project.xml
file. For
example,
<extend>${basedir}/../project.xml</extend>
.public String getGroupId()
org.apache.maven
).public String getGumpRepositoryId()
public String getId()
groupId
and artifactId
elements if they
were previously empty.public String getInceptionYear()
public String getIssueTrackingUrl()
public 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 List<MailingList> getMailingLists()
public String getModelEncoding()
public String getName()
public Organization getOrganization()
public List<PackageGroup> getPackageGroups()
public String getPackageName()
public String getPomVersion()
3
.public Properties getProperties()
public Repository getRepository()
public String getShortDescription()
public String getSiteAddress()
public String getSiteDirectory()
public String getUrl()
public void removeBranch(Branch branch)
branch
- a branch object.public void removeContributor(Contributor contributor)
contributor
- a contributor object.public void removeDeveloper(Developer developer)
developer
- a developer object.public void removeLicense(License license)
license
- a license object.public void removeMailingList(MailingList mailingList)
mailingList
- a mailingList object.public void removePackageGroup(PackageGroup packageGroup)
packageGroup
- a packageGroup object.public void removeReport(String string)
string
- a string object.public void removeVersion(Version version)
version
- a version object.public void setArtifactId(String artifactId)
artifactId
- a artifactId object.public void setBranches(List<Branch> branches)
branches
- a branches object.public void setBuild(Build build)
build
- a build object.public void setContributors(List<Contributor> contributors)
contributors
- a contributors object.public void setCurrentVersion(String currentVersion)
currentVersion
- a currentVersion object.public void setDescription(String description)
description
- a description object.public void setDevelopers(List<Developer> developers)
developers
- a developers object.public void setDistributionDirectory(String distributionDirectory)
distributionDirectory
- a distributionDirectory object.public void setDistributionSite(String distributionSite)
maven.repo.central
and maven.repo.central.directory
.distributionSite
- a distributionSite object.public void setExtend(String extend)
project.xml
file. For
example,
<extend>${basedir}/../project.xml</extend>
.extend
- a extend object.public void setGroupId(String groupId)
org.apache.maven
).groupId
- a groupId object.public void setGumpRepositoryId(String gumpRepositoryId)
gumpRepositoryId
- a gumpRepositoryId object.public void setId(String id)
groupId
and artifactId
elements if they
were previously empty.id
- a id object.public void setInceptionYear(String inceptionYear)
inceptionYear
- a inceptionYear object.public void setIssueTrackingUrl(String issueTrackingUrl)
issueTrackingUrl
- a issueTrackingUrl object.public void setLicenses(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
- a licenses object.public void setLogo(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
- a logo object.public void setMailingLists(List<MailingList> mailingLists)
mailingLists
- a mailingLists object.public void setModelEncoding(String modelEncoding)
modelEncoding
- a modelEncoding object.public void setName(String name)
name
- a name object.public void setOrganization(Organization organization)
organization
- a organization object.public void setPackageGroups(List<PackageGroup> packageGroups)
packageGroups
- a packageGroups object.public void setPackageName(String packageName)
packageName
- a packageName object.public void setPomVersion(String pomVersion)
3
.pomVersion
- a pomVersion object.public void setProperties(Properties properties)
<name>value</name>
.properties
- a properties object.public void setReports(List<String> reports)
maven site
.
All of the
reports will be included in the navigation bar
for browsing in
the order they are specified.reports
- a reports object.public void setRepository(Repository repository)
repository
- a repository object.public void setShortDescription(String shortDescription)
shortDescription
- a shortDescription object.public void setSiteAddress(String siteAddress)
siteAddress
- a siteAddress object.public void setSiteDirectory(String siteDirectory)
siteDirectory
- a siteDirectory object.public void setUrl(String url)
url
- a url object.public void setVersions(List<Version> versions)
versions
- a versions object.public void setVersion(String version)
public String getVersion()
public void setPackage(String packageName)
public String getPackage()
Copyright © 2001–2024 The Apache Software Foundation. All rights reserved.