Serialized Form

collisions

Map<K,V> collisions

pomFile

File pomFile

moduleFile

File moduleFile

moduleName

String moduleName

projectId

String projectId

groupId

String groupId

artifactId

String artifactId

version

String version

type

String type

baseMessage

String baseMessage

repositoryId

String repositoryId

layoutId

String layoutId

layout

ArtifactRepositoryLayout layout

Deprecated. 

snapshots

ArtifactRepositoryPolicy snapshots

Deprecated. 

releases

ArtifactRepositoryPolicy releases

Deprecated. 

blacklisted

boolean blacklisted

Deprecated. 

authentication

Authentication authentication

Deprecated. 

proxy

Proxy proxy

Deprecated. 

mirroredRepositories

List<E> mirroredRepositories

Deprecated. 

modelVersion

String modelVersion

The version of the underlying metadata model.

groupId

String groupId

The groupId that is directory represents, if any.

artifactId

String artifactId

The artifactId that is directory represents, if any.

version

String version

The version that is directory represents, if any.

versioning

Versioning versioning

Versioning information for the artifact.

plugins

List<E> plugins

Field plugins.

modelEncoding

String modelEncoding

Field modelEncoding.

name

String name

Display name for the plugin.

prefix

String prefix

The plugin invocation prefix (i.e. eclipse for eclipse:eclipse).

artifactId

String artifactId

The plugin artifactId.

timestamp

String timestamp

The time it was deployed.

buildNumber

int buildNumber

The incremental build number.

localCopy

boolean localCopy

Whether to use a local copy instead (with filename that includes the base version).

classifier

String classifier

The classifier of the snapshot artifact this version information belongs to.

extension

String extension

The file extension of the snapshot artifact this version information belongs to.

version

String version

The resolved snapshot version of the artifact.

updated

String updated

The timestamp when this version information was last updated. The timestamp is expressed using UTC in the format yyyyMMddHHmmss.

latest

String latest

What the latest version in the directory is, including snapshots.

release

String release

What the latest version in the directory is, of the releases.

snapshot

Snapshot snapshot

The current snapshot data in use for this version.

versions

List<E> versions

Field versions.

lastUpdated

String lastUpdated

When the metadata was last updated.

snapshotVersions

List<E> snapshotVersions

Field snapshotVersions.

lineNumber

int lineNumber

The one-based index of the line containing the error.

columnNumber

int columnNumber

The one-based index of the column containing the error.

groupId

String groupId

artifactId

String artifactId

version

String version

type

String type

classifier

String classifier

artifact

Artifact artifact

remoteRepositories

List<E> remoteRepositories

originalMessage

String originalMessage

path

String path

downloadUrl

String downloadUrl

artifact

Artifact artifact

resolvedArtifacts

List<E> resolvedArtifacts

missingArtifacts

List<E> missingArtifacts

project

MavenProject project

lifecycleId

String lifecycleId

lifecyclePhase

String lifecyclePhase

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

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. Note that in case of a multi-module build, only the default goal of the top-level project is relevant, i.e. the default goals of child modules are ignored. Since Maven 3, multiple goals/phases can be separated by whitespace.

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.

locations

Map<K,V> locations

Field locations.

inherited

String inherited

Whether any configuration should be propagated to child POMs. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is true.

configuration

Object configuration

The configuration as DOM object. You can control how child POMs inherit configuration from parent POMs by adding combine.children or combine.self attributes to the children of the configuration element:

• combine.children: available values are merge (default) and append,
• combine.self: available values are merge (default) and override.

See POM Reference documentation and Xpp3DomUtils for more information.

locations

Map<K,V> locations

Field locations.

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. Typically, this is a number in the range -12 to +14 or a valid time zone id like "America/Montreal" (UTC-05:00) or "Europe/Paris" (UTC+01:00).

properties

Properties properties

Field properties.

locations

Map<K,V> locations

Field locations.

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

String 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. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

locations

Map<K,V> locations

Field locations.

dependencies

List<E> dependencies

Field dependencies.

locations

Map<K,V> locations

Field locations.

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).

locations

Map<K,V> locations

Field locations.

artifactId

String artifactId

The artifact ID of the project to exclude.

groupId

String groupId

The group ID of the project to exclude.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

directory

String directory

Describe the directory where the resources are stored. The path is relative to the POM.

lineNumber

int lineNumber

The one-based line number. The value will be non-positive if unknown.

columnNumber

int columnNumber

The one-based column number. The value will be non-positive if unknown.

