Interface JavadocMojoAnnotation
- All Known Implementing Classes:
JavaJavadocMojoDescriptorExtractor
- Since:
- 2.4
- Author:
- Vincent Siveton
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic String
Flags this Mojo to run it in a multi module way, i.e.static String
Populate the field with an instance of a Plexus component.static String
Refer to@component role="..."
.static String
Refer to@component roleHint="..."
.static String
The configurator type to use when injecting parameter values into this Mojo.static String
Refer to@deprecated <since-text>
static String
The description for the Mojo.static String
Refer to@execute ...
.static String
The Mojo goal will be executed in isolation.static String
The Mojo will be invoked in a parallel lifecycle.static String
The Mojo will be invoked in a parallel lifecycle, ending at the given phase.static String
Refer to@executionStrategy <strategy>
.static String
The name for the Mojo that users will reference to execute it.static String
The Mojo's fully-qualified class name.static String
Allow Mojo inheritance.static String
Refer to@instantiationStrategy <per-lookup>
.static String
The implementation language for the Mojo.static String
Deprecated.static String
Refer to@parameter ...
static String
This defines an alias which can be used to configure a parameter.static String
This defines the default value to be injected into this parameter of the Mojo at build time.static String
Deprecated.use PARAMETER_PROPERTY insteadstatic String
This defines the default implementation in the case the parameter type is an interface.static String
This defines the name of the bean property used to get/set the field: by default, field name is used.static String
This defines the property used to calculate the value to be injected into this parameter of the Mojo at build time, which can come from-D
execution, setting properties or pom properties.static String
Refer to@phase <phaseName>
.static String
Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).static String
Specifies that this parameter is required for the Mojo to function.static String
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected before it can execute.static String
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved before it can execute.static String
Refer to@requiresDirectInvocation <true|false>
.static String
Flags this Mojo to run online.static String
Flags this Mojo to run inside of a project.static String
Flags this Mojo to run inside reports.static String
Refer to@since <deprecated-text>
static String
Indicates that this mojo is thread-safe and can be run in parallel.
-
Field Details
-
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.
Refer to
@aggregator
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
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.
Refer to
@configurator <roleHint>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
DESCRIPTION
The description for the Mojo.
Refer to
@description
.Note: Should be defined in a Mojo Type.
Note: Mojo's description is auto-detected.
- See Also:
- Constant Field Values
-
EXECUTE
Refer to
@execute ...
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
EXECUTE_GOAL
The Mojo goal will be executed in isolation.
Refer to
@execute goal="<goalName>"
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
EXECUTE_LIFECYCLE
The Mojo will be invoked in a parallel lifecycle.
Refer to
@execute lifecycle="<lifecycleId>"
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
EXECUTE_PHASE
The Mojo will be invoked in a parallel lifecycle, ending at the given phase.
Refer to
@execute phase="<phaseName>"
.Refer to
@execute lifecycle="<lifecycleId>" phase="<phaseName>"
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
EXECUTION_STATEGY
Refer to
@executionStrategy <strategy>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
GOAL
The name for the Mojo that users will reference to execute it.
Refer to
@goal <goalName>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
IMPLEMENTATION
The Mojo's fully-qualified class name.
Refer to
@implementation
.Note: Should be defined in a Mojo Type.
Note: Mojo's implementation is auto-detected.
- See Also:
- Constant Field Values
-
INHERIT_BY_DEFAULT
Allow Mojo inheritance.
Refer to
@inheritByDefault <true|false>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
INSTANTIATION_STRATEGY
Refer to
@instantiationStrategy <per-lookup>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
LANGUAGE
The implementation language for the Mojo.
Refer to
@language
.Note: Should be defined in a Mojo Type.
Note: Mojo's implementation is auto-detected.
- See Also:
- Constant Field Values
-
MULTI_EXECUTION_STRATEGY
Deprecated.use@executionStrategy always
insteadSpecifies the execution strategy.
Refer to
@attainAlways
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
PHASE
Refer to
@phase <phaseName>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
REQUIRES_DEPENDENCY_RESOLUTION
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved before it can execute. Currently supports
compile
,runtime
,compile+runtime
andtest
scopes.Refer to
@requiresDependencyResolution <requiredScope>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
REQUIRES_DEPENDENCY_COLLECTION
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected before it can execute. Currently supports
compile
,runtime
,compile+runtime
andtest
scopes.Refer to
@requiresDependencyCollection <requiredScope>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
REQUIRES_DIRECT_INVOCATION
Refer to
@requiresDirectInvocation <true|false>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
REQUIRES_ONLINE
Flags this Mojo to run online.
Refer to
@requiresOnline <true|false>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
REQUIRES_PROJECT
Flags this Mojo to run inside of a project.
Refer to
@requiresProject <true|false>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
REQUIRES_REPORTS
Flags this Mojo to run inside reports.
Refer to
@requiresReports <true|false>
.Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
THREAD_SAFE
Indicates that this mojo is thread-safe and can be run in parallel.
Note: Should be defined in a Mojo Type.
- See Also:
- Constant Field Values
-
COMPONENT
Populate the field with an instance of a Plexus component. This is like declaring a requirement in a Plexus component.
Refer to
@component ...
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
COMPONENT_ROLE
Refer to
@component role="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
COMPONENT_ROLEHINT
Refer to
@component roleHint="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER
Refer to
@parameter ...
Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER_NAME
This defines the name of the bean property used to get/set the field: by default, field name is used.
Refer to
@parameter name="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER_ALIAS
This defines an alias which can be used to configure a parameter. This is primarily useful to improve user-friendliness.
Refer to
@parameter alias="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER_DEFAULT_VALUE
This defines the default value to be injected into this parameter of the Mojo at build time.
Refer to
@parameter default-value="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER_EXPRESSION
Deprecated.use PARAMETER_PROPERTY insteadThis defines the expression used to calculate the value to be injected into this parameter of the Mojo at build time.
Refer to
@parameter expression="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER_PROPERTY
This defines the property used to calculate the value to be injected into this parameter of the Mojo at build time, which can come from
-D
execution, setting properties or pom properties.Refer to
@parameter property="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
PARAMETER_IMPLEMENTATION
This defines the default implementation in the case the parameter type is an interface.
Refer to
@parameter implementation="..."
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
READONLY
Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
Refer to
@readonly
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
REQUIRED
Specifies that this parameter is required for the Mojo to function.
Refer to
@required
.Note: Should be defined in a Mojo Field.
- See Also:
- Constant Field Values
-
SINCE
Refer to
@since <deprecated-text>
Note: Could be defined in a Mojo Type or a Mojo Field.
- See Also:
- Constant Field Values
-
DEPRECATED
Refer to
@deprecated <since-text>
Note: Could be defined in a Mojo Type or a Mojo Field.
- See Also:
- Constant Field Values
-
@executionStrategy always
instead