Serialized Form
|
Package org.apache.maven.model |
activeByDefault
boolean activeByDefault
- If set to true, this profile will be active unless another
profile in this
pom is activated using the command line -P
option or by one of that profile's
activators.
jdk
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.
missing
String missing
- The name of the file that must be missing to activate the
profile.
exists
String exists
- The name of the file that must exist to activate the profile.
name
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
String family
- The general family of the OS to be used to
activate the profile, such as
windows or unix.
arch
String arch
- The architecture of the operating system to be used to
activate the
profile.
version
String version
- The version of the operating system to be used to activate
the
profile.
name
String name
- The name of the property to be used to activate a profile.
value
String value
- The value of the property required to activate a profile.
sourceDirectory
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
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
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
String outputDirectory
- The directory where compiled application classes are placed.
testOutputDirectory
String testOutputDirectory
- The directory where compiled test classes are placed.
extensions
List<E> extensions
- Field extensions.
defaultGoal
String defaultGoal
- The default goal (or phase in Maven 2) to execute when none
is specified for
the project.
resources
List<E> resources
- Field resources.
testResources
List<E> testResources
- Field testResources.
directory
String directory
- The directory where all files generated by the build are
placed.
finalName
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
List<E> filters
- Field filters.
system
String system
- The name of the continuous integration system,
e.g.
continuum.
url
String url
- URL for the continuous integration system used by the
project if it has a web
interface.
notifiers
List<E> notifiers
- Field notifiers.
inherited
String inherited
- Whether any configuration should be propagated to child POMs.
configuration
Object configuration
- The configuration as DOM object.
inheritanceApplied
boolean inheritanceApplied
name
String name
- The full name of the contributor.
email
String email
- The email address of the contributor.
url
String url
- The URL for the homepage of the contributor.
organization
String organization
- The organization to which the contributor belongs.
organizationUrl
String organizationUrl
- The URL of the organization.
roles
List<E> roles
- Field roles.
timezone
String timezone
- The timezone the contributor is in. This is a number in the
range -11 to 12.
properties
Properties properties
- Field properties.
groupId
String groupId
- The project group that produced the dependency,
e.g.
org.apache.maven.
artifactId
String artifactId
- The unique id for an artifact produced by the
project group, e.g.
maven-artifact.
version
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
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
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
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
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
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
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
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
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
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
String artifactId
- The artifact ID of the project to exclude.
groupId
String groupId
- The group ID of the project to exclude.
groupId
String groupId
- The group ID of the extension's artifact.
artifactId
String artifactId
- The artifact ID of the extension.
version
String version
- The version of the extension.
directory
String directory
- Describe the directory where the resources are stored. The
path is relative
to the POM.
system
String system
- The name of the issue management system, e.g. Bugzilla.
url
String url
- URL for the issue management system used by the project.
name
String name
- The full legal name of the license.
url
String url
- The official url for the license text.
distribution
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
String comments
- Addendum information pertaining to this license.
name
String name
- The name of the mailing list.
subscribe
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
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
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
String archive
- The link to a URL where you can browse the mailing list
archive.
otherArchives
List<E> otherArchives
- Field otherArchives.
modelVersion
String modelVersion
- Declares to which version of project descriptor this POM
conforms.
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.
groupId
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
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.
version
String version
- The current version of the artifact produced by this project.
packaging
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
String name
- The full name of the project.
description
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
String url
- The URL to the project's homepage.
inceptionYear
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.
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).
licenses
List<E> licenses
- Field licenses.
mailingLists
List<E> mailingLists
- Field mailingLists.
developers
List<E> developers
- Field developers.
contributors
List<E> contributors
- Field contributors.
issueManagement
IssueManagement issueManagement
- The project's issue management system information.
scm
Scm scm
- Specification for the SCM used by the project, such as CVS,
Subversion, etc.
ciManagement
CiManagement ciManagement
- The project's continuous integration information.
prerequisites
Prerequisites prerequisites
- Describes the prerequisites in the build environment for
this project.
build
Build build
- Information required to build the project.
profiles
List<E> profiles
- Field profiles.
modelEncoding
String modelEncoding
- Field modelEncoding.
distributionManagement
DistributionManagement distributionManagement
- Distribution information for a project that enables
deployment of the site
and artifacts to remote web servers and
repositories respectively.
modules
List<E> modules
- Field modules.
repositories
List<E> repositories
- Field repositories.
pluginRepositories
List<E> pluginRepositories
- Field pluginRepositories.
dependencies
List<E> dependencies
- Field dependencies.
reports
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.
properties
Properties properties
- Field properties.
type
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
String address
- Deprecated. Where to send the
notification to - eg email address.
configuration
Properties configuration
- Field configuration.
name
String name
- The full name of the organization.
url
String url
- The URL to the organization's home page.
artifactId
String artifactId
- The artifact id of the parent project to inherit from.
groupId
String groupId
- The group id of the parent project to inherit from.
version
String version
- The version of the parent project to inherit.
relativePath
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
List<E> includes
- Field includes.
excludes
List<E> excludes
- Field excludes.
groupId
String groupId
- The group ID of the plugin in the repository.
artifactId
String artifactId
- The artifact ID of the plugin in the repository.
version
String version
- The version (or valid range of versions) 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
List<E> executions
- Field executions.
dependencies
List<E> dependencies
- Field dependencies.
goals
Object goals
- Deprecated. Unused by Maven.
executionMap
Map<K,V> executionMap
key
String key
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
List<E> plugins
- Field plugins.
pluginMap
Map<K,V> pluginMap
id
String id
- The identifier of this execution for labelling the goals
during the build,
and for matching executions to merge during
inheritance.
phase
String phase
- The build lifecycle phase to bind the goals in this
execution to. If omitted,
the goals will be bound to the default phase
specified in their metadata.
goals
List<E> goals
- Field goals.
maven
String maven
- The minimum version of Maven required to build the project,
or to use this
plugin.
id
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
String source
groupId
String groupId
- The group ID the artifact has moved to.
artifactId
String artifactId
- The new artifact ID of the artifact.
version
String version
- The new version of the artifact.
message
String message
- An additional message to show the user about the move, such
as the reason.
excludeDefaultsValue
Boolean excludeDefaultsValue
- If true, then the default reports are not included in the
site generation.
This includes the reports in the "Project Info"
menu.
outputDirectory
String outputDirectory
- Where to store all of the generated reports. The
default is
${project.build.directory}/site
.
plugins
List<E> plugins
- Field plugins.
reportPluginMap
Map<K,V> reportPluginMap
groupId
String groupId
- The group ID of the reporting plugin in the repository.
artifactId
String artifactId
- The artifact ID of the reporting plugin in the repository.
version
String version
- The version of the reporting plugin to be used.
inherited
String inherited
- Whether the configuration in this plugin should be made
available to projects
that inherit from this one.
configuration
Object configuration
- The configuration of the reporting plugin.
reportSets
List<E> reportSets
- Field reportSets.
reportSetMap
Map<K,V> reportSetMap
inheritanceApplied
boolean inheritanceApplied
id
String id
- The unique id for this report set, to be used during POM
inheritance.
configuration
Object configuration
- Configuration of the report to be used when generating this
set.
inherited
String inherited
- Whether any configuration should be propagated to child POMs.
reports
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
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
String name
- Human readable name of the repository.
url
String url
- The url of the repository, in the form
protocol://hostname/path.
layout
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
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
String checksumPolicy
- What to do when verification of an artifact
checksum fails. Valid values are
ignore
,
fail
or
warn
(the default).
targetPath
String targetPath
- Describe the resource target path. The path is
relative to the target/classes
directory (i.e.
${project.build.outputDirectory}).
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.
mergeId
String mergeId
- FOR INTERNAL USE ONLY. This is a unique
identifier assigned to each
resource to allow Maven to merge changes to this
resource that take
place during the execution of a plugin. This
field must be managed
by the generated parser and formatter classes in
order to allow it
to survive model interpolation.
connection
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
String developerConnection
- Just like
connection, but for
developers, i.e. this scm connection
will not be read only.
tag
String tag
- The tag of current code. By default, it's set to HEAD during
development.
url
String url
- The URL to the project's browsable SCM repository, such as
ViewVC or Fisheye.
id
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
String name
- Human readable name of the deployment location.
url
String url
- The url of the location where website is
deployed, in the form
protocol://hostname/path.
Copyright © 2001-2009 The Apache Software Foundation. All Rights Reserved.