source

InputSource source

Field source.

locations

Map<K,V> locations

Field locations.

modelId

String modelId

The identifier of the POM in the format <groupId>:<artifactId>:<version>.

location

String location

The path/URL of the POM or null if unknown.

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

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.

developers

List<E> developers

Field developers.

contributors

List<E> contributors

Field contributors.

mailingLists

List<E> mailingLists

Field mailingLists.

prerequisites

Prerequisites prerequisites

Describes the prerequisites in the build environment for this project.

scm

Scm scm

Specification for the SCM used by the project, such as CVS, Subversion, etc.

issueManagement

IssueManagement issueManagement

The project's issue management system information.

ciManagement

CiManagement ciManagement

The project's continuous integration information.

build

Build build

Information required to build the project.

profiles

List<E> profiles

Field profiles.

modelEncoding

String modelEncoding

Field modelEncoding.

pomFile

File pomFile

The POM from which this model originated. This is transient runtime state and therefore not managed by Modello.

modules

List<E> modules

Field modules.

distributionManagement

DistributionManagement distributionManagement

Distribution information for a project that enables deployment of the site and artifacts to remote web servers and repositories respectively.

properties

Properties properties

Field properties.

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.

dependencies

List<E> dependencies

Field dependencies.

repositories

List<E> repositories

Field repositories.

pluginRepositories

List<E> pluginRepositories

Field pluginRepositories.

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

name

String name

The full name of the organization.

url

String url

The URL to the organization's home page.

locations

Map<K,V> locations

Field locations.

groupId

String groupId

The group id of the parent project to inherit from.

artifactId

String artifactId

The artifact 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. If not specified, it defaults to ../pom.xml. Maven looks for the parent POM first 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. Set the value to an empty string in case you want to disable the feature and always resolve the parent POM from the repositories.

locations

Map<K,V> locations

Field locations.

includes

List<E> includes

Field includes.

excludes

List<E> excludes

Field excludes.

locations

Map<K,V> locations

Field locations.

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

String 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. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

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.

locations

Map<K,V> locations

Field locations.

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 and profile injection.

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.

priority

int priority

The priority of this execution compared to other executions which are bound to the same phase. Warning: This is an internal utility property that is only public for technical reasons, it is not part of the public API. In particular, this property can be changed or deleted without prior notice.

goals

List<E> goals

Field goals.

maven

String maven

The minimum version of Maven required to build the project, or to use this plugin.

locations

Map<K,V> locations

Field locations.

id

String id

The identifier of this build profile. This is used for command line activation, and identifies profiles to be merged.

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.

locations

Map<K,V> locations

Field locations.

excludeDefaults

String excludeDefaults

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 String for technical reasons, the semantic type is actually Boolean. Default value is false.

outputDirectory

String outputDirectory

Where to store all of the generated reports. The default is ${project.build.directory}/site .

plugins

List<E> plugins

Field plugins.

locations

Map<K,V> locations

Field locations.

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.

reportSets

List<E> reportSets

Field reportSets.

reportSetMap

Map<K,V> reportSetMap

id

String id

The unique id for this report set, to be used during POM inheritance and profile injection for merging of report sets.

reports

List<E> reports

Field reports.

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. Furthermore, the identifier is used during POM inheritance and profile injection to detect repositories that should be merged.

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.

locations

Map<K,V> locations

Field locations.

enabled

String enabled

Whether to use this repository for downloading this type of artifact. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is true.

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).

locations

Map<K,V> locations

Field locations.

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

String 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. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is false.

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.

locations

Map<K,V> locations

Field locations.

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.

locations

Map<K,V> locations

Field locations.

result

ModelBuildingResult result

lineNumber

int lineNumber

The one-based index of the line containing the error.

columnNumber

int columnNumber

The one-based index of the column containing the error.

repository

Repository repository

The repository that raised this error, can be null.

groupId

String groupId

The group id of the unresolvable model.

artifactId

String artifactId

The artifact id of the unresolvable model.

version

String version

The version of the unresolvable model.

source

Object source

longMessage

String longMessage

plugin

Plugin plugin

goal

String goal

pluginDescriptor

PluginDescriptor pluginDescriptor

pluginDescriptor

PluginDescriptor pluginDescriptor

originalMessage

String originalMessage

pluginRealm

org.codehaus.plexus.classworlds.realm.ClassRealm pluginRealm

mojoExecution

MojoExecution mojoExecution

pluginKey

String pluginKey

