Package org.codehaus.plexus.metadata.gleaner

Class QDoxComponentGleaner

java.lang.Object

org.codehaus.plexus.metadata.gleaner.ComponentGleanerSupport

org.codehaus.plexus.metadata.gleaner.QDoxComponentGleaner

All Implemented Interfaces:

SourceComponentGleaner

public class QDoxComponentGleaner
extends ComponentGleanerSupport
implements SourceComponentGleaner

A source component gleaner which uses QDox to discover Javadoc annotations.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.List<java.lang.String>	IGNORED_INTERFACES
static java.lang.String	PLEXUS_ALIAS_PARAMETER
static java.lang.String	PLEXUS_COMPONENT_TAG
static java.lang.String	PLEXUS_CONFIGURATION_TAG
static java.lang.String	PLEXUS_DEFAULT_HINT
static java.lang.String	PLEXUS_DEFAULT_VALUE_PARAMETER
static java.lang.String	PLEXUS_INSTANTIATION_STARTEGY_PARAMETER
static java.lang.String	PLEXUS_LIFECYCLE_HANDLER_PARAMETER
static java.lang.String	PLEXUS_OPTIONAL_PARAMETER
static java.lang.String	PLEXUS_REQUIREMENT_TAG
static java.lang.String	PLEXUS_ROLE_HINT_LIST_PARAMETER
static java.lang.String	PLEXUS_ROLE_HINT_PARAMETER
static java.lang.String	PLEXUS_ROLE_PARAMETER
static java.lang.String	PLEXUS_VERSION_PARAMETER

Fields inherited from interface org.codehaus.plexus.metadata.gleaner.SourceComponentGleaner

ROLE

Constructor Summary

Constructors

Constructor	Description
QDoxComponentGleaner()

Method Summary

Modifier and Type	Method	Description
private void	findConfiguration(org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration configuration, com.thoughtworks.qdox.model.JavaClass javaClass)
private void	findExtraParameters(java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> parameters)
private void	findRequirements(com.thoughtworks.qdox.JavaProjectBuilder classCache, org.codehaus.plexus.component.repository.ComponentDescriptor<?> componentDescriptor, com.thoughtworks.qdox.model.JavaClass javaClass)
private java.lang.String	findRole(com.thoughtworks.qdox.model.JavaClass javaClass)
private static java.lang.String	getPackage(com.thoughtworks.qdox.model.JavaClass javaClass)
private java.lang.String	getParameter(java.util.Map<java.lang.String,java.lang.String> parameters, java.lang.String parameter)
org.codehaus.plexus.component.repository.ComponentDescriptor<?>	glean(com.thoughtworks.qdox.JavaProjectBuilder classCache, com.thoughtworks.qdox.model.JavaClass javaClass)

Methods inherited from class org.codehaus.plexus.metadata.gleaner.ComponentGleanerSupport

addChildConfiguration, deHump, filterEmptyAsNull, isRequirementListType

Methods inherited from class java.lang.Object

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

Field Detail

PLEXUS_COMPONENT_TAG

public static final java.lang.String PLEXUS_COMPONENT_TAG

See Also:

Constant Field Values

PLEXUS_REQUIREMENT_TAG

public static final java.lang.String PLEXUS_REQUIREMENT_TAG

See Also:

Constant Field Values

PLEXUS_CONFIGURATION_TAG

public static final java.lang.String PLEXUS_CONFIGURATION_TAG

See Also:

Constant Field Values

PLEXUS_VERSION_PARAMETER

public static final java.lang.String PLEXUS_VERSION_PARAMETER

See Also:

Constant Field Values

PLEXUS_ROLE_PARAMETER

public static final java.lang.String PLEXUS_ROLE_PARAMETER

See Also:

Constant Field Values

PLEXUS_ROLE_HINT_PARAMETER

public static final java.lang.String PLEXUS_ROLE_HINT_PARAMETER

See Also:

Constant Field Values

PLEXUS_ROLE_HINT_LIST_PARAMETER

public static final java.lang.String PLEXUS_ROLE_HINT_LIST_PARAMETER

See Also:

Constant Field Values

PLEXUS_ALIAS_PARAMETER

public static final java.lang.String PLEXUS_ALIAS_PARAMETER

See Also:

Constant Field Values

PLEXUS_DEFAULT_VALUE_PARAMETER

public static final java.lang.String PLEXUS_DEFAULT_VALUE_PARAMETER

See Also:

Constant Field Values

PLEXUS_LIFECYCLE_HANDLER_PARAMETER

public static final java.lang.String PLEXUS_LIFECYCLE_HANDLER_PARAMETER

See Also:

Constant Field Values

PLEXUS_INSTANTIATION_STARTEGY_PARAMETER

public static final java.lang.String PLEXUS_INSTANTIATION_STARTEGY_PARAMETER

See Also:

Constant Field Values

PLEXUS_OPTIONAL_PARAMETER

public static final java.lang.String PLEXUS_OPTIONAL_PARAMETER

See Also:

Constant Field Values

PLEXUS_DEFAULT_HINT

public static final java.lang.String PLEXUS_DEFAULT_HINT

See Also:

Constant Field Values

IGNORED_INTERFACES

private static final java.util.List<java.lang.String> IGNORED_INTERFACES

Constructor Detail

QDoxComponentGleaner

public QDoxComponentGleaner()

Method Detail

glean

public org.codehaus.plexus.component.repository.ComponentDescriptor<?> glean(com.thoughtworks.qdox.JavaProjectBuilder classCache,
                                                                             com.thoughtworks.qdox.model.JavaClass javaClass)
                                                                      throws ComponentGleanerException

Specified by:

glean in interface SourceComponentGleaner

Throws:

ComponentGleanerException

getPackage

private static java.lang.String getPackage(com.thoughtworks.qdox.model.JavaClass javaClass)

findRole

private java.lang.String findRole(com.thoughtworks.qdox.model.JavaClass javaClass)

findRequirements

private void findRequirements(com.thoughtworks.qdox.JavaProjectBuilder classCache,
                              org.codehaus.plexus.component.repository.ComponentDescriptor<?> componentDescriptor,
                              com.thoughtworks.qdox.model.JavaClass javaClass)

findConfiguration

private void findConfiguration(org.codehaus.plexus.configuration.xml.XmlPlexusConfiguration configuration,
                               com.thoughtworks.qdox.model.JavaClass javaClass)
                        throws ComponentGleanerException

Throws:

ComponentGleanerException

findExtraParameters

private void findExtraParameters(java.lang.String tagName,
                                 java.util.Map<java.lang.String,java.lang.String> parameters)

getParameter

private java.lang.String getParameter(java.util.Map<java.lang.String,java.lang.String> parameters,
                                      java.lang.String parameter)