Package org.apache.maven.model.v3_0_0
Class Model
java.lang.Object
org.apache.maven.model.v3_0_0.ModelBase
org.apache.maven.model.v3_0_0.Model
- All Implemented Interfaces:
Serializable
The
<project>
element is the root of
the descriptor.
The following table lists all of the possible child
elements.- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The identifier for this artifact that is unique within the group given by the group ID.Field branches.private Build
Information required to build the project.private List<Contributor>
Field contributors.private String
The current version of the artifact produced by this project.private String
A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.Field developers.private String
The directory on the web server where the final distributions will be published.private String
The server where the final distributions will be published.private String
The location of the parent project, if one exists.private String
A universally unique identifier for a project.private String
This is the repository identifier in Gump that this project is part of.private String
Deprecated.private String
The year of the project's inception, specified with 4 digits.private String
The URL of the project's issue tracking system.Field licenses.private String
The URL of the project's logo image.private List<MailingList>
Field mailingLists.private String
Field modelEncoding.private String
The full name of the project.private Organization
This element describes various attributes of the organization to which the project belongs.private List<PackageGroup>
Field packageGroups.private String
The Java package name of the project.private String
Declares to which version of project descriptor this POM conforms.private Properties
Field properties.Field reports.private Repository
Specification for the SCM used by the project, such as CVS, Subversion, etc.private String
A short description of the project.private String
The hostname of the web server that hosts the project's web site.private String
The directory on the web server where the public web site for this project resides.private String
The URL to the project's homepage.Field versions. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
Method addReport.void
addVersion
(Version version) Method addVersion.Get the identifier for this artifact that is unique within the group given by the group ID.Method getBranches.getBuild()
Get information required to build the project.Method getContributors.Get the current version of the artifact produced by this project.Get a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site.Method getDevelopers.Get the directory on the web server where the final distributions will be published.Get the server where the final distributions will be published.Get the location of the parent project, if one exists.Get a universally unique identifier for a project.Get this is the repository identifier in Gump that this project is part of.getId()
Get Deprecated.Get the year of the project's inception, specified with 4 digits.Get the URL of the project's issue tracking system.Method getLicenses.getLogo()
Get the URL of the project's logo image.Method getMailingLists.Get the modelEncoding field.getName()
Get the full name of the project.Get this element describes various attributes of the organization to which the project belongs.Method getPackageGroups.Get the Java package name of the project.Get declares to which version of project descriptor this POM conforms.Method getProperties.Method getReports.Get specification for the SCM used by the project, such as CVS, Subversion, etc.Get a short description of the project.Get the hostname of the web server that hosts the project's web site.Get the directory on the web server where the public web site for this project resides.getUrl()
Get the URL to the project's homepage.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
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
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
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
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
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
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.Methods inherited from class org.apache.maven.model.v3_0_0.ModelBase
addDependency, getDependencies, removeDependency, setDependencies
-
Field Details
-
pomVersion
Declares to which version of project descriptor this POM conforms. The only valid value is3
. -
extend
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 currentproject.xml
file. For example,<extend>${basedir}/../project.xml</extend>
. -
groupId
A universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg.org.apache.maven
). -
artifactId
The identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs. -
id
Deprecated. When used, this sets both thegroupId
andartifactId
elements if they were previously empty. -
currentVersion
The current version of the artifact produced by this project. -
versions
Field versions. -
name
The full name of the project. -
shortDescription
A short description of the project. The short description should be limited to a single line. -
description
A detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site, you are able to specify your own instead of adjusting this text. -
url
The URL to the project's homepage. -
siteAddress
The hostname of the web server that hosts the project's web site. This is used when the web site is deployed. -
siteDirectory
The directory on the web server where the public web site for this project resides. This is used when the web site is deployed. -
inceptionYear
The year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational. -
logo
The URL of 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. -
organization
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). -
licenses
Field licenses. -
mailingLists
Field mailingLists. -
developers
Field developers. -
contributors
Field contributors. -
issueTrackingUrl
The URL of the project's issue tracking system. -
branches
Field branches. -
repository
Specification for the SCM used by the project, such as CVS, Subversion, etc. -
gumpRepositoryId
This is the repository identifier in Gump that this project is part of. -
distributionSite
The 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 bymaven.repo.central
andmaven.repo.central.directory
. -
distributionDirectory
The directory on the web server where the final distributions will be published. This is used when the distributions are deployed. -
packageGroups
Field packageGroups. -
reports
Field reports. -
properties
Field properties. -
packageName
The Java package name of the project. This value is used when generating JavaDoc. -
build
Information required to build the project. -
modelEncoding
Field modelEncoding.
-
-
Constructor Details
-
Model
public Model()
-
-
Method Details
-
addBranch
Method addBranch.- Parameters:
branch
- a branch object.
-
addContributor
Method addContributor.- Parameters:
contributor
- a contributor object.
-
addDeveloper
Method addDeveloper.- Parameters:
developer
- a developer object.
-
addLicense
Method addLicense.- Parameters:
license
- a license object.
-
addMailingList
Method addMailingList.- Parameters:
mailingList
- a mailingList object.
-
addPackageGroup
Method addPackageGroup.- Parameters:
packageGroup
- a packageGroup object.
-
addProperty
Method addProperty.- Parameters:
key
- a key object.value
- a value object.
-
addReport
Method addReport.- Parameters:
string
- a string object.
-
addVersion
Method addVersion.- Parameters:
version
- a version object.
-
getArtifactId
Get the identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs.- Returns:
- String
-
getBranches
Method getBranches.- Returns:
- List
-
getBuild
Get information required to build the project.- Returns:
- Build
-
getContributors
Method getContributors.- Returns:
- List
-
getCurrentVersion
Get the current version of the artifact produced by this project.- Returns:
- 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. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site, you are able to specify your own instead of adjusting this text.- Returns:
- String
-
getDevelopers
Method getDevelopers.- Returns:
- List
-
getDistributionDirectory
Get the directory on the web server where the final distributions will be published. This is used when the distributions are deployed.- Returns:
- String
-
getDistributionSite
Get the 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 bymaven.repo.central
andmaven.repo.central.directory
.- Returns:
- 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 currentproject.xml
file. For example,<extend>${basedir}/../project.xml</extend>
.- Returns:
- String
-
getGroupId
Get a universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg.org.apache.maven
).- Returns:
- String
-
getGumpRepositoryId
Get this is the repository identifier in Gump that this project is part of.- Returns:
- String
-
getId
Get Deprecated. When used, this sets both thegroupId
andartifactId
elements if they were previously empty.- Returns:
- String
-
getInceptionYear
Get the year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.- Returns:
- String
-
getIssueTrackingUrl
Get the URL of the project's issue tracking system.- Returns:
- String
-
getLicenses
Method getLicenses.- Returns:
- List
-
getLogo
Get the URL of 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.- Returns:
- String
-
getMailingLists
Method getMailingLists.- Returns:
- List
-
getModelEncoding
Get the modelEncoding field.- Returns:
- String
-
getName
Get the full name of the project.- Returns:
- String
-
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).- Returns:
- Organization
-
getPackageGroups
Method getPackageGroups.- Returns:
- List
-
getPackageName
Get the Java package name of the project. This value is used when generating JavaDoc.- Returns:
- String
-
getPomVersion
Get declares to which version of project descriptor this POM conforms. The only valid value is3
.- Returns:
- String
-
getProperties
Method getProperties.- Returns:
- Properties
-
getReports
Method getReports.- Returns:
- List
-
getRepository
Get specification for the SCM used by the project, such as CVS, Subversion, etc.- Returns:
- Repository
-
getShortDescription
Get a short description of the project. The short description should be limited to a single line.- Returns:
- String
-
getSiteAddress
Get the hostname of the web server that hosts the project's web site. This is used when the web site is deployed.- Returns:
- String
-
getSiteDirectory
Get the directory on the web server where the public web site for this project resides. This is used when the web site is deployed.- Returns:
- String
-
getUrl
Get the URL to the project's homepage.- Returns:
- String
-
getVersions
Method getVersions.- Returns:
- List
-
removeBranch
Method removeBranch.- Parameters:
branch
- a branch object.
-
removeContributor
Method removeContributor.- Parameters:
contributor
- a contributor object.
-
removeDeveloper
Method removeDeveloper.- Parameters:
developer
- a developer object.
-
removeLicense
Method removeLicense.- Parameters:
license
- a license object.
-
removeMailingList
Method removeMailingList.- Parameters:
mailingList
- a mailingList object.
-
removePackageGroup
Method removePackageGroup.- Parameters:
packageGroup
- a packageGroup object.
-
removeReport
Method removeReport.- Parameters:
string
- a string object.
-
removeVersion
Method removeVersion.- Parameters:
version
- a version object.
-
setArtifactId
Set the identifier for this artifact that is unique within the group given by the group ID. An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, and WARs.- Parameters:
artifactId
- a artifactId object.
-
setBranches
Set contains information on SCM branches of the project.- Parameters:
branches
- a branches object.
-
setBuild
Set information required to build the project.- Parameters:
build
- a build object.
-
setContributors
Set describes the contributors to a project that are not yet committers.- Parameters:
contributors
- a contributors object.
-
setCurrentVersion
Set the current version of the artifact produced by this project.- Parameters:
currentVersion
- a currentVersion object.
-
setDescription
Set a detailed description of the project, used by Maven whenever it needs to describe the project, such as on the web site. While this element can be specified as CDATA to enable the use of HTML tags within the description, it is discouraged to allow plain text representation. If you need to modify the index page of the generated web site, you are able to specify your own instead of adjusting this text.- Parameters:
description
- a description object.
-
setDevelopers
Set describes the committers of a project.- Parameters:
developers
- a developers object.
-
setDistributionDirectory
Set the directory on the web server where the final distributions will be published. This is used when the distributions are deployed.- Parameters:
distributionDirectory
- a distributionDirectory object.
-
setDistributionSite
Set the 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 bymaven.repo.central
andmaven.repo.central.directory
.- Parameters:
distributionSite
- a distributionSite object.
-
setExtend
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 currentproject.xml
file. For example,<extend>${basedir}/../project.xml</extend>
.- Parameters:
extend
- a extend object.
-
setGroupId
Set a universally unique identifier for a project. It is normal to use a fully-qualified package name to distinguish it from other projects with a similar name (eg.org.apache.maven
).- Parameters:
groupId
- a groupId object.
-
setGumpRepositoryId
Set this is the repository identifier in Gump that this project is part of.- Parameters:
gumpRepositoryId
- a gumpRepositoryId object.
-
setId
Set Deprecated. When used, this sets both thegroupId
andartifactId
elements if they were previously empty.- Parameters:
id
- a id object.
-
setInceptionYear
Set the year of the project's inception, specified with 4 digits. This value is used when generating copyright notices as well as being informational.- Parameters:
inceptionYear
- a inceptionYear object.
-
setIssueTrackingUrl
Set the URL of the project's issue tracking system.- Parameters:
issueTrackingUrl
- a issueTrackingUrl object.
-
setLicenses
Set this element describes all of the licenses for this project. Each license is described by alicense
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.- Parameters:
licenses
- a licenses object.
-
setLogo
Set the URL of 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
- a logo object.
-
setMailingLists
Set contains information about a project's mailing lists.- Parameters:
mailingLists
- a mailingLists object.
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding
- a modelEncoding object.
-
setName
Set the full name of the project.- Parameters:
name
- a name object.
-
setOrganization
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
- a organization object.
-
setPackageGroups
Set package groups required for complete javadocs.- Parameters:
packageGroups
- a packageGroups object.
-
setPackageName
Set the Java package name of the project. This value is used when generating JavaDoc.- Parameters:
packageName
- a packageName object.
-
setPomVersion
Set declares to which version of project descriptor this POM conforms. The only valid value is3
.- Parameters:
pomVersion
- a pomVersion object.
-
setProperties
Set project properties that will be used by various plugins. The format is<name>value</name>
.- Parameters:
properties
- a properties object.
-
setReports
Set this element includes the specification of reports to be included in a Maven-generated site. These reports will be run when a user executesmaven site
. All of the reports will be included in the navigation bar for browsing in the order they are specified.- Parameters:
reports
- a reports object.
-
setRepository
Set specification for the SCM used by the project, such as CVS, Subversion, etc.- Parameters:
repository
- a repository object.
-
setShortDescription
Set a short description of the project. The short description should be limited to a single line.- Parameters:
shortDescription
- a shortDescription object.
-
setSiteAddress
Set the hostname of the web server that hosts the project's web site. This is used when the web site is deployed.- Parameters:
siteAddress
- a siteAddress object.
-
setSiteDirectory
Set 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
- a siteDirectory object.
-
setUrl
Set the URL to the project's homepage.- Parameters:
url
- a url object.
-
setVersions
Set contains information on previous versions of the project.- Parameters:
versions
- a versions object.
-
setVersion
-
getVersion
-
setPackage
-
getPackage
-