pluginGroupId

String pluginGroupId

pluginArtifactId

String pluginArtifactId

pluginVersion

String pluginVersion

goal

String goal

project

MavenProject project

plugin

Plugin plugin

parameters

List<E> parameters

mojo

MojoDescriptor mojo

plugin

Plugin plugin

expression

String expression

Parameter expression.

implementation

String implementation

Field implementation.

defaultValue

String defaultValue

Field defaultValue.

groupId

String groupId

The group id of the dependency.

artifactId

String artifactId

The artifact id of the dependency.

version

String version

The version of the dependency.

type

String type

The type of dependency.

goal

String goal

The name for the Mojo that users will reference from the command line to execute the Mojo directly, or inside a POM in order to provide Mojo-specific configuration.

description

String description

The description of this Mojo's functionality.

implementation

String implementation

The Mojo's fully-qualified class name (or script path in the case of non-Java Mojos).

language

String language

The implementation language for this Mojo (Java, beanshell, etc.).

phase

String phase

Defines a default phase to bind a mojo execution to if the user does not explicitly set a phase in the POM. Note: This annotation will not automagically make a mojo run when the plugin declaration is added to the POM. It merely enables the user to omit the <phase> element from the surrounding <execution> element.

executePhase

String executePhase

Field executePhase.

executeGoal

String executeGoal

Field executeGoal.

executeLifecycle

String executeLifecycle

Field executeLifecycle.

requiresDependencyResolution

String requiresDependencyResolution

Flags this Mojo as requiring the dependencies in the specified class path to be resolved before it can execute: compile, runtime, test, compile+runtime (since Maven 3.0) .

requiresDependencyCollection

String requiresDependencyCollection

Flags this mojo as requiring information about the dependencies that would make up the specified class path. As the name suggests, this is similar to requiresDependencyResolution and supports the same values. The important difference is this will not resolve the files for the dependencies, i.e. the artifacts associated with a Maven project can lack a file. As such, this annotation is meant for mojos that only want to analyze the set of transitive dependencies, in particular during early lifecycle phases where full dependency resolution might fail due to projects which haven't been built yet.

requiresDirectInvocation

boolean requiresDirectInvocation

Flags this Mojo to be invoked directly.

requiresProject

boolean requiresProject

Flags this Mojo to run inside of a project.

requiresReports

boolean requiresReports

Flags this Mojo to require reports. Unsupported since Maven 3.0.

requiresOnline

boolean requiresOnline

Flags this Mojo to require online mode for its operation.

aggregator

boolean aggregator

Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of projects listed as modules.

inheritedByDefault

boolean inheritedByDefault

Specify that the Mojo is inherited.

threadSafe

boolean threadSafe

Marks this mojo as being thread-safe, i.e. the mojo safely supports concurrent execution during parallel builds. Mojos without this annotation will make Maven output a warning when used during a parallel build session. Since Maven 3.0.

instantiationStrategy

String instantiationStrategy

Specify the instantiation strategy.

executionStrategy

String executionStrategy

Specify the execution strategy: once-per-session, always.

since

String since

Specify the version when the Mojo was added to the API. Similar to Javadoc since.

deprecated

String deprecated

Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated. This will trigger a warning when a user tries to configure a parameter marked as deprecated.

configurator

String configurator

The configurator type to use when injecting parameter values into this Mojo. The value is normally deduced from the Mojo's implementation language, but can be specified to allow a custom ComponentConfigurator implementation to be used.

composer

String composer

Field composer.

parameters

List<E> parameters

Field parameters.

configuration

List<E> configuration

Field configuration.

requirements

List<E> requirements

Field requirements.

name

String name

The name of the parameter, to be used in configuring this parameter from the Mojo's declared defaults or from the POM.

alias

String alias

Specifies an alias which can be used to configure this parameter from the POM. This is primarily useful to improve user-friendliness, where Mojo field names are not intuitive to the user or are otherwise not conducive to configuration via the POM.

type

String type

The Java type for this parameter. This is used to validate the result of any expressions used to calculate the value which should be injected into the Mojo for this parameter.

required

boolean required

Whether this parameter is required for the Mojo to function. This is used to validate the configuration for a Mojo before it is injected, and before the Mojo is executed from some half-state.

editable

boolean editable

Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration). This is useful when you want to force the user to use common POM elements rather than plugin configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you want the user to modify <build><finalName/></build> rather than specifying a value for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.

implementation

String implementation

Field implementation.

description

String description

