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

Class JavaJavadocMojoDescriptorExtractor

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

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

All Implemented Interfaces:

JavadocMojoAnnotation, org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor, org.codehaus.plexus.logging.LogEnabled

@Named("java-javadoc")
@Singleton
public class JavaJavadocMojoDescriptorExtractor
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements org.apache.maven.tools.plugin.extractor.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 java.lang.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 java.util.Collection<com.thoughtworks.qdox.model.JavaClass>	discoverClasses(org.apache.maven.tools.plugin.PluginToolsRequest request)
java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor>	execute(org.apache.maven.tools.plugin.PluginToolsRequest request)
org.apache.maven.tools.plugin.extractor.GroupKey	getGroupKey()
java.lang.String	getName()
boolean	isDeprecated()
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 org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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 Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

JavaJavadocMojoDescriptorExtractor

public JavaJavadocMojoDescriptorExtractor()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

getGroupKey

public org.apache.maven.tools.plugin.extractor.GroupKey getGroupKey()

Specified by:

getGroupKey in interface org.apache.maven.tools.plugin.extractor.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 java.util.List<org.apache.maven.plugin.descriptor.MojoDescriptor> execute(org.apache.maven.tools.plugin.PluginToolsRequest request)
                                                                          throws org.apache.maven.tools.plugin.extractor.ExtractionException,
                                                                                 org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

Specified by:

execute in interface org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor

Throws:

org.apache.maven.tools.plugin.extractor.ExtractionException

org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException

discoverClasses

protected java.util.Collection<com.thoughtworks.qdox.model.JavaClass> discoverClasses(org.apache.maven.tools.plugin.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