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