The description of this parameter's use inside the Mojo.

since

String since

Specify the version when the parameter was added to the API. Similar to Javadoc since.

deprecated

String deprecated

Specify the version when the parameter was deprecated to the API. Similar to Javadoc deprecated. This will trigger a warning when a user tries to configure a parameter marked as deprecated.

description

String description

Description of the plugin.

groupId

String groupId

The group id of the plugin.

artifactId

String artifactId

The artifact id of the plugin.

version

String version

The version of the plugin.

goalPrefix

String goalPrefix

Field goalPrefix.

isolatedRealm

boolean isolatedRealm

Field isolatedRealm.

inheritedByDefault

boolean inheritedByDefault

Field inheritedByDefault.

mojos

List<E> mojos

Field mojos.

dependencies

List<E> dependencies

Field dependencies.

modelEncoding

String modelEncoding

Field modelEncoding.

role

String role

Field role.

roleHint

String roleHint

Field roleHint.

fieldName

String fieldName

Field fieldName.

configuration

Object configuration

Configuration to pass to the goals.

goals

List<E> goals

Field goals.

id

String id

The ID of this lifecycle, for identification in the mojo descriptor.

phases

List<E> phases

Field phases.

lifecycles

List<E> lifecycles

Field lifecycles.

modelEncoding

String modelEncoding

Field modelEncoding.

id

String id

The ID of this phase, eg generate-sources.

executions

List<E> executions

Field executions.

configuration

Object configuration

Configuration to pass to all goals run in this phase.

groupId

String groupId

artifactId

String artifactId

groupId

String groupId

artifactId

String artifactId

baseMessage

String baseMessage

activeByDefault

boolean activeByDefault

Flag specifying whether this profile is active as a default.

jdk

String jdk

Specifies that this profile will be activated when a matching JDK is detected.

os

ActivationOS os

Specifies that this profile will be activated when matching OS 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 should be missing to activate a profile.

exists

String exists

The name of the file that should exist to activate a profile.

name

String name

The name of the OS to be used to activate a profile.

family

String family

The general family of the OS to be used to activate a profile (e.g. 'windows').

arch

String arch

The architecture of the OS to be used to activate a profile.

version

String version

The version of the OS to be used to activate a profile.

name

String name

The name of the property to be used to activate a profile.

value

String value

The value of the property to be used to activate a profile.

id

String id

The ID of this build profile, for activation purposes.

activation

Activation activation

The conditional logic which will automatically trigger the inclusion of this profile.

properties

Properties properties

Field properties.

repositories

List<E> repositories

Field repositories.

pluginRepositories

List<E> pluginRepositories

This may be removed or relocated in the near future. It is undecided whether plugins really need a remote repository set of their own.

profiles

List<E> profiles

Field profiles.

activeProfiles

List<E> activeProfiles

Field activeProfiles.

modelEncoding

String modelEncoding

Field modelEncoding.

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.

name

String name

Human readable name of the repository .

url

String url

The url of the repository .

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 - warn, fail, etc. Valid values are "fail" or "warn".

serialVersionUID: -90820222109103638L

result

DependencyResolutionResult result

artifact

Artifact artifact

project

MavenProject project

projectId

String projectId

existingProjectFile

File existingProjectFile

conflictingProjectFile

File conflictingProjectFile

validationResult

ModelValidationResult validationResult

Deprecated. 

locationInPom

String locationInPom

offendingVersion

String offendingVersion

projectId

String projectId

pomFile

File pomFile

results

List<E> results

dependency

Dependency dependency

expression

String expression

Deprecated. 

originalMessage

String originalMessage

Deprecated. 

eventType

int eventType

requestType

int requestType

exception

Exception exception

localFile

File localFile

artifact

ArtifactTransferResource artifact

transferredBytes

long transferredBytes

dataBuffer

byte[] dataBuffer

dataOffset

int dataOffset

dataLength

int dataLength

dependency

Dependency dependency

projectId

String projectId

pomFile

File pomFile

cause

InvalidVersionSpecificationException cause

serialVersionUID: 1L

originalMessage

String originalMessage

repositoryId

String repositoryId

artifact

Artifact artifact

serialVersionUID: 3372412184339653914L

serialVersionUID: 2677613140287940255L

serialVersionUID: -4029897098314019152L

artifact

ArtifactMetadata artifact

activeByDefault

boolean activeByDefault

Flag specifying whether this profile is active as a default.

jdk

String jdk

Specifies that this profile will be activated when a matching JDK is detected.

