Serialized Form
|
Package org.apache.maven.model |
activeByDefault
boolean activeByDefault
- Flag specifying whether this profile is active by default.
jdk
java.lang.String jdk
- Specifies that this profile will be activated
when a matching JDK is detected. For example,
1.4
only activates on JDKs versioned 1.4, while
!1.4 matches any JDK that is not version 1.4.
os
ActivationOS os
- Specifies that this profile will be activated
when matching operating system attributes are detected.
property
ActivationProperty property
- Specifies that this profile will be activated
when this system property is specified.
file
ActivationFile file
- Specifies that this profile will be activated
based on existence of a file.
custom
ActivationCustom custom
- Describes a custom profile activation trigger,
brought in via build extension.
configuration
java.lang.Object configuration
- The specification for triggering the profile
according to the rules of the custom
activation type.
type
java.lang.String type
- The type (role-hint) of activation which is to
be used to activate the profile.
missing
java.lang.String missing
- The name of the file that must be missing to activate the
profile.
exists
java.lang.String exists
- The name of the file that must exist to activate the profile.
name
java.lang.String name
- The name of the operating system to be used to activate the
profile. This must be an exact match
of the
${os.name} Java property, such
as Windows XP.
family
java.lang.String family
- The general family of the OS to be used to
activate the profile, such as
windows or
unix.
arch
java.lang.String arch
- The architecture of the operating system to be used to
activate the profile.
version
java.lang.String version
- The version of the operating system to be used to activate
the profile.
name
java.lang.String name
- The name of the property to be used to activate a profile.
value
java.lang.String value
- The value of the property required to activate a profile.
sourceDirectory
java.lang.String sourceDirectory
- This element specifies a directory containing
the source
of the project. The generated build system will
compile
the source in this directory when the project is
built.
The path given is relative to the project
descriptor.
scriptSourceDirectory
java.lang.String scriptSourceDirectory
- This element specifies a directory containing
the script sources
of the project. This directory is meant to be
different from the
sourceDirectory, in that its contents will be
copied to the output
directory in most cases (since scripts are
interpreted rather than
compiled).
testSourceDirectory
java.lang.String testSourceDirectory
- This element specifies a directory containing
the unit test
source of the project. The generated build
system will
compile these directories when the project is
being tested.
The path given is relative to the project
descriptor.
outputDirectory
java.lang.String outputDirectory
- The directory where compiled application classes
are placed.
testOutputDirectory
java.lang.String testOutputDirectory
- The directory where compiled test classes are
placed.
extensions
java.util.List<E> extensions
- Field extensions.
defaultGoal
java.lang.String defaultGoal
- The default goal (or phase in Maven 2) to
execute when none is specified for the project.
resources
java.util.List<E> resources
- Field resources.
testResources
java.util.List<E> testResources
- Field testResources.
directory
java.lang.String directory
- The directory where all files generated by the
build are placed.
finalName
java.lang.String finalName
- The filename (excluding the extension, and with
no path information) that the produced artifact
will be called. The default value is
${artifactId}-${version}.
filters
java.util.List<E> filters
- Field filters.
system
java.lang.String system
- The name of the continuous integration system,
e.g.
continuum.
url
java.lang.String url
- URL for the continuous integration system used
by the project if it has a web interface.
notifiers
java.util.List<E> notifiers
- Field notifiers.
inherited
java.lang.String inherited
- Whether any configuration should be propagated
to child POMs.
configuration
java.lang.Object configuration
- Field configuration.
inheritanceApplied
boolean inheritanceApplied
name
java.lang.String name
- The full name of the contributor.
email
java.lang.String email
- The email address of the contributor.
url
java.lang.String url
- The URL for the homepage of the contributor.
organization
java.lang.String organization
- The organization to which the contributor belongs.
organizationUrl
java.lang.String organizationUrl
- The URL of the organization.
roles
java.util.List<E> roles
- Field roles.
timezone
java.lang.String timezone
- The timezone the contributor is in. This is a
number in the range -11 to 12.
properties
java.util.Properties properties
- Field properties.
groupId
java.lang.String groupId
- The project group that produced the dependency,
e.g.
org.apache.maven.
artifactId
java.lang.String artifactId
- The unique id for an artifact produced by the
project group, e.g.
maven-artifact.
version
java.lang.String version
- The version of the dependency, e.g.
3.2.1. In Maven 2, this can also be
specified as a range of versions.
type
java.lang.String type
- The type of dependency. This defaults to
jar. While it usually represents the extension
on
the filename of the dependency, that is not
always the case. A type can be mapped to a different
extension and a classifier.
The type often correspongs to the packaging
used, though this is also not always the case.
Some examples are jar,
war, ejb-client and
test-jar.
New types can be defined by plugins that set
extensions to true, so
this is not a complete list.
classifier
java.lang.String classifier
- The classifier of the dependency. This allows
distinguishing two artifacts that belong to the same POM but
were built differently, and is appended to the
filename after the version. For example,
jdk14 and jdk15.
scope
java.lang.String scope
- The scope of the dependency -
compile, runtime,
test,
system, and provided.
Used to
calculate the various classpaths used for
compilation, testing, and so on. It also assists in
determining
which artifacts to include in a distribution of
this project. For more information, see
the
dependency mechanism.
systemPath
java.lang.String systemPath
- FOR SYSTEM SCOPE ONLY. Note that use of this
property is discouraged and may be replaced in later
versions. This specifies the path on the
filesystem for this dependency.
Requires an absolute path for the value, not
relative.
Use a property that gives the machine specific
absolute path,
e.g.
${java.home}.
exclusions
java.util.List<E> exclusions
- Field exclusions.
optional
boolean optional
- Indicates the dependency is optional for use of
this library. While the version of the dependency will be
taken into account for dependency calculation if
the library is used elsewhere, it will not be passed on
transitively.
dependencies
java.util.List<E> dependencies
- Field dependencies.
uniqueVersion
boolean uniqueVersion
- Whether to assign snapshots a unique version comprised of
the timestamp and build number, or to
use the same version each time.
id
java.lang.String id
- The unique ID of the developer in the SCM.
repository
DeploymentRepository repository
- Information needed to deploy the artifacts
generated by the project to a remote repository.
snapshotRepository
DeploymentRepository snapshotRepository
- Where to deploy snapshots of artifacts to. If
not given, it defaults to the
repository
element.
site
Site site
- Information needed for deploying the web site of
the project.
downloadUrl
java.lang.String downloadUrl
- The URL of the project's download page. If not
given users will be referred to the homepage given by
url. This is given to assist in
locating artifacts that are not in the repository due to
licensing restrictions.
relocation
Relocation relocation
- Relocation information of the artifact if it has
been moved to a new group ID and/or artifact ID.
status
java.lang.String status
- Gives the status of this artifact in the remote
repository. This must not be set in your local
project, as it is updated by tools placing it in
the reposiory. Valid values are:
none
(default),
converted (repository manager
converted this from an Maven 1 POM), partner
(directly synced from a partner Maven 2
repository), deployed (was deployed from a
Maven 2
instance), verified (has been hand
verified as correct and final).
artifactId
java.lang.String artifactId
- The artifact ID of the project to exclude.
groupId
java.lang.String groupId
- The group ID of the project to exclude.
groupId
java.lang.String groupId
- The group ID of the extension's artifact.
artifactId
java.lang.String artifactId
- The artifact ID of the extension.
version
java.lang.String version
- The version of the extension.
directory
java.lang.String directory
- Describe the directory where the resources are
stored.
The path is relative to the POM.
system
java.lang.String system
- The name of the issue management system, e.g. Bugzilla.
url
java.lang.String url
- URL for the issue management system used by the project.
name
java.lang.String name
- The full legal name of the license.
url
java.lang.String url
- The official url for the license text.
distribution
java.lang.String distribution
- The primary method by which this project may
be distributed.
- repo
- may be downloaded from the Maven
repository
- manual
- user must manually download and install
the dependency.
comments
java.lang.String comments
- Addendum information pertaining to this license.
name
java.lang.String name
- The name of the mailing list.
subscribe
java.lang.String subscribe
- The email address or link that can be used to
subscribe to the mailing list.
If this is an email address, a
mailto: link will automatically be
created when
the documentation is created.
unsubscribe
java.lang.String unsubscribe
- The email address or link that can be used to
unsubscribe to
the mailing list. If this is an email address,
a
mailto: link will automatically be
created
when the documentation is created.
post
java.lang.String post
- The email address or link that can be used to
post to
the mailing list. If this is an email address,
a
mailto: link will automatically be
created
when the documentation is created.
archive
java.lang.String archive
- The link to a URL where you can browse the
mailing list archive.
otherArchives
java.util.List<E> otherArchives
- Field otherArchives.
parent
Parent parent
- 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 location is given as a
group ID, artifact ID and version.
modelVersion
java.lang.String modelVersion
- Declares to which version of project descriptor this POM
conforms.
groupId
java.lang.String 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
java.lang.String 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.
packaging
java.lang.String packaging
- The type of artifact this project produces, for
example
jar
war
ear
pom.
Plugins can create their own packaging, and
therefore their own packaging types,
so this list does not contain all possible
types.
name
java.lang.String name
- The full name of the project.
version
java.lang.String version
- The current version of the artifact produced by
this project.
description
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. 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
java.lang.String url
- The URL to the project's homepage.
prerequisites
Prerequisites prerequisites
- Describes the prerequisites in the build
environment for this project.
issueManagement
IssueManagement issueManagement
- The project's issue management system information.
ciManagement
CiManagement ciManagement
- The project's continuous integration information.
inceptionYear
java.lang.String 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.
mailingLists
java.util.List<E> mailingLists
- Field mailingLists.
developers
java.util.List<E> developers
- Field developers.
contributors
java.util.List<E> contributors
- Field contributors.
licenses
java.util.List<E> licenses
- Field licenses.
scm
Scm scm
- Specification for the SCM used by the project,
such as CVS, Subversion, etc.
organization
Organization 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).
build
Build build
- Information required to build the project.
profiles
java.util.List<E> profiles
- Field profiles.
modelEncoding
java.lang.String modelEncoding
- Field modelEncoding.
modules
java.util.List<E> modules
- Field modules.
repositories
java.util.List<E> repositories
- Field repositories.
pluginRepositories
java.util.List<E> pluginRepositories
- Field pluginRepositories.
dependencies
java.util.List<E> dependencies
- Field dependencies.
reports
java.lang.Object reports
- Deprecated. Now ignored by Maven.
reporting
Reporting reporting
- This element includes the specification of
report plugins to use to generate the reports on the
Maven-generated site. These reports will be run
when a user executes
mvn site. All of the
reports will be included in the navigation bar
for browsing.
dependencyManagement
DependencyManagement dependencyManagement
- Default dependency information for projects that
inherit from
this one. The dependencies in this section are
not immediately resolved.
Instead, when a POM derived from this one
declares a dependency
described by a matching groupId and artifactId,
the version and other values from this
section are used for that dependency if they
were not already specified.
distributionManagement
DistributionManagement distributionManagement
- Distribution information for a project that enables
deployment of the site
and artifacts to remote web servers and
repositories respectively.
properties
java.util.Properties properties
- Field properties.
type
java.lang.String type
- The mechanism used to deliver notifications.
sendOnError
boolean sendOnError
- Whether to send notifications on error.
sendOnFailure
boolean sendOnFailure
- Whether to send notifications on failure.
sendOnSuccess
boolean sendOnSuccess
- Whether to send notifications on success.
sendOnWarning
boolean sendOnWarning
- Whether to send notifications on warning.
address
java.lang.String address
- Deprecated. Where to send the
notification to - eg email address.
configuration
java.util.Properties configuration
- Field configuration.
name
java.lang.String name
- The full name of the organization.
url
java.lang.String url
- The URL to the organization's home page.
artifactId
java.lang.String artifactId
- The artifact id of the parent project to inherit from.
groupId
java.lang.String groupId
- The group id of the parent project to inherit from.
version
java.lang.String version
- The version of the parent project to inherit.
relativePath
java.lang.String relativePath
- The relative path of the parent
pom.xml file within the check out.
The default value is ../pom.xml.
Maven looks for the parent pom first in the
reactor of currently building projects, then in this
location on
the filesystem, then the local repository, and
lastly in the remote repo.
relativePath allows you to select a
different location,
for example when your structure is flat, or
deeper without an intermediate parent pom.
However, the group ID, artifact ID and version
are still required,
and must match the file in the location given or
it will revert to the repository for the POM.
This feature is only for enhancing the
development in a local checkout of that project.
includes
java.util.List<E> includes
- Field includes.
excludes
java.util.List<E> excludes
- Field excludes.
groupId
java.lang.String groupId
- The group ID of the plugin in the repository.
artifactId
java.lang.String artifactId
- The artifact ID of the plugin in the repository.
version
java.lang.String version
- The version (or valid range of verisons) of the plugin to be
used.
extensions
boolean extensions
- Whether to load Maven extensions (such as packaging and type
handlers) from this
plugin. For performance reasons, this should
only be enabled when necessary.
executions
java.util.List<E> executions
- Field executions.
dependencies
java.util.List<E> dependencies
- Field dependencies.
goals
java.lang.Object goals
- Deprecated. Unused by Maven.
executionMap
java.util.Map<K,V> executionMap
pluginManagement
PluginManagement pluginManagement
- Default plugin information to be made available
for reference by
projects derived from this one. This plugin
configuration will not
be resolved or bound to the lifecycle unless
referenced. Any local
configuration for a given plugin will override
the plugin's entire
definition here.
plugins
java.util.List<E> plugins
- Field plugins.
pluginMap
java.util.Map<K,V> pluginMap
id
java.lang.String id
- The identifier of this execution for labelling the goals
during the build, and for matching
exections to merge during inheritance.
phase
java.lang.String phase
- The build lifecycle phase to bind the goals in this
execution to. If omitted, the goals will
be bound to the default specified in their
metadata.
goals
java.util.List<E> goals
- Field goals.
maven
java.lang.String maven
- The minimum version of Maven required to build the project,
or to use this plugin.
id
java.lang.String id
- The identifier of this build profile. This used both for
command line activation, and identifies
identical profiles to merge with during
inheritance.
activation
Activation activation
- The conditional logic which will automatically
trigger the inclusion of this profile.
build
BuildBase build
- Information required to build the project.
source
java.lang.String source
groupId
java.lang.String groupId
- The group ID the artifact has moved to.
artifactId
java.lang.String artifactId
- The new artifact ID of the artifact.
version
java.lang.String version
- The new version of the artifact.
message
java.lang.String message
- An additional message to show the user about the move, such
as the reason.
excludeDefaults
boolean excludeDefaults
- If true, then the default reports are not included in the
site generation. This includes the
reports in the "Project Info" menu.
outputDirectory
java.lang.String outputDirectory
- Where to store all of the generated reports. The
default is
${project.build.directory}/site
.
plugins
java.util.List<E> plugins
- Field plugins.
reportPluginMap
java.util.Map<K,V> reportPluginMap
groupId
java.lang.String groupId
- The group ID of the reporting plugin in the repository.
artifactId
java.lang.String artifactId
- The artifact ID of the reporting plugin in the repository.
version
java.lang.String version
- The version of the reporting plugin to be used.
inherited
java.lang.String inherited
- Whether the configuration in this plugin should be made
available to projects that
inherit from this one.
configuration
java.lang.Object configuration
- The configuration of the reporting plugin.
reportSets
java.util.List<E> reportSets
- Field reportSets.
reportSetMap
java.util.Map<K,V> reportSetMap
inheritanceApplied
boolean inheritanceApplied
id
java.lang.String id
- The unique id for this report set, to be used during POM
inheritance.
configuration
java.lang.Object configuration
- Configuration of the report to be used when generating this
set.
inherited
java.lang.String inherited
- Whether any configuration should be propagated
to child POMs.
reports
java.util.List<E> reports
- Field reports.
inheritanceApplied
boolean inheritanceApplied
releases
RepositoryPolicy releases
- How to handle downloading of releases from this repository.
snapshots
RepositoryPolicy snapshots
- How to handle downloading of snapshots from this repository.
id
java.lang.String id
- A unique identifier for a repository. This is
used to match the repository to configuration in
the
settings.xml file, for example.
name
java.lang.String name
- Human readable name of the repository.
url
java.lang.String url
- The url of the repository, in the form
protocol://hostname/path.
layout
java.lang.String layout
- The type of layout this repository uses for
locating and storing artifacts - can be
legacy
or
default.
enabled
boolean enabled
- Whether to use this repository for downloading this type of
artifact.
updatePolicy
java.lang.String updatePolicy
- The frequency for downloading updates - can be
always,
daily
(default),
interval:XXX
(in minutes) or
never
(only if it doesn't exist locally).
checksumPolicy
java.lang.String checksumPolicy
- What to do when verification of an artifact
checksum fails. Valid values are
ignore
,
fail
or
warn
(the default).
targetPath
java.lang.String targetPath
- Describe the resource target path. For example,
if you want that
resource to appear in a specific package
(
org.apache.maven.messages), you
must specify this
element with this value:
org/apache/maven/messages.
This is not required if you simply put the
resources in that directory structure at the source,
however.
filtering
boolean filtering
- Whether resources are filtered to replace tokens
with parameterised values or not.
The values are taken from the
properties element and from the properties in
the files listed
in the filters element.
connection
java.lang.String connection
- The source control management system URL
that describes the repository and how to
connect to the
repository. For more information, see the
URL
format
and list
of supported SCMs.
This connection is read-only.
developerConnection
java.lang.String developerConnection
- Just like
connection, but for
developers, i.e. this scm connection
will not be read only.
tag
java.lang.String tag
- The tag of current code. By default, it's set to
HEAD during development.
url
java.lang.String url
- The URL to the project's browsable SCM
repository, such as ViewVC or Fisheye.
id
java.lang.String id
- A unique identifier for a deployment location.
This is used to match the site to configuration in
the
settings.xml file, for example.
name
java.lang.String name
- Human readable name of the deployment location.
url
java.lang.String url
- The url of the location where website is
deployed, in the form
protocol://hostname/path.
|
Package org.apache.maven.model.v3_0_0 |
tag
java.lang.String tag
- The branch tag in the version control system
(e.g. cvs) used by the
project for the source code associated with this
branch of the
project.
nagEmailAddress
java.lang.String nagEmailAddress
- An address to which notifications regarding the
status of builds
for this project can be sent. This is intended
for use by tools
which do unattended builds, for example those
providing for
continuous integration.
sourceDirectory
java.lang.String sourceDirectory
- This element specifies a directory containing
the source
of the project. The generated build system will
compile
the source in this directory when the project is
built.
The path given is relative to the project
descriptor.
unitTestSourceDirectory
java.lang.String unitTestSourceDirectory
- This element specifies a directory containing
the unit test
source of the project. The generated build
system will
compile these directories when the project is
being tested.
The path given is relative to the project
descriptor.
aspectSourceDirectory
java.lang.String aspectSourceDirectory
- This element specifies a directory containing
Aspect
sources of the project. The generated build
system will
compile the Aspects in this directory when the
project is
built if Aspects have been enabled.
The path given is relative to the project
descriptor.
integrationUnitTestSourceDirectory
java.lang.String integrationUnitTestSourceDirectory
- This element is deprecated and
should no longer be used.
Initially it was used by the first Cactus
plugin. Now
the location of the Cactus test sources is
defined
through a plugin property. See the Cactus
plugin
properties
page.
sourceModifications
java.util.List<E> sourceModifications
- Field sourceModifications.
unitTest
UnitTest unitTest
- This element specifies unit tests associated
with the project.
defaultGoal
java.lang.String defaultGoal
- The default goal (or phase in Maven 2) to
execute when none is specified for the project.
resources
java.util.List<E> resources
- Field resources.
name
java.lang.String name
- The full name of the contributor.
email
java.lang.String email
- The email address of the contributor.
url
java.lang.String url
- The URL for the homepage of the contributor.
organization
java.lang.String organization
- The organization to which the contributor belongs.
organizationUrl
java.lang.String organizationUrl
- The URL of the organization.
roles
java.util.List<E> roles
- Field roles.
timezone
java.lang.String timezone
- The timezone the contributor is in. This is a
number in the range -11 to 12.
properties
java.util.Properties properties
- Field properties.
id
java.lang.String id
- Deprecated. Please use
groupId and
artifactId together instead.
groupId
java.lang.String groupId
- The project group that produced the dependency,
e.g.
org.apache.maven.
artifactId
java.lang.String artifactId
- The unique id for an artifact produced by the
project group, e.g.
maven-artifact.
version
java.lang.String version
- The version of the dependency, e.g.
3.2.1. In Maven 2, this can also be
specified as a range of versions.
url
java.lang.String url
- This url will be provided to the user if the jar
file cannot be downloaded
from the central repository.
jar
java.lang.String jar
- Literal name of the artifact in the repository.
Used to override the calculated artifact name.
type
java.lang.String type
- The type of dependency. This defaults to
jar. While it usually represents the extension
on
the filename of the dependency, that is not
always the case.
Some examples are jar,
war, and plugin.
A dependency of type plugin is
loaded as a Maven plugin and not added to the project
build classpath.
properties
java.util.Properties properties
- Field properties.
id
java.lang.String id
- The unique ID of the developer in the SCM.
directory
java.lang.String directory
- Describe the directory where the resources are
stored.
The path is relative to the POM.
name
java.lang.String name
- The full legal name of the license.
url
java.lang.String url
- The official url for the license text.
distribution
java.lang.String distribution
- The primary method by which this project may
be distributed.
- repo
- may be downloaded from the Maven
repository
- manual
- user must manually download and install
the dependency.
comments
java.lang.String comments
- Addendum information pertaining to this license.
name
java.lang.String name
- The name of the mailing list.
subscribe
java.lang.String subscribe
- The email address or link that can be used to
subscribe to the mailing list.
If this is an email address, a
mailto: link will automatically be
created when
the documentation is created.
unsubscribe
java.lang.String unsubscribe
- The email address or link that can be used to
unsubscribe to
the mailing list. If this is an email address,
a
mailto: link will automatically be
created
when the documentation is created.
post
java.lang.String post
- The email address or link that can be used to
post to
the mailing list. If this is an email address,
a
mailto: link will automatically be
created
when the documentation is created.
archive
java.lang.String archive
- The link to a URL where you can browse the
mailing list archive.
otherArchives
java.util.List<E> otherArchives
- Field otherArchives.
extend
java.lang.String 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
current
project.xml file. For
example,
<extend>${basedir}/../project.xml</extend>.
pomVersion
java.lang.String pomVersion
- Declares to which version of project descriptor
this POM conforms. The only valid value is
3.
groupId
java.lang.String 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
java.lang.String 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
java.lang.String id
- Deprecated. When used, this sets both the
groupId and artifactId elements
if they were previously empty.
name
java.lang.String name
- The full name of the project.
currentVersion
java.lang.String currentVersion
- The current version of the artifact produced by
this project.
shortDescription
java.lang.String shortDescription
- A short description of the project. The short
description should be
limited to a single line.
description
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. 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
java.lang.String url
- The URL to the project's homepage.
logo
java.lang.String 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.
issueTrackingUrl
java.lang.String issueTrackingUrl
- The URL of the project's issue tracking system.
inceptionYear
java.lang.String 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.
gumpRepositoryId
java.lang.String gumpRepositoryId
- This is the repository identifier in Gump that
this project is part of.
siteAddress
java.lang.String siteAddress
- The hostname of the web server that hosts the
project's web site. This is used when the web site is
deployed.
siteDirectory
java.lang.String 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.
distributionSite
java.lang.String 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 by
maven.repo.central
and maven.repo.central.directory.
distributionDirectory
java.lang.String distributionDirectory
- The directory on the web server where the final
distributions will be published. This is used when the
distributions are deployed.
mailingLists
java.util.List<E> mailingLists
- Field mailingLists.
developers
java.util.List<E> developers
- Field developers.
contributors
java.util.List<E> contributors
- Field contributors.
licenses
java.util.List<E> licenses
- Field licenses.
versions
java.util.List<E> versions
- Field versions.
branches
java.util.List<E> branches
- Field branches.
packageGroups
java.util.List<E> packageGroups
- Field packageGroups.
reports
java.util.List<E> reports
- Field reports.
repository
Repository repository
- Specification for the SCM used by the project,
such as CVS, Subversion, etc.
organization
Organization 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).
properties
java.util.Properties properties
- Field properties.
packageName
java.lang.String packageName
- The Java package name of the project. This
value is used
when generating JavaDoc.
build
Build build
- Information required to build the project.
modelEncoding
java.lang.String modelEncoding
- Field modelEncoding.
dependencies
java.util.List<E> dependencies
- Field dependencies.
name
java.lang.String name
- The full name of the organization.
url
java.lang.String url
- The URL to the organization's home page.
logo
java.lang.String logo
- The URL to the organization's logo image. This
can be an URL relative
to the base directory of the generated web site,
(e.g.,
/images/org-logo.png) or an
absolute URL
(e.g., http://my.corp/logo.png).
This value is used
when generating the project documentation.
title
java.lang.String title
- The title to use for the package group.
packages
java.lang.String packages
- The packages in the group.
includes
java.util.List<E> includes
- Field includes.
excludes
java.util.List<E> excludes
- Field excludes.
connection
java.lang.String connection
- The source control management system URL
that describes the repository and how to
connect to the
repository. For more information, see the
URL
format
and list
of supported SCMs.
This connection is read-only.
developerConnection
java.lang.String developerConnection
- Just like
connection, but for
developers, i.e. this scm connection
will not be read only.
url
java.lang.String url
- The URL to the project's browsable SCM
repository, such as ViewVC or Fisheye.
targetPath
java.lang.String targetPath
- Describe the resource target path. For example,
if you want that
resource to appear in a specific package
(
org.apache.maven.messages), you
must specify this
element with this value:
org/apache/maven/messages.
This is not required if you simply put the
resources in that directory structure at the source,
however.
filtering
boolean filtering
- Whether resources are filtered to replace tokens
with parameterised values or not.
The values are taken from the
properties element and from the properties in
the files listed
in the filters element.
className
java.lang.String className
- If the class with this name can
not be
loaded, then the includes and excludes specified
below
will be applied to the contents of the
sourceDirectory.
property
java.lang.String property
- If the property with this name is
not set,
then the includes and excludes specified below
will be applied to the contents of the
sourceDirectory.
resources
java.util.List<E> resources
- Field resources.
name
java.lang.String name
- The external version number under which this
release was distributed. Examples include:
1.0,
1.1-alpha1,
1.2-beta,
1.3.2 etc.
tag
java.lang.String tag
- The name given in the SCM (e.g. CVS) used by the
project for the source
code associated with this version of the
project.
id
java.lang.String id
- A unique identifier for a version. This is
usually identical to the name.
|
Package org.apache.maven.project |
tag
java.lang.String tag
- The branch tag in the version control system
(e.g. cvs) used by the
project for the source code associated with this
branch of the
project.
nagEmailAddress
java.lang.String nagEmailAddress
- An address to which notifications regarding the
status of builds
for this project can be sent. This is intended
for use by tools
which do unattended builds, for example those
providing for
continuous integration.
sourceDirectory
java.lang.String sourceDirectory
- This element specifies a directory containing
the source
of the project. The generated build system will
compile
the source in this directory when the project is
built.
The path given is relative to the project
descriptor.
unitTestSourceDirectory
java.lang.String unitTestSourceDirectory
- This element specifies a directory containing
the unit test
source of the project. The generated build
system will
compile these directories when the project is
being tested.
The path given is relative to the project
descriptor.
aspectSourceDirectory
java.lang.String aspectSourceDirectory
- This element specifies a directory containing
Aspect
sources of the project. The generated build
system will
compile the Aspects in this directory when the
project is
built if Aspects have been enabled.
The path given is relative to the project
descriptor.
integrationUnitTestSourceDirectory
java.lang.String integrationUnitTestSourceDirectory
- This element is deprecated and
should no longer be used.
Initially it was used by the first Cactus
plugin. Now
the location of the Cactus test sources is
defined
through a plugin property. See the Cactus
plugin
properties
page.
sourceModifications
java.util.List<E> sourceModifications
- Field sourceModifications.
unitTest
UnitTest unitTest
- This element specifies unit tests associated
with the project.
defaultGoal
java.lang.String defaultGoal
- The default goal (or phase in Maven 2) to
execute when none is specified for the project.
resources
java.util.List<E> resources
- Field resources.
name
java.lang.String name
- The full name of the contributor.
email
java.lang.String email
- The email address of the contributor.
url
java.lang.String url
- The URL for the homepage of the contributor.
organization
java.lang.String organization
- The organization to which the contributor belongs.
organizationUrl
java.lang.String organizationUrl
- The URL of the organization.
roles
java.util.List<E> roles
- Field roles.
timezone
java.lang.String timezone
- The timezone the contributor is in. This is a
number in the range -11 to 12.
properties
java.util.Properties properties
- Field properties.
id
java.lang.String id
- Deprecated. Please use
groupId and
artifactId together instead.
groupId
java.lang.String groupId
- The project group that produced the dependency,
e.g.
org.apache.maven.
artifactId
java.lang.String artifactId
- The unique id for an artifact produced by the
project group, e.g.
maven-artifact.
version
java.lang.String version
- The version of the dependency, e.g.
3.2.1. In Maven 2, this can also be
specified as a range of versions.
url
java.lang.String url
- This url will be provided to the user if the jar
file cannot be downloaded
from the central repository.
jar
java.lang.String jar
- Literal name of the artifact in the repository.
Used to override the calculated artifact name.
type
java.lang.String type
- The type of dependency. This defaults to
jar. While it usually represents the extension
on
the filename of the dependency, that is not
always the case.
Some examples are jar,
war, and plugin.
A dependency of type plugin is
loaded as a Maven plugin and not added to the project
build classpath.
properties
java.util.Properties properties
- Field properties.
id
java.lang.String id
- The unique ID of the developer in the SCM.
directory
java.lang.String directory
- Describe the directory where the resources are
stored.
The path is relative to the POM.
name
java.lang.String name
- The full legal name of the license.
url
java.lang.String url
- The official url for the license text.
distribution
java.lang.String distribution
- The primary method by which this project may
be distributed.
- repo
- may be downloaded from the Maven
repository
- manual
- user must manually download and install
the dependency.
comments
java.lang.String comments
- Addendum information pertaining to this license.
name
java.lang.String name
- The name of the mailing list.
subscribe
java.lang.String subscribe
- The email address or link that can be used to
subscribe to the mailing list.
If this is an email address, a
mailto: link will automatically be
created when
the documentation is created.
unsubscribe
java.lang.String unsubscribe
- The email address or link that can be used to
unsubscribe to
the mailing list. If this is an email address,
a
mailto: link will automatically be
created
when the documentation is created.
post
java.lang.String post
- The email address or link that can be used to
post to
the mailing list. If this is an email address,
a
mailto: link will automatically be
created
when the documentation is created.
archive
java.lang.String archive
- The link to a URL where you can browse the
mailing list archive.
otherArchives
java.util.List<E> otherArchives
- Field otherArchives.
extend
java.lang.String 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
current
project.xml file. For
example,
<extend>${basedir}/../project.xml</extend>.
pomVersion
java.lang.String pomVersion
- Declares to which version of project descriptor
this POM conforms. The only valid value is
3.
groupId
java.lang.String 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
java.lang.String 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
java.lang.String id
- Deprecated. When used, this sets both the
groupId and artifactId elements
if they were previously empty.
name
java.lang.String name
- The full name of the project.
currentVersion
java.lang.String currentVersion
- The current version of the artifact produced by
this project.
shortDescription
java.lang.String shortDescription
- A short description of the project. The short
description should be
limited to a single line.
description
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. 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
java.lang.String url
- The URL to the project's homepage.
logo
java.lang.String 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.
issueTrackingUrl
java.lang.String issueTrackingUrl
- The URL of the project's issue tracking system.
inceptionYear
java.lang.String 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.
gumpRepositoryId
java.lang.String gumpRepositoryId
- This is the repository identifier in Gump that
this project is part of.
siteAddress
java.lang.String siteAddress
- The hostname of the web server that hosts the
project's web site. This is used when the web site is
deployed.
siteDirectory
java.lang.String 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.
distributionSite
java.lang.String 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 by
maven.repo.central
and maven.repo.central.directory.
distributionDirectory
java.lang.String distributionDirectory
- The directory on the web server where the final
distributions will be published. This is used when the
distributions are deployed.
mailingLists
java.util.List<E> mailingLists
- Field mailingLists.
developers
java.util.List<E> developers
- Field developers.
contributors
java.util.List<E> contributors
- Field contributors.
licenses
java.util.List<E> licenses
- Field licenses.
versions
java.util.List<E> versions
- Field versions.
branches
java.util.List<E> branches
- Field branches.
packageGroups
java.util.List<E> packageGroups
- Field packageGroups.
reports
java.util.List<E> reports
- Field reports.
repository
Repository repository
- Specification for the SCM used by the project,
such as CVS, Subversion, etc.
organization
Organization 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).
properties
java.util.Properties properties
- Field properties.
packageName
java.lang.String packageName
- The Java package name of the project. This
value is used
when generating JavaDoc.
build
Build build
- Information required to build the project.
modelEncoding
java.lang.String modelEncoding
- Field modelEncoding.
dependencies
java.util.List<E> dependencies
- Field dependencies.
name
java.lang.String name
- The full name of the organization.
url
java.lang.String url
- The URL to the organization's home page.
logo
java.lang.String logo
- The URL to the organization's logo image. This
can be an URL relative
to the base directory of the generated web site,
(e.g.,
/images/org-logo.png) or an
absolute URL
(e.g., http://my.corp/logo.png).
This value is used
when generating the project documentation.
title
java.lang.String title
- The title to use for the package group.
packages
java.lang.String packages
- The packages in the group.
includes
java.util.List<E> includes
- Field includes.
excludes
java.util.List<E> excludes
- Field excludes.
connection
java.lang.String connection
- The source control management system URL
that describes the repository and how to
connect to the
repository. For more information, see the
URL
format
and list
of supported SCMs.
This connection is read-only.
developerConnection
java.lang.String developerConnection
- Just like
connection, but for
developers, i.e. this scm connection
will not be read only.
url
java.lang.String url
- The URL to the project's browsable SCM
repository, such as ViewVC or Fisheye.
targetPath
java.lang.String targetPath
- Describe the resource target path. For example,
if you want that
resource to appear in a specific package
(
org.apache.maven.messages), you
must specify this
element with this value:
org/apache/maven/messages.
This is not required if you simply put the
resources in that directory structure at the source,
however.
filtering
boolean filtering
- Whether resources are filtered to replace tokens
with parameterised values or not.
The values are taken from the
properties element and from the properties in
the files listed
in the filters element.
className
java.lang.String className
- If the class with this name can
not be
loaded, then the includes and excludes specified
below
will be applied to the contents of the
sourceDirectory.
property
java.lang.String property
- If the property with this name is
not set,
then the includes and excludes specified below
will be applied to the contents of the
sourceDirectory.
resources
java.util.List<E> resources
- Field resources.
name
java.lang.String name
- The external version number under which this
release was distributed. Examples include:
1.0,
1.1-alpha1,
1.2-beta,
1.3.2 etc.
tag
java.lang.String tag
- The name given in the SCM (e.g. CVS) used by the
project for the source
code associated with this version of the
project.
id
java.lang.String id
- A unique identifier for a version. This is
usually identical to the name.