3.0.0+
The {@code <project>} element is the root of the descriptor.
The following table lists all of the possible child elements.
3.0.0+
The {@code <project>} element is the root of the descriptor.
The following table lists all of the possible child elements.
4.0.0+
Declares to which version of project descriptor this POM conforms to:
{@code 4.0.0} for Maven 3 or {@code 4.1.0} for Maven 4.
4.0.0+
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.
3.0.0+
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. {@code org.apache.maven}).
3.0.0+
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.
4.0.0+
The current version of the artifact produced by this project.
4.0.0+
The type of artifact this project produces, for example {@code jar},
{@code war},
{@code ear},
{@code pom}.
Plugins can create their own packaging, and
therefore their own packaging types,
so this list does not contain all possible types.
3.0.0+
The full name of the project.
3.0.0+
A detailed description of the project, used by Maven whenever it needs to
describe the project, such as on the website. 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 website,
you are able to specify your own instead of adjusting this text.
3.0.0+
The URL to the project's homepage.
<p><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
project's {@code child.project.url.inherit.append.path="false"}</p>
3.0.0+
The year of the project's inception, specified with 4 digits. This value is
used when generating copyright notices as well as being informational.
3.0.0+
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).
3.0.0+
This element describes all the licenses for this project.
Each license is described by a {@code license} element, which
is then described by additional elements.
Projects should only list the license(s) that applies to the project
and not the licenses that apply to dependencies.
If multiple licenses are listed, it is assumed that the user can select
any of them, not that they must accept all.
3.0.0+
Describes the committers of a project.
3.0.0+
Describes the contributors to a project that are not yet committers.
3.0.0+
Contains information about a project's mailing lists.
4.0.0+
Describes the prerequisites in the build environment for this project.
[4.0.0 => 4.1.0]
@deprecated Use {@link #subprojects} instead.
4.1.0
The subprojects (formerly called modules) to build as a part of this
project. Each subproject listed is a relative path to the directory containing the subproject.
To be consistent with the way default URLs are calculated from parent, it is recommended
to have subproject names match artifact ids.
4.0.0+
Specification for the SCM used by the project, such as CVS, Subversion, etc.
4.0.0+
The project's issue management system information.
4.0.0+
The project's continuous integration information.
4.0.0+
Distribution information for a project that enables deployment of the site
and artifacts to remote web servers and repositories respectively.
4.0.0+
Properties that can be used throughout the POM as a substitution, and
are used as filters in resources if enabled.
The format is {@code <name>value</name>}.
4.0.0+
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.
3.0.0+
This element describes all the dependencies associated with a project.
These dependencies are used to construct a classpath for your
project during the build process. They are automatically downloaded from the
repositories defined in this project.
@see <a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">Dependency mechanism</a>
4.0.0+
The lists of the remote repositories for discovering dependencies and
extensions.
4.0.0+
The lists of the remote repositories for discovering plugins for builds and
reports.
3.0.0+
Information required to build the project.
4.0.0+
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 {@code mvn site}.
All the reports will be included in the navigation bar for browsing.
4.0.0+
A listing of project-local build profiles which will modify the build process
when activated.
4.0.0+
When children inherit from project's url, append path or not? Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}
<p><b>Default value is</b>: {@code true}</p>
@since Maven 3.6.1
4.1.0+
Indicates that this project is the root project, located in the upper directory of the source tree.
This is the directory which may contain the .mvn directory.
@since Maven 4.0.0
4.1.0+
Indicates if the build POM for this project should be preserved or downgraded to the lowest
compatible version.
@since Maven 4.0.0
3.0.0+
Describes the licenses for this project. This is used to generate the license
page of the project's website, as well as being taken into consideration in other reporting
and validation. The licenses listed for the project are that of the project itself, and not
of dependencies.
3.0.0+
The full legal name of the license.
3.0.0+
The official url for the license text.
3.0.0+
The primary method by which this project may be distributed.
<dl>
<dt>repo</dt>
<dd>may be downloaded from the Maven repository</dd>
<dt>manual</dt>
<dd>user must manually download and install the dependency.</dd>
</dl>
3.0.0+
Addendum information pertaining to this license.
4.0.0+
The {@code <ciManagement>} element contains information required to the
continuous integration system of the project.
4.0.0+
The name of the continuous integration system, e.g. {@code continuum}.
4.0.0+
URL for the continuous integration system used by the project if it has a web interface.
4.0.0+
Configuration for notifying developers/users when a build is unsuccessful,
including user information and notification mode.
4.0.0+
Configures one method for notifying users/developers when a build breaks.
4.0.0+
The mechanism used to deliver notifications.
4.0.0+
Whether to send notifications on error.
4.0.0+
Whether to send notifications on failure.
4.0.0+
Whether to send notifications on success.
4.0.0+
Whether to send notifications on warning.
4.0.0+
@deprecated Where to send the notification to - eg email address.
0.0.0+
Extended configuration specific to this notifier goes here.
4.0.0+
The {@code <scm>} element contains information required to the SCM
(Source Control Management) of the project.
4.0.0+
The source control management system URL
that describes the repository and how to connect to the
repository.
This connection is read-only.
<br><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
scm's {@code child.scm.connection.inherit.append.path="false"}
@see <a href="https://maven.apache.org/scm/scm-url-format.html">URL format</a>
@see <a href="https://maven.apache.org/scm/scms-overview.html">list of supported SCMs</a>
4.0.0+
Just like {@code connection}, but for developers, i.e. this scm connection
will not be read only.
<p><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
scm's {@code child.scm.developerConnection.inherit.append.path="false"}.</p>
4.0.0+
The tag of current code. By default, it's set to HEAD during development.
4.0.0+
The URL to the project's browsable SCM repository, such as ViewVC or Fisheye.
<p><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
scm's {@code child.scm.url.inherit.append.path="false"}</p>
4.0.0+
When children inherit from scm connection, append path or not? Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}
<p><b>Default value is</b>: {@code true}</p>
@since Maven 3.6.1
4.0.0+
When children inherit from scm developer connection, append path or not? Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}
<p><b>Default value is</b>: {@code true}</p>
@since Maven 3.6.1
4.0.0+
When children inherit from scm url, append path or not? Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}
<br><b>Default value is</b>: {@code true}
@since Maven 3.6.1
4.0.0+
Information about the issue tracking (or bug tracking) system used to manage this
project.
4.0.0+
The name of the issue management system, e.g. Bugzilla
4.0.0+
URL for the issue management system used by the project.
4.0.0+
Section for management of default dependency information for use in a group of
POMs.
4.0.0+
The dependencies specified here are not used until they are referenced in a
POM within the group. This allows the specification of a "standard" version for a
particular dependency.
3.0.0+
The {@code <dependency>} element contains information about a dependency
of the project.
3.0.0+
The project group that produced the dependency, e.g.
{@code org.apache.maven}.
3.0.0+
The unique id for an artifact produced by the project group, e.g.
{@code maven-artifact}.
3.0.0+
The version requirement of the dependency, e.g. {@code 3.2.1}. The actual version will be resolved based on the usage context.
Version requirement can also be specified as a range of versions, e.g. {@code [3.2.0,)}. This is discouraged as it may break <i>predictability</i> of resolved version.
See <a href="https://s.apache.org/dependency-version">dependency version requirement documentation</a>
and <a href="https://s.apache.org/transitive-dependencies-resolution">transitive dependencies resolution</a> for more details.
4.0.0+
The type of dependency, that will be mapped to a file extension, an optional classifier, and a few other attributes.
Some examples are {@code jar}, {@code war}, {@code ejb-client}
and {@code test-jar}: see <a href="../maven-core/artifact-handlers.html">default
artifact handlers</a> for a list. New types can be defined by extensions, so this is not a complete list.
4.0.0+
The classifier of the dependency. It is appended to
the filename after the version. This allows:
<ul>
<li>referring to attached artifact, for example {@code sources} and {@code javadoc}:
see <a href="../maven-core/artifact-handlers.html">default artifact handlers</a> for a list,</li>
<li>distinguishing two artifacts
that belong to the same POM but were built differently.
For example, {@code jdk14} and {@code jdk15}.</li>
</ul>
4.0.0+
The scope of the dependency - {@code compile}, {@code runtime},
{@code test}, {@code system}, and {@code 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
<a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">the
dependency mechanism</a>. The default scope is {@code compile}.
4.0.0+
FOR SYSTEM SCOPE ONLY. Note that use of this property is <b>discouraged</b>
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. {@code ${java.home}}.
4.0.0+
Lists a set of artifacts that should be excluded from this dependency's
artifact list when it comes to calculating transitive dependencies.
4.0.0+
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. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code false}.
4.0.0+
The {@code <exclusion>} element contains information required to exclude
an artifact to the project.
<p>
The {@code groupId} and {@code artifactId} fields are interpreted as glob patterns.
@see java.nio.file.FileSystem#getPathMatcher
4.0.0+
The group ID of the project to exclude.
4.0.0+
The artifact ID of the project to exclude.
4.0.0+
The {@code <parent>} element contains information required to locate the parent project from which
this project will inherit from.
<p><strong>Note:</strong> The children of this element are not interpolated and must be given as literal values.</p>
4.0.0+
The group id of the parent project to inherit from.
4.0.0+
The artifact id of the parent project to inherit from.
4.0.0+
The version of the parent project to inherit.
4.0.0+
The relative path of the parent subproject POM file or directory within the checkout.
If not specified, it defaults to {@code ..}, i.e. the parent directory.
Maven looks for the parent POM first in this location on
the filesystem if explicitly provided, then in the reactor if groupId and artifactId are provided,
then in the default parent directory, then the local repository, and lastly in the remote repo.
However, if the both relative path and the group ID / artifact ID are provided,
they must match the file in the location given.
Specify either the {@code relativePath} or the {@code groupId}/{@code artifactId}, not both.
3.0.0+
Information about one of the committers on this project.
3.0.0+
The unique ID of the developer in the SCM.
3.0.0+
The full name of the contributor.
3.0.0+
The email address of the contributor.
3.0.0+
The URL for the homepage of the contributor.
3.0.0+
The organization to which the contributor belongs.
3.0.0+
The URL of the organization.
3.0.0+
The roles the contributor plays in the project. Each role is described by a
{@code role} element, the body of which is a role name. This can also be used to
describe the contribution.
3.0.0+
The timezone the contributor is in. Typically, this is a number in the range
<a href="http://en.wikipedia.org/wiki/UTC%E2%88%9212:00">-12</a> to <a href="http://en.wikipedia.org/wiki/UTC%2B14:00">+14</a>
or a valid time zone id like "America/Montreal" (UTC-05:00) or "Europe/Paris" (UTC+01:00).
3.0.0+
Properties about the contributor, such as an instant messenger handle.
3.0.0+
This element describes all of the mailing lists associated with a project. The
auto-generated site references this information.
3.0.0+
The name of the mailing list.
3.0.0+
The email address or link that can be used to subscribe to
the mailing list. If this is an email address, a
{@code mailto:} link will automatically be created
when the documentation is created.
3.0.0+
The email address or link that can be used to unsubscribe to
the mailing list. If this is an email address, a
{@code mailto:} link will automatically be created
when the documentation is created.
3.0.0+
The email address or link that can be used to post to
the mailing list. If this is an email address, a
{@code mailto:} link will automatically be created
when the documentation is created.
3.0.0+
The link to a URL where you can browse the mailing list archive.
3.0.0+
The link to alternate URLs where you can browse the list archive.
3.0.0+
Description of a person who has contributed to the project, but who does not have
commit privileges. Usually, these contributions come in the form of patches submitted.
3.0.0+
The full name of the contributor.
3.0.0+
The email address of the contributor.
3.0.0+
The URL for the homepage of the contributor.
3.0.0+
The organization to which the contributor belongs.
3.0.0+
The URL of the organization.
3.0.0+
The roles the contributor plays in the project. Each role is described by a
{@code role} element, the body of which is a role name. This can also be used to
describe the contribution.
3.0.0+
The timezone the contributor is in. Typically, this is a number in the range
<a href="http://en.wikipedia.org/wiki/UTC%E2%88%9212:00">-12</a> to <a href="http://en.wikipedia.org/wiki/UTC%2B14:00">+14</a>
or a valid time zone id like "America/Montreal" (UTC-05:00) or "Europe/Paris" (UTC+01:00).
3.0.0+
Properties about the contributor, such as an instant messenger handle.
3.0.0+
Specifies the organization that produces this project.
3.0.0+
The full name of the organization.
3.0.0+
The URL to the organization's home page.
4.0.0+
This elements describes all that pertains to distribution for a project. It is
primarily used for deployment of artifacts and the site produced by the build.
4.0.0+
Information needed to deploy the artifacts generated by the project to a
remote repository.
4.0.0+
Where to deploy snapshots of artifacts to. If not given, it defaults to the
{@code repository} element.
4.0.0+
Information needed for deploying the web site of the project.
4.0.0+
The URL of the project's download page. If not given users will be
referred to the homepage given by {@code url}.
This is given to assist in locating artifacts that are not in the repository due to
licensing restrictions.
4.0.0+
Relocation information of the artifact if it has been moved to a new group ID
and/or artifact ID.
4.0.0+
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 repository. Valid values are: {@code none} (default),
{@code converted} (repository manager converted this from a Maven 1 POM),
{@code partner}
(directly synced from a partner Maven 2 repository), {@code deployed} (was deployed from a Maven 2
instance), {@code verified} (has been hand verified as correct and final).
4.0.0+
Deployment repository contains the information needed for deploying to the remote
repository, which adds {@code uniqueVersion} property to usual repository information for download.
4.0.0+
Whether to assign snapshots a unique version comprised of the timestamp and
build number, or to use the same version each time, when deploying to repository
4.0.0+
How to handle downloading of releases from this repository.
4.0.0+
How to handle downloading of snapshots from this repository.
4.0.0+
A unique identifier for a repository. This is used to match the repository
to configuration in the {@code settings.xml} file, for example. Furthermore, the identifier is
used during POM inheritance and profile injection to detect repositories that should be merged.
4.0.0+
Human readable name of the repository.
4.0.0+
The url of the repository, in the form {@code protocol://hostname/path}.
4.0.0+
The type of layout this repository uses for locating and storing artifacts -
can be {@code legacy} or {@code default}.
4.0.0+
Repository download policy.
4.0.0+
Whether to use this repository for downloading this type of artifact. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code true}.
4.0.0+
The frequency for downloading updates - can be
{@code always},
{@code daily} (default),
{@code interval:XXX} (in minutes) or
{@code never} (only if it doesn't exist locally).
4.0.0+
What to do when verification of an artifact checksum fails. Valid values are
{@code ignore},
{@code fail} (default for Maven 4 and above) or
{@code warn} (default for Maven 3).
4.0.0+
Describes where an artifact has moved to. If any of the values are omitted, it is
assumed to be the same as it was before.
4.0.0+
The group ID the artifact has moved to.
4.0.0+
The new artifact ID of the artifact.
4.0.0+
The new version of the artifact.
4.0.0+
An additional message to show the user about the move, such as the reason.
4.0.0+
Contains the information needed for deploying websites.
4.0.0+
A unique identifier for a deployment location. This is used to match the
site to configuration in the {@code settings.xml} file, for example.
4.0.0+
Human readable name of the deployment location.
4.0.0+
The url of the location where website is deployed, in the form {@code protocol://hostname/path}.
<p><b>Default value is</b>: parent value [+ path adjustment] + (artifactId or project.directory property), or just parent value if
site's {@code child.site.url.inherit.append.path="false"}.</p>
4.0.0+
When children inherit from distribution management site url, append path or not? Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}
<p><b>Default value is</b>: {@code true}</p>
@since Maven 3.6.1
4.0.0+
Section for management of reports and their configuration.
4.0.0+
If true, then the default reports are not included in the site generation.
This includes the reports in the "Project Info" menu. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code false}.
4.0.0+
Where to store all the generated reports. The default is
{@code ${project.build.directory}/site}.
4.0.0+
The reporting plugins to use and their configuration.
4.0.0+
The {@code <plugin>} element in {@code <reporting><plugins>} contains information required for a report plugin.
4.0.0+
The group ID of the reporting plugin in the repository.
4.0.0+
The artifact ID of the reporting plugin in the repository.
4.0.0+
The version of the reporting plugin to be used. Starting with Maven 3, if no version is defined explicitly,
version is searched in {@code build/plugins} then in {@code build/pluginManagement}.
4.0.0+
Multiple specifications of a set of reports, each having (possibly) different
configuration. This is the reporting parallel to an {@code execution} in the build.
4.0.0+
Whether any configuration should be propagated to child POMs. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code true}.
0.0.0+
<p>The configuration as DOM object.</p>
<p>By default, every element content is trimmed, but starting with Maven 3.1.0, you can add
{@code xml:space="preserve"} to elements you want to preserve whitespace.</p>
<p>You can control how child POMs inherit configuration from parent POMs by adding {@code combine.children}
or {@code combine.self} attributes to the children of the configuration element:</p>
<ul>
<li>{@code combine.children}: available values are {@code merge} (default) and {@code append},</li>
<li>{@code combine.self}: available values are {@code merge} (default) and {@code override}.</li>
</ul>
@see <a href="https://maven.apache.org/pom.html#Plugins">POM Reference documentation</a>
@see <a href="https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/xml/Xpp3DomUtils.html">Xpp3DomUtils</a>
4.0.0+
Represents a set of reports and configuration to be used to generate them.
0.0.0+
The unique id for this report set, to be used during POM inheritance and profile injection
for merging of report sets.
4.0.0+
The list of reports from this plugin which should be generated from this set.
4.0.0+
Whether any configuration should be propagated to child POMs. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code true}.
0.0.0+
<p>The configuration as DOM object.</p>
<p>By default, every element content is trimmed, but starting with Maven 3.1.0, you can add
{@code xml:space="preserve"} to elements you want to preserve whitespace.</p>
<p>You can control how child POMs inherit configuration from parent POMs by adding {@code combine.children}
or {@code combine.self} attributes to the children of the configuration element:</p>
<ul>
<li>{@code combine.children}: available values are {@code merge} (default) and {@code append},</li>
<li>{@code combine.self}: available values are {@code merge} (default) and {@code override}.</li>
</ul>
@see <a href="https://maven.apache.org/pom.html#Plugins">POM Reference documentation</a>
@see <a href="https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/xml/Xpp3DomUtils.html">Xpp3DomUtils</a>
4.0.0+
Modifications to the build process which is activated based on environmental
parameters or command line arguments.
4.0.0+
The identifier of this build profile. This is used for command line
activation, and identifies profiles to be merged.
4.0.0+
The conditional logic which will automatically trigger the inclusion of this
profile.
4.0.0+
Information required to build the project.
[4.0.0 => 4.1.0]
@deprecated Use {@link #subprojects} instead.
4.1.0
The subprojects (formerly called modules) to build as a part of this
project. Each subproject listed is a relative path to the directory containing the subproject.
To be consistent with the way default URLs are calculated from parent, it is recommended
to have subproject names match artifact ids.
4.0.0+
Distribution information for a project that enables deployment of the site
and artifacts to remote web servers and repositories respectively.
4.0.0+
Properties that can be used throughout the POM as a substitution, and
are used as filters in resources if enabled.
The format is {@code <name>value</name>}.
4.0.0+
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.
3.0.0+
This element describes all the dependencies associated with a project.
These dependencies are used to construct a classpath for your
project during the build process. They are automatically downloaded from the
repositories defined in this project.
@see <a href="https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html">Dependency mechanism</a>
4.0.0+
The lists of the remote repositories for discovering dependencies and
extensions.
4.0.0+
The lists of the remote repositories for discovering plugins for builds and
reports.
4.0.0+
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 {@code mvn site}.
All the reports will be included in the navigation bar for browsing.
4.0.0+
The conditions within the build runtime environment which will trigger the
automatic inclusion of the build profile. Multiple conditions can be defined, which must
be all satisfied to activate the profile.
<p>In addition to the traditional activation mechanisms (JDK version, OS properties,
file existence, etc.), Maven now supports a powerful condition-based activation
through the {@code condition} field. This new mechanism allows for more flexible
and expressive profile activation rules.</p>
<h2>Condition Syntax</h2>
<p>The condition is specified as a string expression that can include various
functions, comparisons, and logical operators. Some key features include:</p>
<ul>
<li>Property access: {@code ${property.name}}</li>
<li>Comparison operators: {@code ==}, {@code !=}, {@code <}, {@code >}, {@code <=}, {@code >=}</li>
<li>Logical operators: {@code &&} (AND), {@code ||} (OR), {@code not(...)}</li>
<li>Functions: {@code exists(...)}, {@code missing(...)}, {@code matches(...)}, {@code inrange(...)}, and more</li>
</ul>
<h2>Supported Functions</h2>
<p>The following functions are supported in condition expressions:</p>
<ul>
<li>{@code length(string)}: Returns the length of the given string.</li>
<li>{@code upper(string)}: Converts the string to uppercase.</li>
<li>{@code lower(string)}: Converts the string to lowercase.</li>
<li>{@code substring(string, start, [end])}: Returns a substring of the given string.</li>
<li>{@code indexOf(string, substring)}: Returns the index of the first occurrence of substring in string, or -1 if not found.</li>
<li>{@code contains(string, substring)}: Checks if the string contains the substring.</li>
<li>{@code matches(string, regex)}: Checks if the string matches the given regular expression.</li>
<li>{@code not(condition)}: Negates the given condition.</li>
<li>{@code if(condition, trueValue, falseValue)}: Returns trueValue if the condition is true, falseValue otherwise.</li>
<li>{@code exists(path)}: Checks if a file matching the given glob pattern exists.</li>
<li>{@code missing(path)}: Checks if a file matching the given glob pattern does not exist.</li>
<li>{@code inrange(version, range)}: Checks if the given version is within the specified version range.</li>
</ul>
<h2>Supported properties</h2>
<p>The following properties are supported in expressions:</p>
<ul>
<li>`project.basedir`: The project directory</li>
<li>`project.rootDirectory`: The root directory of the project</li>
<li>`project.artifactId`: The artifactId of the project</li>
<li>`project.packaging`: The packaging of the project</li>
<li>user properties</li>
<li>system properties (including environment variables prefixed with `env.`)</li>
</ul>
<h2>Examples</h2>
<ul>
<li>JDK version range: {@code inrange(${java.version}, '[11,)')} (JDK 11 or higher)</li>
<li>OS check: {@code ${os.name} == 'windows'}</li>
<li>File existence: {@code exists('${project.basedir}/src/**}{@code /*.xsd')}</li>
<li>Property check: {@code ${my.property} != 'some-value'}</li>
<li>Regex matching: {@code matches(${os.version}, '.*aws')}</li>
<li>Complex condition: {@code ${os.name} == 'windows' && ${os.arch} != 'amd64' && inrange(${os.version}, '[10,)')}</li>
<li>String length check: {@code length(${user.name}) > 5}</li>
<li>Substring with version: {@code substring(${java.version}, 0, 3) == '1.8'}</li>
<li>Using indexOf: {@code indexOf(${java.version}, '-') > 0}</li>
<li>Conditional logic: {@code if(contains(${java.version}, '-'), substring(${java.version}, 0, indexOf(${java.version}, '-')), ${java.version})}</li>
</ul>
<p>This flexible condition mechanism allows for more precise control over profile
activation, enabling developers to create profiles that respond to a wide range of
environmental factors and project states.</p>
4.0.0+
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.
4.0.0+
Specifies that this profile will be activated when a matching JDK is detected.
For example, {@code 1.4} only activates on JDKs versioned 1.4,
while {@code !1.4} matches any JDK that is not version 1.4. Ranges are supported too:
{@code [1.5,)} activates when the JDK is 1.5 minimum.
4.0.0+
Specifies that this profile will be activated when matching operating system
attributes are detected.
4.0.0+
Specifies that this profile will be activated when this property is
specified.
4.0.0+
Specifies that this profile will be activated based on existence of a file.
4.1.0+
Specifies that this profile will be activated based on the project's packaging.
4.1.0+
The condition which must be satisfied to activate the profile.
4.0.0+
This is the property specification used to activate a profile. If the value field
is empty, then the existence of the named property will activate the profile, otherwise it
does a case-sensitive match against the property value as well.
4.0.0+
The name of the property to be used to activate a profile.
4.0.0+
The value of the property required to activate a profile.
4.0.0+
This is the file specification used to activate the profile. The {@code missing} value
is the location of a file that needs to exist, and if it doesn't, the profile will be
activated. On the other hand, {@code exists} will test for the existence of the file and if it is
there, the profile will be activated.
<p>Variable interpolation for these file specifications is limited to {@code ${project.basedir}},
system properties and user properties.</p>
4.0.0+
The name of the file that must be missing to activate the profile. Please note, that missing and exists
fields cannot be used together. Only one of them should be used at any one time.
4.0.0+
The name of the file that must exist to activate the profile. Please note, that missing and exists
fields cannot be used together. Only one of them should be used at any one time.
4.0.0+
This is an activator which will detect an operating system's attributes in order
to activate its profile.
4.0.0+
The name of the operating system to be used to activate the profile. This must be an exact match
of the {@code ${os.name}} Java property, such as {@code Windows XP}.
4.0.0+
The general family of the OS to be used to activate the profile, such as
{@code windows} or {@code unix}.
4.0.0+
The architecture of the operating system to be used to activate the
profile.
4.0.0+
The version of the operating system to be used to activate the
profile.
4.0.0+
A repository contains the information needed for establishing connections with
remote repository.
4.0.0+
How to handle downloading of releases from this repository.
4.0.0+
How to handle downloading of snapshots from this repository.
4.0.0+
A unique identifier for a repository. This is used to match the repository
to configuration in the {@code settings.xml} file, for example. Furthermore, the identifier is
used during POM inheritance and profile injection to detect repositories that should be merged.
4.0.0+
Human readable name of the repository.
4.0.0+
The url of the repository, in the form {@code protocol://hostname/path}.
4.0.0+
The type of layout this repository uses for locating and storing artifacts -
can be {@code legacy} or {@code default}.
3.0.0+
Build configuration in a profile.
3.0.0+
The default goal to execute when none is specified for
the project. Note that in case of a build with subprojects, only the default goal of the top-level
project is relevant, i.e. the default goals of subprojects are ignored. Since Maven 3,
multiple goals/phases can be separated by whitespace.
3.0.0+
This element describes all the classpath resources such as properties
files associated with a project. These resources are often included in the final
package.
The default value is {@code src/main/resources}.
@deprecated Replaced by {@code <Source>} with {@code main} scope and {@code resources} language.
4.0.0+
This element describes all the classpath resources such as properties
files associated with a project's unit tests.
The default value is {@code src/test/resources}.
@deprecated Replaced by {@code <Source>} with {@code test} scope and {@code resources} language.
4.0.0+
The directory where all files generated by the build are placed.
The default value is {@code target}.
4.0.0+
The filename (excluding the extension, and with no path information) that
the produced artifact will be called.
The default value is {@code ${artifactId}-${version}}.
4.0.0+
The list of filter properties files that are used when filtering is enabled.
4.0.0+
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.
4.0.0+
The list of plugins to use.
4.0.0+
The {@code <plugin>} element contains information required for a plugin.
4.0.0+
The group ID of the plugin in the repository.
4.0.0+
The artifact ID of the plugin in the repository.
4.0.0+
The version (or valid range of versions) of the plugin to be used.
4.0.0+
Whether to load Maven extensions (such as packaging and type handlers) from
this plugin. For performance reasons, this should only be enabled when necessary. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code false}.
4.0.0+
Multiple specifications of a set of goals to execute during the build
lifecycle, each having (possibly) a different configuration.
4.0.0+
Additional dependencies that this project needs to introduce to the plugin's
classloader.
4.0.0+
Whether any configuration should be propagated to child POMs. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code true}.
0.0.0+
<p>The configuration as DOM object.</p>
<p>By default, every element content is trimmed, but starting with Maven 3.1.0, you can add
{@code xml:space="preserve"} to elements you want to preserve whitespace.</p>
<p>You can control how child POMs inherit configuration from parent POMs by adding {@code combine.children}
or {@code combine.self} attributes to the children of the configuration element:</p>
<ul>
<li>{@code combine.children}: available values are {@code merge} (default) and {@code append},</li>
<li>{@code combine.self}: available values are {@code merge} (default) and {@code override}.</li>
</ul>
@see <a href="https://maven.apache.org/pom.html#Plugins">POM Reference documentation</a>
@see <a href="https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/xml/Xpp3DomUtils.html">Xpp3DomUtils</a>
4.0.0+
The {@code @lt;execution>} element contains information required for the
execution of a plugin.
4.0.0+
The identifier of this execution for labelling the goals during the build,
and for matching executions to merge during inheritance and profile injection.
4.0.0+
The build lifecycle phase to bind the goals in this execution to. If omitted,
the goals will be bound to the default phase specified by the plugin.
4.0.0+
The goals to execute with the given configuration.
4.0.0+
Whether any configuration should be propagated to child POMs. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code true}.
0.0.0+
<p>The configuration as DOM object.</p>
<p>By default, every element content is trimmed, but starting with Maven 3.1.0, you can add
{@code xml:space="preserve"} to elements you want to preserve whitespace.</p>
<p>You can control how child POMs inherit configuration from parent POMs by adding {@code combine.children}
or {@code combine.self} attributes to the children of the configuration element:</p>
<ul>
<li>{@code combine.children}: available values are {@code merge} (default) and {@code append},</li>
<li>{@code combine.self}: available values are {@code merge} (default) and {@code override}.</li>
</ul>
@see <a href="https://maven.apache.org/pom.html#Plugins">POM Reference documentation</a>
@see <a href="https://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/xml/Xpp3DomUtils.html">Xpp3DomUtils</a>
3.0.0+
This element describes all of the classpath resources associated with a project
or unit tests.
@deprecated Replaced by {@code <Source>} with {@code resources} language.
3.0.0+
Describe the resource target path. The path is relative to the target/classes
directory (i.e. {@code ${project.build.outputDirectory}}).
For example, if you want that resource to appear in a specific package
({@code org.apache.maven.messages}), you must specify this
element with this value: {@code org/apache/maven/messages}.
This is not required if you simply put the resources in that directory
structure at the source, however.
3.0.0+
Whether resources are filtered to replace tokens with parameterised values or not.
The values are taken from the {@code properties} element and from the
properties in the files listed in the {@code filters} element. Note: While the type
of this field is {@code String} for technical reasons, the semantic type is actually
{@code Boolean}. Default value is {@code false}.
3.0.0+
Describe the directory where the resources are stored. The path is relative
to the POM.
3.0.0+
A list of patterns to include, e.g. {@code **/*.xml}.
3.0.0+
A list of patterns to exclude, e.g. {@code **/*.xml}
4.0.0+
Section for management of default plugin information for use in a group of POMs.
4.0.0+
The list of plugins to use.
4.0.0+
Describes the prerequisites a project can have.
4.0.0+
For a plugin project (packaging is {@code maven-plugin}), the minimum version of
Maven required to use the resulting plugin.
3.0.0+
The {@code <build>} element contains information required to build the project.
Default values are defined in Super POM.
4.1.0+
All the sources to compile and resources files to copy for a project or it's unit tests.
The sources can be Java source files, generated source files, scripts, or resources for examples.
Each source is specified by a {@code directory} element, which is relative to the POM.
The kind of sources (source files to compile or resources to copy) and their usage (for the main code
or for the tests) is specified by the {@code scope} element together with each source directory.
3.0.0+
This element specifies a directory containing the source of the project. The
generated build system will compile the sources from this directory when the project is
built. The path given is relative to the project descriptor.
The default value is {@code src/main/java}.
@deprecated Replaced by {@code <Source>} with {@code main} scope.
4.0.0+
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).
The default value is {@code src/main/scripts}.
@deprecated Replaced by {@code <Source>} with {@code script} language.
4.0.0+
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.
The default value is {@code src/test/java}.
@deprecated Replaced by {@code <Source>} with {@code test} scope.
4.0.0+
The directory where compiled application classes are placed.
The default value is {@code target/classes}.
4.0.0+
The directory where compiled test classes are placed.
The default value is {@code target/test-classes}.
4.0.0+
A set of build extensions to use from this project.
3.0.0+
The default goal to execute when none is specified for
the project. Note that in case of a build with subprojects, only the default goal of the top-level
project is relevant, i.e. the default goals of subprojects are ignored. Since Maven 3,
multiple goals/phases can be separated by whitespace.
3.0.0+
This element describes all the classpath resources such as properties
files associated with a project. These resources are often included in the final
package.
The default value is {@code src/main/resources}.
@deprecated Replaced by {@code <Source>} with {@code main} scope and {@code resources} language.
4.0.0+
This element describes all the classpath resources such as properties
files associated with a project's unit tests.
The default value is {@code src/test/resources}.
@deprecated Replaced by {@code <Source>} with {@code test} scope and {@code resources} language.
4.0.0+
The directory where all files generated by the build are placed.
The default value is {@code target}.
4.0.0+
The filename (excluding the extension, and with no path information) that
the produced artifact will be called.
The default value is {@code ${artifactId}-${version}}.
4.0.0+
The list of filter properties files that are used when filtering is enabled.
4.0.0+
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.
4.0.0+
The list of plugins to use.
4.1.0+
Description of the sources associated with a project main code or unit tests.
The sources can be Java source files, generated source files, scripts, or resources for examples.
A source is specified by a {@code directory} element, which is relative to the POM.
The directory content can optionally be reduced to a subset with the {@code includes} and
{@code excludes} elements. The kind of sources (codes, resources, <i>etc.</i>) and their
usage (main code, tests, <i>etc.</i>) is specified by the {@code scope} element.
<h2>Default source directories</h2>
If no source directories are specified, the default values depend on whether module names are specified:
<ul>
<li>{@code src/${scope}/${lang}} if no module is specified</li>
<li>{@code src/${module}/${scope}/${lang}} if a module is specified</li>
</ul>
where
{@code ${scope}} is the value of the {@link #scope} element (typically {@code main} or {@code test}),
{@code ${lang}} is the value of the {@link #lang} element (typically {@code java} or {@code resources}),
and {@code ${module}} is the optional {@link #module} element.
4.1.0+
Specifies in which context the source files will be used - typically {@code main} or {@code test}.
<p>The <b>main</b> scope is used for specifying a directory containing the source of the project.
The generated build system will compile the sources from this directory when the project is built.
The path given in the {@code directory} field is relative to the project descriptor.
The default directory for the default language (Java) is {@code "src/main/java"}.</p>
<p>The <b>test</b> scope is used for specifying 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 in the {@code directory} field is relative to the project descriptor.
The default directory for the default language (Java) is {@code "src/test/java"}.</p>
<p>If no scope is specified, the default is {@code main}.</p>
4.1.0+
Specifies the language of the source files - typically {@code java} or {@code resources}.
Resources is used as a generic term for scripting languages (e.g., JavaScript or Python)
or markup languages (e.g. properties file, <abbr>JSON</abbr> or <abbr>XML</abbr>).
<p>The <b>java</b> language is used for specifying a directory containing the Java sources of the project.
The generated build system will compile the sources from this directory using the Java compiler when the
project is built. The path given in the {@code directory} field is relative to the project descriptor.
The default directory for the main Java sources is {@code "src/main/java"}.</p>
<p>The <b>resources</b> language is used for specifying a directory containing the class-path
or module-path resources such as properties files or scripts associated with a project.
This directory is meant to be different from the main source directory,
in that its contents will be copied to the output directory in most cases
(since scripts are interpreted rather than compiled).
The default directory for the main resources is {@code "src/main/resources"}.</p>
<p>If no language is specified, the default is {@code java}.</p>
4.1.0+
Name of the Java module (or other language-specific module) which is built by the sources.
This element can be specified in a Maven project containing multiple Java modules.
It is generally not needed for non-modular projects, or for modular projects having only one module.
<p>If a module name is specified for resources or script files,
then this value modifies the directory where the files will be copied.
For example, if a Java module name is "foo.biz", then the {@code foo/bar.properties}
resource file will be copied as {@code foo.biz/foo/bar.properties}.</p>
<p>This element can be combined with the {@code targetVersion} element for specifying sources,
scripts, or resources that are specific to both a particular module and a target version.</p>
4.1.0+
The version of the platform where the code will be executed.
In a Java environment, this is the value of the {@code --release} compiler option.
If a Java project contains multiple main sources with different target versions,
then a multi-version <abbr>JAR</abbr> file will be created
with the lowest version taken as the <dfn>base version</dfn>.
If this element is omitted, then the default target version is the compiler default value,
which is usually the version of the Java environment running Maven.
<p>If a target version, different from the base version, is specified for resources or script files,
then this value modifies the directory where the files will be copied.
For example, if {@code targetVersion} is 17, then the {@code foo/bar.properties}
resource file will be copied as {@code META-INF/versions/17/foo/bar.properties}.</p>
<p>This element can be combined with the {@code module} element for specifying sources,
scripts, or resources that are specific to both a particular module and a target version.</p>
4.1.0+
Specifies an explicit target path, overriding the default value.
If unspecified, then the default value is one of the following:
<ul>
<li>{@code ${project.build.outputDirectory}} (typically {@code target/classes}) if {@code scope} is "main",</li>
<li>{@code ${project.build.testOutputDirectory}} (typically {@code target/test-classes}) if {@code scope} is "test",</li>
<li>{@code ${project.build.directory}} (typically {@code target}) otherwise.</li>
</ul>
<p>If this property is specified but is a relative path,
then the path is resolved against the above-cited default value.</p>
<p>When a target path is explicitly specified, the values of the {@code module} and {@code targetVersion}
elements are not used for inferring the path (they are still used as compiler options however).
It means that for scripts and resources, the files below the path specified by {@code directory}
are copied to the path specified by {@code targetPath} with the exact same directory structure.
It is user's responsibility to put module and version components in the {@code targetPath} if needed.</p>
<p>Note that for Java source files, a directory with the module name may still be generated despite
above statement about {@code module} being ignored, because that directory is generated by the Java
compiler rather than Maven.</p>
4.1.0+
Whether resources are filtered to replace tokens with parameterized values.
The values are taken from the {@code properties} element and from the properties
in the files listed in the {@code filters} element.
<p>The default value is {@code false}.</p>
4.1.0+
Whether the directory described by this source element should be included in the build.
This flag provides an easy way to include or exclude some sources depending, for example,
o property values defined in profiles. A use case is including optional resources only
when the user confirmed a license agreement.
<p>The default value is {@code true}.</p>
3.0.0+
Describe the directory where the resources are stored. The path is relative
to the POM.
3.0.0+
A list of patterns to include, e.g. {@code **/*.xml}.
3.0.0+
A list of patterns to exclude, e.g. {@code **/*.xml}
4.0.0+
Describes a build extension to utilise.
4.0.0+
The group ID of the extension's artifact.
4.0.0+
The artifact ID of the extension.
4.0.0+
The version of the extension.
4.1.0+
The configuration of the extension.
@since Maven 4.0.0