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

Class JavaAnnotationsMojoDescriptorExtractor

java.lang.Object

org.apache.maven.tools.plugin.extractor.annotations.JavaAnnotationsMojoDescriptorExtractor

All Implemented Interfaces:

MojoDescriptorExtractor

@Named("java-annotations")
@Singleton
public class JavaAnnotationsMojoDescriptorExtractor
extends Object
implements MojoDescriptorExtractor

JavaMojoDescriptorExtractor, a MojoDescriptor extractor to read descriptors from java classes with annotations. Notice that source files are also parsed to get description, since and deprecation information.

Since:

3.0

Author:

Olivier Lamy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
JavaAnnotationsMojoDescriptorExtractor()

Method Summary

Modifier and Type	Method	Description
protected Map<String,com.thoughtworks.qdox.model.JavaClass>	discoverClasses(com.thoughtworks.qdox.JavaProjectBuilder builder)
List<org.apache.maven.plugin.descriptor.MojoDescriptor>	execute(PluginToolsRequest request)	Execute the mojo extraction.
protected void	extendJavaProjectBuilderWithSourcesJar(com.thoughtworks.qdox.JavaProjectBuilder builder, org.apache.maven.artifact.Artifact artifact, PluginToolsRequest request, String classifier)
protected MojoAnnotatedClass	findClassWithExecuteAnnotationInParentHierarchy(MojoAnnotatedClass mojoAnnotatedClass, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)
protected List<ComponentAnnotationContent>	getComponentParent(MojoAnnotatedClass mojoAnnotatedClass, List<ComponentAnnotationContent> componentAnnotationContents, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)
protected Map<String,ComponentAnnotationContent>	getComponentsParentHierarchy(MojoAnnotatedClass mojoAnnotatedClass, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)
protected org.apache.maven.project.MavenProject	getFromProjectReferences(org.apache.maven.artifact.Artifact artifact, org.apache.maven.project.MavenProject project)
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.
protected List<ParameterAnnotationContent>	getParametersParent(MojoAnnotatedClass mojoAnnotatedClass, List<ParameterAnnotationContent> parameterAnnotationContents, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)
protected Map<String,ParameterAnnotationContent>	getParametersParentHierarchy(MojoAnnotatedClass mojoAnnotatedClass, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)
boolean	isDeprecated()	Returns true if extractor is deprecated.
protected void	populateDataFromJavadoc(com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, Map<String,MojoAnnotatedClass> mojoAnnotatedClasses, Map<String,com.thoughtworks.qdox.model.JavaClass> javaClassesMap, JavadocLinkGenerator linkGenerator)	from sources scan to get @since and @deprecated and description of classes and fields.

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

JavaAnnotationsMojoDescriptorExtractor

public JavaAnnotationsMojoDescriptorExtractor()

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

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

populateDataFromJavadoc

protected void populateDataFromJavadoc(com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses,
 Map<String,com.thoughtworks.qdox.model.JavaClass> javaClassesMap,
 JavadocLinkGenerator linkGenerator)

from sources scan to get @since and @deprecated and description of classes and fields.

discoverClasses

protected Map<String,com.thoughtworks.qdox.model.JavaClass> discoverClasses(com.thoughtworks.qdox.JavaProjectBuilder builder)

extendJavaProjectBuilderWithSourcesJar

protected void extendJavaProjectBuilderWithSourcesJar(com.thoughtworks.qdox.JavaProjectBuilder builder,
 org.apache.maven.artifact.Artifact artifact,
 PluginToolsRequest request,
 String classifier)
                                               throws ExtractionException

Throws:

ExtractionException

findClassWithExecuteAnnotationInParentHierarchy

protected MojoAnnotatedClass findClassWithExecuteAnnotationInParentHierarchy(MojoAnnotatedClass mojoAnnotatedClass,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)

getParametersParentHierarchy

protected Map<String,ParameterAnnotationContent> getParametersParentHierarchy(MojoAnnotatedClass mojoAnnotatedClass,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)

getParametersParent

protected List<ParameterAnnotationContent> getParametersParent(MojoAnnotatedClass mojoAnnotatedClass,
 List<ParameterAnnotationContent> parameterAnnotationContents,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)

getComponentsParentHierarchy

protected Map<String,ComponentAnnotationContent> getComponentsParentHierarchy(MojoAnnotatedClass mojoAnnotatedClass,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)

getComponentParent

protected List<ComponentAnnotationContent> getComponentParent(MojoAnnotatedClass mojoAnnotatedClass,
 List<ComponentAnnotationContent> componentAnnotationContents,
 Map<String,MojoAnnotatedClass> mojoAnnotatedClasses)

getFromProjectReferences

protected org.apache.maven.project.MavenProject getFromProjectReferences(org.apache.maven.artifact.Artifact artifact,
 org.apache.maven.project.MavenProject project)