JavadocMojoAnnotation (Maven Plugin Tools 3.6.1 API)

All Known Implementing Classes:

JavaJavadocMojoDescriptorExtractor
```
public interface JavadocMojoAnnotation
```
List of all Javadoc annotations used to describe a java Mojo.

Since:

2.4

Author:

Vincent Siveton

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AGGREGATOR` Flags this Mojo to run it in a multi module way, i.e.
`static String`	`COMPONENT` Populate the field with an instance of a Plexus component.
`static String`	`COMPONENT_ROLE` Refer to `@component role="..."`.
`static String`	`COMPONENT_ROLEHINT` Refer to `@component roleHint="..."`.
`static String`	`CONFIGURATOR` The configurator type to use when injecting parameter values into this Mojo.
`static String`	`DEPRECATED` Refer to `@deprecated <since-text>`
`static String`	`DESCRIPTION` The description for the Mojo.
`static String`	`EXECUTE` Refer to `@execute ...`.
`static String`	`EXECUTE_GOAL` The Mojo goal will be executed in isolation.
`static String`	`EXECUTE_LIFECYCLE` The Mojo will be invoked in a parallel lifecycle.
`static String`	`EXECUTE_PHASE` The Mojo will be invoked in a parallel lifecycle, ending at the given phase.
`static String`	`EXECUTION_STATEGY` Refer to `@executionStrategy <strategy>`.
`static String`	`GOAL` The name for the Mojo that users will reference to execute it.
`static String`	`IMPLEMENTATION` The Mojo's fully-qualified class name.
`static String`	`INHERIT_BY_DEFAULT` Allow Mojo inheritance.
`static String`	`INSTANTIATION_STRATEGY` Refer to `@instantiationStrategy <per-lookup>`.
`static String`	`LANGUAGE` The implementation language for the Mojo.
`static String`	`MULTI_EXECUTION_STRATEGY` Deprecated. use `@executionStrategy always` instead
`static String`	`PARAMETER` Refer to `@parameter ...`
`static String`	`PARAMETER_ALIAS` This defines an alias which can be used to configure a parameter.
`static String`	`PARAMETER_DEFAULT_VALUE` This defines the default value to be injected into this parameter of the Mojo at build time.
`static String`	`PARAMETER_EXPRESSION` Deprecated. use PARAMETER_PROPERTY instead
`static String`	`PARAMETER_IMPLEMENTATION` This defines the default implementation in the case the parameter type is an interface.
`static String`	`PARAMETER_NAME` This defines the name of the bean property used to get/set the field: by default, field name is used.
`static String`	`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.
`static String`	`PHASE` Refer to `@phase <phaseName>`.
`static String`	`READONLY` Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified configuration).
`static String`	`REQUIRED` Specifies that this parameter is required for the Mojo to function.
`static String`	`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.
`static String`	`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.
`static String`	`REQUIRES_DIRECT_INVOCATION` Refer to `@requiresDirectInvocation <true\|false>`.
`static String`	`REQUIRES_ONLINE` Flags this Mojo to run online.
`static String`	`REQUIRES_PROJECT` Flags this Mojo to run inside of a project.
`static String`	`REQUIRES_REPORTS` Flags this Mojo to run inside reports.
`static String`	`SINCE` Refer to `@since <deprecated-text>`
`static String`	`THREAD_SAFE` Indicates that this mojo is thread-safe and can be run in parallel.

- Field Detail
  - AGGREGATOR
```
static final String 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
```
static final 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.
    
    Refer to @configurator <roleHint>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
static final String 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
```
static final String EXECUTE
```
    Refer to @execute ....
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - EXECUTE_GOAL
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String EXECUTION_STATEGY
```
    Refer to @executionStrategy <strategy>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - GOAL
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String INSTANTIATION_STRATEGY
```
    Refer to @instantiationStrategy <per-lookup>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
static final String 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
static final String MULTI_EXECUTION_STRATEGY
```
    Deprecated. use @executionStrategy always instead
    
    Specifies the execution strategy.
    
    Refer to @attainAlways.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - PHASE
```
static final String PHASE
```
    Refer to @phase <phaseName>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - REQUIRES_DEPENDENCY_RESOLUTION
```
static final String 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 and test scopes.
    
    Refer to @requiresDependencyResolution <requiredScope>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - REQUIRES_DEPENDENCY_COLLECTION
```
static final String 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 and test scopes.
    
    Refer to @requiresDependencyCollection <requiredScope>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - REQUIRES_DIRECT_INVOCATION
```
static final String REQUIRES_DIRECT_INVOCATION
```
    Refer to @requiresDirectInvocation <true|false>.
    
    Note: Should be defined in a Mojo Type.
    
    See Also:
    
    Constant Field Values
  - REQUIRES_ONLINE
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String COMPONENT_ROLE
```
    Refer to @component role="...".
    
    Note: Should be defined in a Mojo Field.
    
    See Also:
    
    Constant Field Values
  - COMPONENT_ROLEHINT
```
static final String COMPONENT_ROLEHINT
```
    Refer to @component roleHint="...".
    
    Note: Should be defined in a Mojo Field.
    
    See Also:
    
    Constant Field Values
  - PARAMETER
```
static final String PARAMETER
```
    Refer to @parameter ...
    
    Note: Should be defined in a Mojo Field.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_NAME
```
static final String 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
```
static final String 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
```
static final String 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
static final String PARAMETER_EXPRESSION
```
    Deprecated. use PARAMETER_PROPERTY instead
    
    This 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
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String 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
```
static final String SINCE
```
    Refer to @since <deprecated-text>
    
    Note: Could be defined in a Mojo Type or a Mojo Field.
    
    See Also:
    
    Constant Field Values
  - DEPRECATED
```
static final String DEPRECATED
```
    Refer to @deprecated <since-text>
    
    Note: Could be defined in a Mojo Type or a Mojo Field.
    
    See Also:
    
    Constant Field Values

Interface JavadocMojoAnnotation

Field Summary

Field Detail

AGGREGATOR

CONFIGURATOR

DESCRIPTION

EXECUTE

EXECUTE_GOAL

EXECUTE_LIFECYCLE

EXECUTE_PHASE

EXECUTION_STATEGY

GOAL

IMPLEMENTATION

INHERIT_BY_DEFAULT

INSTANTIATION_STRATEGY

LANGUAGE

MULTI_EXECUTION_STRATEGY

PHASE

REQUIRES_DEPENDENCY_RESOLUTION

REQUIRES_DEPENDENCY_COLLECTION

REQUIRES_DIRECT_INVOCATION

REQUIRES_ONLINE

REQUIRES_PROJECT

REQUIRES_REPORTS

THREAD_SAFE

COMPONENT

COMPONENT_ROLE

COMPONENT_ROLEHINT

PARAMETER

PARAMETER_NAME

PARAMETER_ALIAS

PARAMETER_DEFAULT_VALUE

PARAMETER_EXPRESSION

PARAMETER_PROPERTY

PARAMETER_IMPLEMENTATION

READONLY

REQUIRED

SINCE

DEPRECATED