Package org.apache.maven.tools.plugin.extractor.javadoc

Interface JavadocMojoAnnotation

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 Details

    • 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:

    • 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:

    • 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:

    • EXECUTE

      static final String EXECUTE

      Refer to @execute ....

      Note: Should be defined in a Mojo Type.

      See Also:

    • 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:

    • 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:

    • 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:

    • EXECUTION_STATEGY

      static final String EXECUTION_STATEGY

      Refer to @executionStrategy <strategy>.

      Note: Should be defined in a Mojo Type.

      See Also:

    • 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:

    • 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:

    • 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:

    • INSTANTIATION_STRATEGY

      static final String INSTANTIATION_STRATEGY

      Refer to @instantiationStrategy <per-lookup>.

      Note: Should be defined in a Mojo Type.

      See Also:

    • 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:

    • 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:

    • PHASE

      static final String PHASE

      Refer to @phase <phaseName>.

      Note: Should be defined in a Mojo Type.

      See Also:

    • 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:

    • 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:

    • REQUIRES_DIRECT_INVOCATION

      static final String REQUIRES_DIRECT_INVOCATION

      Refer to @requiresDirectInvocation <true|false>.

      Note: Should be defined in a Mojo Type.

      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • COMPONENT_ROLE

      static final String COMPONENT_ROLE

      Refer to @component role="...".

      Note: Should be defined in a Mojo Field.

      See Also:

    • COMPONENT_ROLEHINT

      static final String COMPONENT_ROLEHINT

      Refer to @component roleHint="...".

      Note: Should be defined in a Mojo Field.

      See Also:

    • PARAMETER

      static final String PARAMETER

      Refer to @parameter ...

      Note: Should be defined in a Mojo Field.

      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • SINCE

      static final String SINCE

      Refer to @since <deprecated-text>

      Note: Could be defined in a Mojo Type or a Mojo Field.

      See Also:

    • DEPRECATED

      static final String DEPRECATED

      Refer to @deprecated <since-text>

      Note: Could be defined in a Mojo Type or a Mojo Field.

      See Also: