Serialized Form

source

Object source

longMessage

String longMessage

goal

String goal

pluginDescriptor

PluginDescriptor pluginDescriptor

expression

String expression

Parameter expression, to let user override default value with a system property, pom property or settings property.

implementation

String implementation

Field implementation.

defaultValue

String defaultValue

The default value, as an expression that will be evaluated at injection or run-time.

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 goal 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 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

Reference the invocation phase of the Mojo.

executeGoal

String executeGoal

Reference the invocation goal of the Mojo.

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) or runtime+system (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 only.

requiresProject

boolean requiresProject

Flags this Mojo to require running inside of a project.

requiresReports

boolean requiresReports

Flags this Mojo to require running inside of a reports context. 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 while 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 can 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

The field name which has this requirement.

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.