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

Class JavaJavadocMojoDescriptorExtractor

java.lang.Object

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

All Implemented Interfaces:

JavadocMojoAnnotation, MojoDescriptorExtractor

@Named("java-javadoc")
@Singleton
public class JavaJavadocMojoDescriptorExtractor
extends Object
implements MojoDescriptorExtractor, JavadocMojoAnnotation

Extracts Mojo descriptors from Java source javadoc comments only. New mojos should rather rely on annotations and comments which are evaluated by extractor named java.

For more information about the usage tag, have a look to: https://maven.apache.org/developers/mojo-api-specification.html

See Also:

• MojoDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface org.apache.maven.tools.plugin.extractor.javadoc.JavadocMojoAnnotation

AGGREGATOR, COMPONENT, COMPONENT_ROLE, COMPONENT_ROLEHINT, CONFIGURATOR, DEPRECATED, DESCRIPTION, EXECUTE, EXECUTE_GOAL, EXECUTE_LIFECYCLE, EXECUTE_PHASE, EXECUTION_STATEGY, GOAL, IMPLEMENTATION, INHERIT_BY_DEFAULT, INSTANTIATION_STRATEGY, LANGUAGE, MULTI_EXECUTION_STRATEGY, PARAMETER, PARAMETER_ALIAS, PARAMETER_DEFAULT_VALUE, PARAMETER_EXPRESSION, PARAMETER_IMPLEMENTATION, PARAMETER_NAME, PARAMETER_PROPERTY, PHASE, READONLY, REQUIRED, REQUIRES_DEPENDENCY_COLLECTION, REQUIRES_DEPENDENCY_RESOLUTION, REQUIRES_DIRECT_INVOCATION, REQUIRES_ONLINE, REQUIRES_PROJECT, REQUIRES_REPORTS, SINCE, THREAD_SAFE

Constructor Summary

Constructors

Constructor	Description
JavaJavadocMojoDescriptorExtractor()

Method Summary

Modifier and Type	Method	Description
protected org.apache.maven.plugin.descriptor.MojoDescriptor	createMojoDescriptor(com.thoughtworks.qdox.model.JavaClass javaClass)
protected Collection<com.thoughtworks.qdox.model.JavaClass>	discoverClasses(PluginToolsRequest request)
List<org.apache.maven.plugin.descriptor.MojoDescriptor>	execute(PluginToolsRequest request)	Execute the mojo extraction.
GroupKey	getGroupKey()	Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups.
String	getName()	Returns the "name" (id) of the extractor.
boolean	isDeprecated()	Returns true if extractor is deprecated.
protected void	validate(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor)
protected void	validateParameter(org.apache.maven.plugin.descriptor.Parameter parameter, int i)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

getRequiredJavaVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

JavaJavadocMojoDescriptorExtractor

public JavaJavadocMojoDescriptorExtractor()

Method Details

getName

public String getName()

Description copied from interface: MojoDescriptorExtractor

Returns the "name" (id) of the extractor.

Specified by:

getName in interface MojoDescriptorExtractor

isDeprecated

public boolean isDeprecated()

Description copied from interface: MojoDescriptorExtractor

Returns true if extractor is deprecated.

Specified by:

isDeprecated in interface MojoDescriptorExtractor

getGroupKey

public GroupKey getGroupKey()

Description copied from interface: MojoDescriptorExtractor

Returns the GroupKey of extractor, as MojoScanner will execute them grouped, and ordered within groups. Must never return null.

Specified by:

getGroupKey in interface MojoDescriptorExtractor

validateParameter

protected void validateParameter(org.apache.maven.plugin.descriptor.Parameter parameter,
 int i)
                          throws org.apache.maven.plugin.descriptor.InvalidParameterException

Parameters:

parameter - not null

i - positive number

Throws:

org.apache.maven.plugin.descriptor.InvalidParameterException - if any

createMojoDescriptor

protected org.apache.maven.plugin.descriptor.MojoDescriptor createMojoDescriptor(com.thoughtworks.qdox.model.JavaClass javaClass)
                                                                          throws org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

Parameters:

javaClass - not null

Returns:

a mojo descriptor

Throws:

org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any

execute

public List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute(PluginToolsRequest request)
                                                                throws ExtractionException,
org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

Description copied from interface: MojoDescriptorExtractor

Execute the mojo extraction.

Specified by:

execute in interface MojoDescriptorExtractor

Parameters:

request - The PluginToolsRequest containing information for the extraction process.

Returns:

a list of mojo descriptors. These may return HTML values for some fields.

Throws:

ExtractionException - if any

org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException - if any

discoverClasses

protected Collection<com.thoughtworks.qdox.model.JavaClass> discoverClasses(PluginToolsRequest request)

Parameters:

request - The plugin request.

Returns:

an array of java class

validate

protected void validate(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor)
                 throws org.apache.maven.plugin.descriptor.InvalidParameterException

Parameters:

mojoDescriptor - not null

Throws:

org.apache.maven.plugin.descriptor.InvalidParameterException - if any