Index (Maven Plugin Tool for Java with Javadoc Tags 3.4 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.javadoc.JavadocMojoAnnotation: 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.javadoc.JavadocMojoAnnotation: Populate the field with an instance of a Plexus component.
COMPONENT_ROLE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: Refer to @component role="..."
COMPONENT_ROLEHINT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: Refer to @component roleHint="..."
CONFIGURATOR - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation: The configurator type to use when injecting parameter values into this Mojo.
createMojoDescriptor(JavaClass) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor





D

DEPRECATED - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @deprecated <since-text>
 

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

DESCRIPTION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The description for the Mojo.

discoverClasses(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 




E

EXECUTE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @execute ...


execute(PluginToolsRequest) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
EXECUTE_GOAL - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo goal will be executed in isolation.

EXECUTE_LIFECYCLE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo will be invoked in a parallel lifecycle.

EXECUTE_PHASE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

EXECUTION_STATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @executionStrategy <strategy>.





G

GOAL - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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





I

IMPLEMENTATION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The Mojo's fully-qualified class name.

INHERIT_BY_DEFAULT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Allow Mojo inheritance.

INSTANTIATION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @instantiationStrategy <per-lookup>.





J

JavadocMojoAnnotation - Interface in org.apache.maven.tools.plugin.extractor.javadoc

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

JavaJavadocMojoDescriptorExtractor - Class in org.apache.maven.tools.plugin.extractor.javadoc

Extracts Mojo descriptors from Java sources.

JavaJavadocMojoDescriptorExtractor() - Constructor for class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 




L

LANGUAGE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

The implementation language for the Mojo.





M

MULTI_EXECUTION_STRATEGY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Deprecated.
use @executionStrategy always instead






O

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




P

PARAMETER - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @parameter ...


PARAMETER_ALIAS - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

PARAMETER_DEFAULT_VALUE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

PARAMETER_EXPRESSION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Deprecated.
use PARAMETER_PROPERTY instead


PARAMETER_IMPLEMENTATION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

PARAMETER_NAME - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

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

Refer to @phase <phaseName>.





R

READONLY - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

REQUIRED - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

REQUIRES_DEPENDENCY_COLLECTION - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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

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

Refer to @requiresDirectInvocation <true|false>.

REQUIRES_ONLINE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo to run online.

REQUIRES_PROJECT - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo to run inside of a project.

REQUIRES_REPORTS - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Flags this Mojo to run inside reports.





S

SINCE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

Refer to @since <deprecated-text>
 

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





T

THREAD_SAFE - Static variable in interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

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.javadoc.JavaJavadocMojoDescriptorExtractor
 
validateParameter(Parameter, int) - Method in class org.apache.maven.tools.plugin.extractor.javadoc.JavaJavadocMojoDescriptorExtractor
 

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