os

ActivationOS os

Specifies that this profile will be activated when matching OS 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 should be missing to activate a profile.

exists

String exists

The name of the file that should exist to activate a profile.

name

String name

The name of the OS to be used to activate a profile.

family

String family

The general family of the OS to be used to activate a profile (e.g. 'windows') .

arch

String arch

The architecture of the OS to be used to activate a profile.

version

String version

The version of the OS to be used to activate a profile.

name

String name

The name of the property to be used to activate a profile.

value

String value

The value of the property to be used to activate a profile.

id

String id

Field id.

mirrorOf

String mirrorOf

The server ID of the repository being mirrored, eg "central". This MUST NOT match the mirror id.

name

String name

The optional name that describes the mirror.

url

String url

The URL of the mirror repository.

layout

String layout

The layout of the mirror repository. Since Maven 3.

mirrorOfLayouts

String mirrorOfLayouts

The layouts of repositories being mirrored. This value can be used to restrict the usage of the mirror to repositories with a matching layout (apart from a matching id). Since Maven 3.

activation

Activation activation

The conditional logic which will automatically trigger the inclusion of this profile.

properties

Properties properties

Field properties.

repositories

List<E> repositories

Field repositories.

pluginRepositories

List<E> pluginRepositories

This may be removed or relocated in the near future. It is undecided whether plugins really need a remote repository set of their own.

active

boolean active

Whether this proxy configuration is the active one.

protocol

String protocol

The proxy protocol.

username

String username

The proxy user.

password

String password

The proxy password.

port

int port

The proxy port.

host

String host

The proxy host.

nonProxyHosts

String nonProxyHosts

The list of non-proxied hosts (delimited by |).

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.

name

String name

Human readable name of the repository.

url

String url

The url of the repository.

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 - warn, fail, etc. Valid values are "fail" or "warn".

username

String username

The username used to authenticate.

password

String password

The password used in conjunction with the username to authenticate.

privateKey

String privateKey

The private key location used to authenticate.

passphrase

String passphrase

The passphrase used in conjunction with the privateKey to authenticate.

filePermissions

String filePermissions

The permissions for files when they are created.

directoryPermissions

String directoryPermissions

The permissions for directories when they are created.

configuration

Object configuration

Extra configuration for the transport layer.

localRepository

String localRepository

The local repository.
Default value is: ${user.home}/.m2/repository

interactiveMode

boolean interactiveMode

Whether Maven should attempt to interact with the user for input.

usePluginRegistry

boolean usePluginRegistry

Whether Maven should use the plugin-registry.xml file to manage plugin versions.

offline

boolean offline

Indicate whether maven should operate in offline mode full-time.

proxies

List<E> proxies

Field proxies.

servers

List<E> servers

Field servers.

mirrors

List<E> mirrors

Field mirrors.

profiles

List<E> profiles

Field profiles.

activeProfiles

List<E> activeProfiles

Field activeProfiles.

pluginGroups

List<E> pluginGroups

Field pluginGroups.

modelEncoding

String modelEncoding

Field modelEncoding.

activeProxy

Proxy activeProxy

profileMap

Map<K,V> profileMap

runtimeInfo

RuntimeInfo runtimeInfo

lineNumber

int lineNumber

columnNumber

int columnNumber

sourceLevel

String sourceLevel

sourceLevelSet

boolean sourceLevelSet

problems

List<E> problems

lineNumber

int lineNumber

The one-based index of the line containing the error.

columnNumber

int columnNumber

The one-based index of the column containing the error.

toolchains

List<E> toolchains

Field toolchains.

modelEncoding

String modelEncoding

Field modelEncoding.

type

String type

Type of toolchain.

provides

Object provides

Field provides.

configuration

Object configuration

Field configuration.

syntax

String syntax

The syntax of the expression.

description

String description

The description of what this expression references, and what it's generally used for.

configuration

String configuration

The place and syntax used to change the value of this expression.

cliOptions

Properties cliOptions

Field cliOptions.

apiMethods

Properties apiMethods

Field apiMethods.

deprecation

String deprecation

A preferred alternative to this expression, in the case where it's deprecated.

ban

String ban

A preferred alternative to this expression, in the case where it's banned from use.

editable

boolean editable

Whether the value of this expression can be changed.

expressions

List<E> expressions

Field expressions.

modelEncoding

String modelEncoding

Field modelEncoding.

expressionsBySyntax

Map<K,V> expressionsBySyntax

serialVersionUID: 1L