Index (Maven Plugin Tool for Java with Mojo Javadoc Tags 3.3 API)

A C D E G I J L M O P R S T V

A

AGGREGATOR - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation: Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of projects listed as modules.

C

COMPONENT - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation: Populate the field with an instance of a Plexus component.
COMPONENT - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor: Deprecated.
since 2.4, use JavaMojoAnnotation.COMPONENT instead of.
COMPONENT_ROLE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation: Refer to @component role="..."
COMPONENT_ROLE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor: Deprecated.
since 2.4, use JavaMojoAnnotation.COMPONENT_ROLE instead of.
COMPONENT_ROLEHINT - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation: Refer to @component roleHint="..."
COMPONENT_ROLEHINT - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor: Deprecated.
since 2.4, use JavaMojoAnnotation.COMPONENT_ROLEHINT instead of.
CONFIGURATOR - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation: The configurator type to use when injecting parameter values into this Mojo.
CONFIGURATOR - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor: Deprecated.
since 2.4, use JavaMojoAnnotation.CONFIGURATOR instead of.
createMojoDescriptor(JavaClass) - Method in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor





D

DEPRECATED - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @deprecated <since-text>
 

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

DEPRECATED - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.DEPRECATED instead of.


DESCRIPTION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The description for the Mojo.

discoverClasses(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor
 




E

EXECUTE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @execute ...


EXECUTE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.EXECUTE instead of.


execute(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor
EXECUTE_GOAL - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The Mojo goal will be executed in isolation.

EXECUTE_GOAL - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.EXECUTE_GOAL instead of.


EXECUTE_LIFECYCLE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The Mojo will be invoked in a parallel lifecycle.

EXECUTE_LIFECYCLE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.EXECUTE_LIFECYCLE instead of.


EXECUTE_PHASE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The Mojo will be invoked in a parallel lifecycle, ending at the given phase.

EXECUTE_PHASE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.EXECUTE_PHASE instead of.


EXECUTION_STATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @executionStrategy <strategy>.





G

GOAL - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The name for the Mojo that users will reference to execute it.

GOAL - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.GOAL instead of.


GOAL_DESCRIPTION - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.DESCRIPTION instead of.


GOAL_INHERIT_BY_DEFAULT - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.INHERIT_BY_DEFAULT instead of.


GOAL_IS_AGGREGATOR - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.AGGREGATOR instead of.


GOAL_MULTI_EXECUTION_STRATEGY - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.MULTI_EXECUTION_STRATEGY instead of.


GOAL_REQUIRES_DEPENDENCY_RESOLUTION - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION instead of.


GOAL_REQUIRES_DIRECT_INVOCATION - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.REQUIRES_DIRECT_INVOCATION instead of.


GOAL_REQUIRES_ONLINE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.REQUIRES_ONLINE instead of.


GOAL_REQUIRES_PROJECT - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.REQUIRES_PROJECT instead of.


GOAL_REQUIRES_REPORTS - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.REQUIRES_REPORTS instead of.






I

IMPLEMENTATION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The Mojo's fully-qualified class name.

INHERIT_BY_DEFAULT - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Allow Mojo inheritance.

INSTANTIATION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @instantiationStrategy <per-lookup>.





J

JavaMojoAnnotation - Interface in org.apache.maven.tools.plugin.extractor.java

List of all Javadoc annotations used to describe a java Mojo.

JavaMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.java

Extracts Mojo descriptors from Java sources.

JavaMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor
 




L

LANGUAGE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

The implementation language for the Mojo.





M

MAVEN_PLUGIN_INSTANTIATION - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.INSTANTIATION_STRATEGY instead of.


MULTI_EXECUTION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Deprecated.
use @executionStrategy always instead






O

org.apache.maven.tools.plugin.extractor.java - package org.apache.maven.tools.plugin.extractor.java
 




P

PARAMETER - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @parameter ...


PARAMETER - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.PARAMETER instead of.


PARAMETER_ALIAS - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

This defines an alias which can be used to configure a parameter.

PARAMETER_ALIAS - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.PARAMETER_ALIAS instead of.


PARAMETER_DEFAULT_VALUE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

This defines the default value to be injected into this parameter of the Mojo at build time.

PARAMETER_DEFAULT_VALUE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.PARAMETER_DEFAULT_VALUE instead of.


PARAMETER_EXPRESSION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Deprecated.
use PARAMETER_PROPERTY instead


PARAMETER_EXPRESSION - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.PARAMETER_EXPRESSION instead of.


PARAMETER_IMPLEMENTATION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

This defines the default implementation in the case the parameter type is an interface.

PARAMETER_IMPLEMENTATION - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.PARAMETER_IMPLEMENTATION instead of.


PARAMETER_NAME - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

This defines the name of the bean property used to get/set the field: by default, field name is used.

PARAMETER_PROPERTY - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

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.

PHASE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @phase <phaseName>.

PHASE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.PHASE instead of.






R

READONLY - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
 configuration).

READONLY - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.READONLY instead of.


REQUIRED - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Specifies that this parameter is required for the Mojo to function.

REQUIRED - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.REQUIRED instead of.


REQUIRES_DEPENDENCY_COLLECTION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be collected
 before it can execute.

REQUIRES_DEPENDENCY_RESOLUTION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope) to be resolved
 before it can execute.

REQUIRES_DIRECT_INVOCATION - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @requiresDirectInvocation <true|false>.

REQUIRES_ONLINE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Flags this Mojo to run online.

REQUIRES_PROJECT - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Flags this Mojo to run inside of a project.

REQUIRES_REPORTS - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Flags this Mojo to run inside reports.





S

SINCE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Refer to @since <deprecated-text>
 

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

SINCE - Static variable in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor

Deprecated.
since 2.4, use JavaMojoAnnotation.SINCE instead of.






T

THREAD_SAFE - Static variable in interface org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation

Indicates that this mojo is thread-safe and can be run in parallel.





V

validate(MojoDescriptor) - Method in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor
 
validateParameter(Parameter, int) - Method in class org.apache.maven.tools.plugin.extractor.java.JavaMojoDescriptorExtractor
 

A C D E G I J L M O P R S T V