[MPLUGIN-285] changed 'java' extractor id to 'java-javadoc' to match 'java-annotations'

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1648268 13f79535-47bb-0310-9956-ffa450edef68
master
Herve Boutemy 2014-12-28 22:53:03 +00:00
parent d988e0b43c
commit b0fd53aaa7
26 changed files with 160 additions and 155 deletions

View File

@ -28,7 +28,8 @@
Maven Plugin Tool for Annotations
The Maven Plugin Tool for Annotations is the implementation of {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
The Maven Plugin Tool for Annotations is the <<<java-annotations>>> implementation of
{{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
to extract descriptors from plugins written in Java with
{{{../maven-plugin-annotations/index.html}Maven Plugin Tools Java 5 Annotations}}.

View File

@ -28,7 +28,8 @@
Maven Plugin Tool for Ant
The Maven Plugin Tool for Ant is the implementation of {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} to
The Maven Plugin Tool for Ant is the <<<ant>>> implementation of
{{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}} to
extract descriptors for plugins written in Ant.
An Ant Maven Plugin has to be written in a file ending in <<<.build.xml>>> in <<<src/main/scripts>>>,

View File

@ -28,5 +28,6 @@
Maven Plugin Tool for Beanshell
The Maven Plugin Tool for Beanshell is the Beanshell impl of {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
The Maven Plugin Tool for Beanshell is the <<<bsh>>> implementation of
{{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
to extract descriptors for plugins written in Beanshell.

View File

@ -59,97 +59,98 @@ import java.util.TreeMap;
* @version $Id$
* @see org.apache.maven.plugin.descriptor.MojoDescriptor
*/
@Component( role = MojoDescriptorExtractor.class, hint = "java" )
public class JavaMojoDescriptorExtractor
@Component( role = MojoDescriptorExtractor.class, hint = "java-javadoc" )
public class JavaJavadocMojoDescriptorExtractor
extends AbstractLogEnabled
implements MojoDescriptorExtractor, JavaMojoAnnotation
implements MojoDescriptorExtractor, JavadocMojoAnnotation
{
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#INSTANTIATION_STRATEGY} instead of. */
public static final String MAVEN_PLUGIN_INSTANTIATION = JavaMojoAnnotation.INSTANTIATION_STRATEGY;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#INSTANTIATION_STRATEGY} instead of. */
public static final String MAVEN_PLUGIN_INSTANTIATION = JavadocMojoAnnotation.INSTANTIATION_STRATEGY;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#CONFIGURATOR} instead of. */
public static final String CONFIGURATOR = JavaMojoAnnotation.CONFIGURATOR;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#CONFIGURATOR} instead of. */
public static final String CONFIGURATOR = JavadocMojoAnnotation.CONFIGURATOR;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#PARAMETER} instead of. */
public static final String PARAMETER = JavaMojoAnnotation.PARAMETER;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER} instead of. */
public static final String PARAMETER = JavadocMojoAnnotation.PARAMETER;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#PARAMETER_EXPRESSION} instead of. */
public static final String PARAMETER_EXPRESSION = JavaMojoAnnotation.PARAMETER_EXPRESSION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_EXPRESSION} instead of. */
public static final String PARAMETER_EXPRESSION = JavadocMojoAnnotation.PARAMETER_EXPRESSION;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#PARAMETER_DEFAULT_VALUE} instead of. */
public static final String PARAMETER_DEFAULT_VALUE = JavaMojoAnnotation.PARAMETER_DEFAULT_VALUE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_DEFAULT_VALUE} instead of. */
public static final String PARAMETER_DEFAULT_VALUE = JavadocMojoAnnotation.PARAMETER_DEFAULT_VALUE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#PARAMETER_ALIAS} instead of. */
public static final String PARAMETER_ALIAS = JavaMojoAnnotation.PARAMETER_ALIAS;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_ALIAS} instead of. */
public static final String PARAMETER_ALIAS = JavadocMojoAnnotation.PARAMETER_ALIAS;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#SINCE} instead of. */
public static final String SINCE = JavaMojoAnnotation.SINCE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#SINCE} instead of. */
public static final String SINCE = JavadocMojoAnnotation.SINCE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#PARAMETER_IMPLEMENTATION} instead of. */
public static final String PARAMETER_IMPLEMENTATION = JavaMojoAnnotation.PARAMETER_IMPLEMENTATION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PARAMETER_IMPLEMENTATION} instead of. */
public static final String PARAMETER_IMPLEMENTATION = JavadocMojoAnnotation.PARAMETER_IMPLEMENTATION;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#REQUIRED} instead of. */
public static final String REQUIRED = JavaMojoAnnotation.REQUIRED;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRED} instead of. */
public static final String REQUIRED = JavadocMojoAnnotation.REQUIRED;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#DEPRECATED} instead of. */
public static final String DEPRECATED = JavaMojoAnnotation.DEPRECATED;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#DEPRECATED} instead of. */
public static final String DEPRECATED = JavadocMojoAnnotation.DEPRECATED;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#READONLY} instead of. */
public static final String READONLY = JavaMojoAnnotation.READONLY;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#READONLY} instead of. */
public static final String READONLY = JavadocMojoAnnotation.READONLY;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#GOAL} instead of. */
public static final String GOAL = JavaMojoAnnotation.GOAL;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#GOAL} instead of. */
public static final String GOAL = JavadocMojoAnnotation.GOAL;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#PHASE} instead of. */
public static final String PHASE = JavaMojoAnnotation.PHASE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#PHASE} instead of. */
public static final String PHASE = JavadocMojoAnnotation.PHASE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#EXECUTE} instead of. */
public static final String EXECUTE = JavaMojoAnnotation.EXECUTE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE} instead of. */
public static final String EXECUTE = JavadocMojoAnnotation.EXECUTE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#EXECUTE_LIFECYCLE} instead of. */
public static final String EXECUTE_LIFECYCLE = JavaMojoAnnotation.EXECUTE_LIFECYCLE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE_LIFECYCLE} instead of. */
public static final String EXECUTE_LIFECYCLE = JavadocMojoAnnotation.EXECUTE_LIFECYCLE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#EXECUTE_PHASE} instead of. */
public static final String EXECUTE_PHASE = JavaMojoAnnotation.EXECUTE_PHASE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE_PHASE} instead of. */
public static final String EXECUTE_PHASE = JavadocMojoAnnotation.EXECUTE_PHASE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#EXECUTE_GOAL} instead of. */
public static final String EXECUTE_GOAL = JavaMojoAnnotation.EXECUTE_GOAL;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#EXECUTE_GOAL} instead of. */
public static final String EXECUTE_GOAL = JavadocMojoAnnotation.EXECUTE_GOAL;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#DESCRIPTION} instead of. */
public static final String GOAL_DESCRIPTION = JavaMojoAnnotation.DESCRIPTION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#DESCRIPTION} instead of. */
public static final String GOAL_DESCRIPTION = JavadocMojoAnnotation.DESCRIPTION;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#REQUIRES_DEPENDENCY_RESOLUTION} instead of. */
public static final String GOAL_REQUIRES_DEPENDENCY_RESOLUTION = JavaMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_DEPENDENCY_RESOLUTION} instead of. */
public static final String GOAL_REQUIRES_DEPENDENCY_RESOLUTION =
JavadocMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#REQUIRES_PROJECT} instead of. */
public static final String GOAL_REQUIRES_PROJECT = JavaMojoAnnotation.REQUIRES_PROJECT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_PROJECT} instead of. */
public static final String GOAL_REQUIRES_PROJECT = JavadocMojoAnnotation.REQUIRES_PROJECT;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#REQUIRES_REPORTS} instead of. */
public static final String GOAL_REQUIRES_REPORTS = JavaMojoAnnotation.REQUIRES_REPORTS;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_REPORTS} instead of. */
public static final String GOAL_REQUIRES_REPORTS = JavadocMojoAnnotation.REQUIRES_REPORTS;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#AGGREGATOR} instead of. */
public static final String GOAL_IS_AGGREGATOR = JavaMojoAnnotation.AGGREGATOR;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#AGGREGATOR} instead of. */
public static final String GOAL_IS_AGGREGATOR = JavadocMojoAnnotation.AGGREGATOR;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#REQUIRES_ONLINE} instead of. */
public static final String GOAL_REQUIRES_ONLINE = JavaMojoAnnotation.REQUIRES_ONLINE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_ONLINE} instead of. */
public static final String GOAL_REQUIRES_ONLINE = JavadocMojoAnnotation.REQUIRES_ONLINE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#INHERIT_BY_DEFAULT} instead of. */
public static final String GOAL_INHERIT_BY_DEFAULT = JavaMojoAnnotation.INHERIT_BY_DEFAULT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#INHERIT_BY_DEFAULT} instead of. */
public static final String GOAL_INHERIT_BY_DEFAULT = JavadocMojoAnnotation.INHERIT_BY_DEFAULT;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#MULTI_EXECUTION_STRATEGY} instead of. */
public static final String GOAL_MULTI_EXECUTION_STRATEGY = JavaMojoAnnotation.MULTI_EXECUTION_STRATEGY;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#MULTI_EXECUTION_STRATEGY} instead of. */
public static final String GOAL_MULTI_EXECUTION_STRATEGY = JavadocMojoAnnotation.MULTI_EXECUTION_STRATEGY;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#REQUIRES_DIRECT_INVOCATION} instead of. */
public static final String GOAL_REQUIRES_DIRECT_INVOCATION = JavaMojoAnnotation.REQUIRES_DIRECT_INVOCATION;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#REQUIRES_DIRECT_INVOCATION} instead of. */
public static final String GOAL_REQUIRES_DIRECT_INVOCATION = JavadocMojoAnnotation.REQUIRES_DIRECT_INVOCATION;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#COMPONENT} instead of. */
public static final String COMPONENT = JavaMojoAnnotation.COMPONENT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#COMPONENT} instead of. */
public static final String COMPONENT = JavadocMojoAnnotation.COMPONENT;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#COMPONENT_ROLE} instead of. */
public static final String COMPONENT_ROLE = JavaMojoAnnotation.COMPONENT_ROLE;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#COMPONENT_ROLE} instead of. */
public static final String COMPONENT_ROLE = JavadocMojoAnnotation.COMPONENT_ROLE;
/** @deprecated since 2.4, use {@link JavaMojoAnnotation#COMPONENT_ROLEHINT} instead of. */
public static final String COMPONENT_ROLEHINT = JavaMojoAnnotation.COMPONENT_ROLEHINT;
/** @deprecated since 2.4, use {@link JavadocMojoAnnotation#COMPONENT_ROLEHINT} instead of. */
public static final String COMPONENT_ROLEHINT = JavadocMojoAnnotation.COMPONENT_ROLEHINT;
/**
* @param parameter not null
@ -206,25 +207,25 @@ public class JavaMojoDescriptorExtractor
// ----------------------------------------------------------------------
// Aggregator flag
DocletTag aggregator = findInClassHierarchy( javaClass, JavaMojoAnnotation.AGGREGATOR );
DocletTag aggregator = findInClassHierarchy( javaClass, JavadocMojoAnnotation.AGGREGATOR );
if ( aggregator != null )
{
mojoDescriptor.setAggregator( true );
}
// Configurator hint
DocletTag configurator = findInClassHierarchy( javaClass, JavaMojoAnnotation.CONFIGURATOR );
DocletTag configurator = findInClassHierarchy( javaClass, JavadocMojoAnnotation.CONFIGURATOR );
if ( configurator != null )
{
mojoDescriptor.setComponentConfigurator( configurator.getValue() );
}
// Additional phase to execute first
DocletTag execute = findInClassHierarchy( javaClass, JavaMojoAnnotation.EXECUTE );
DocletTag execute = findInClassHierarchy( javaClass, JavadocMojoAnnotation.EXECUTE );
if ( execute != null )
{
String executePhase = execute.getNamedParameter( JavaMojoAnnotation.EXECUTE_PHASE );
String executeGoal = execute.getNamedParameter( JavaMojoAnnotation.EXECUTE_GOAL );
String executePhase = execute.getNamedParameter( JavadocMojoAnnotation.EXECUTE_PHASE );
String executeGoal = execute.getNamedParameter( JavadocMojoAnnotation.EXECUTE_GOAL );
if ( executePhase == null && executeGoal == null )
{
@ -239,7 +240,7 @@ public class JavaMojoDescriptorExtractor
mojoDescriptor.setExecutePhase( executePhase );
mojoDescriptor.setExecuteGoal( executeGoal );
String lifecycle = execute.getNamedParameter( JavaMojoAnnotation.EXECUTE_LIFECYCLE );
String lifecycle = execute.getNamedParameter( JavadocMojoAnnotation.EXECUTE_LIFECYCLE );
if ( lifecycle != null )
{
mojoDescriptor.setExecuteLifecycle( lifecycle );
@ -252,7 +253,7 @@ public class JavaMojoDescriptorExtractor
}
// Goal name
DocletTag goal = findInClassHierarchy( javaClass, JavaMojoAnnotation.GOAL );
DocletTag goal = findInClassHierarchy( javaClass, JavadocMojoAnnotation.GOAL );
if ( goal != null )
{
mojoDescriptor.setGoal( goal.getValue() );
@ -260,38 +261,38 @@ public class JavaMojoDescriptorExtractor
// inheritByDefault flag
boolean value =
getBooleanTagValue( javaClass, JavaMojoAnnotation.INHERIT_BY_DEFAULT,
getBooleanTagValue( javaClass, JavadocMojoAnnotation.INHERIT_BY_DEFAULT,
mojoDescriptor.isInheritedByDefault() );
mojoDescriptor.setInheritedByDefault( value );
// instantiationStrategy
DocletTag tag = findInClassHierarchy( javaClass, JavaMojoAnnotation.INSTANTIATION_STRATEGY );
DocletTag tag = findInClassHierarchy( javaClass, JavadocMojoAnnotation.INSTANTIATION_STRATEGY );
if ( tag != null )
{
mojoDescriptor.setInstantiationStrategy( tag.getValue() );
}
// executionStrategy (and deprecated @attainAlways)
tag = findInClassHierarchy( javaClass, JavaMojoAnnotation.MULTI_EXECUTION_STRATEGY );
tag = findInClassHierarchy( javaClass, JavadocMojoAnnotation.MULTI_EXECUTION_STRATEGY );
if ( tag != null )
{
getLogger().warn( "@" + JavaMojoAnnotation.MULTI_EXECUTION_STRATEGY + " in "
getLogger().warn( "@" + JavadocMojoAnnotation.MULTI_EXECUTION_STRATEGY + " in "
+ javaClass.getFullyQualifiedName() + " is deprecated: please use '@"
+ JavaMojoAnnotation.EXECUTION_STATEGY + " always' instead." );
+ JavadocMojoAnnotation.EXECUTION_STATEGY + " always' instead." );
mojoDescriptor.setExecutionStrategy( MojoDescriptor.MULTI_PASS_EXEC_STRATEGY );
}
else
{
mojoDescriptor.setExecutionStrategy( MojoDescriptor.SINGLE_PASS_EXEC_STRATEGY );
}
tag = findInClassHierarchy( javaClass, JavaMojoAnnotation.EXECUTION_STATEGY );
tag = findInClassHierarchy( javaClass, JavadocMojoAnnotation.EXECUTION_STATEGY );
if ( tag != null )
{
mojoDescriptor.setExecutionStrategy( tag.getValue() );
}
// Phase name
DocletTag phase = findInClassHierarchy( javaClass, JavaMojoAnnotation.PHASE );
DocletTag phase = findInClassHierarchy( javaClass, JavadocMojoAnnotation.PHASE );
if ( phase != null )
{
mojoDescriptor.setPhase( phase.getValue() );
@ -299,7 +300,7 @@ public class JavaMojoDescriptorExtractor
// Dependency resolution flag
DocletTag requiresDependencyResolution =
findInClassHierarchy( javaClass, JavaMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION );
findInClassHierarchy( javaClass, JavadocMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION );
if ( requiresDependencyResolution != null )
{
String v = requiresDependencyResolution.getValue();
@ -314,7 +315,7 @@ public class JavaMojoDescriptorExtractor
// Dependency collection flag
DocletTag requiresDependencyCollection =
findInClassHierarchy( javaClass, JavaMojoAnnotation.REQUIRES_DEPENDENCY_COLLECTION );
findInClassHierarchy( javaClass, JavadocMojoAnnotation.REQUIRES_DEPENDENCY_COLLECTION );
if ( requiresDependencyCollection != null )
{
String v = requiresDependencyCollection.getValue();
@ -329,23 +330,23 @@ public class JavaMojoDescriptorExtractor
// requiresDirectInvocation flag
value =
getBooleanTagValue( javaClass, JavaMojoAnnotation.REQUIRES_DIRECT_INVOCATION,
getBooleanTagValue( javaClass, JavadocMojoAnnotation.REQUIRES_DIRECT_INVOCATION,
mojoDescriptor.isDirectInvocationOnly() );
mojoDescriptor.setDirectInvocationOnly( value );
// Online flag
value =
getBooleanTagValue( javaClass, JavaMojoAnnotation.REQUIRES_ONLINE, mojoDescriptor.isOnlineRequired() );
getBooleanTagValue( javaClass, JavadocMojoAnnotation.REQUIRES_ONLINE, mojoDescriptor.isOnlineRequired() );
mojoDescriptor.setOnlineRequired( value );
// Project flag
value =
getBooleanTagValue( javaClass, JavaMojoAnnotation.REQUIRES_PROJECT, mojoDescriptor.isProjectRequired() );
getBooleanTagValue( javaClass, JavadocMojoAnnotation.REQUIRES_PROJECT, mojoDescriptor.isProjectRequired() );
mojoDescriptor.setProjectRequired( value );
// requiresReports flag
value =
getBooleanTagValue( javaClass, JavaMojoAnnotation.REQUIRES_REPORTS, mojoDescriptor.isRequiresReports() );
getBooleanTagValue( javaClass, JavadocMojoAnnotation.REQUIRES_REPORTS, mojoDescriptor.isRequiresReports() );
mojoDescriptor.setRequiresReports( value );
// ----------------------------------------------------------------------
@ -353,14 +354,14 @@ public class JavaMojoDescriptorExtractor
// ----------------------------------------------------------------------
// Deprecation hint
DocletTag deprecated = javaClass.getTagByName( JavaMojoAnnotation.DEPRECATED );
DocletTag deprecated = javaClass.getTagByName( JavadocMojoAnnotation.DEPRECATED );
if ( deprecated != null )
{
mojoDescriptor.setDeprecated( deprecated.getValue() );
}
// What version it was introduced in
DocletTag since = findInClassHierarchy( javaClass, JavaMojoAnnotation.SINCE );
DocletTag since = findInClassHierarchy( javaClass, JavadocMojoAnnotation.SINCE );
if ( since != null )
{
mojoDescriptor.setSince( since.getValue() );
@ -368,7 +369,7 @@ public class JavaMojoDescriptorExtractor
// Thread-safe mojo
value = getBooleanTagValue( javaClass, JavaMojoAnnotation.THREAD_SAFE, true, mojoDescriptor.isThreadSafe() );
value = getBooleanTagValue( javaClass, JavadocMojoAnnotation.THREAD_SAFE, true, mojoDescriptor.isThreadSafe() );
mojoDescriptor.setThreadSafe( value );
extractParameters( mojoDescriptor, javaClass );
@ -494,32 +495,32 @@ public class JavaMojoDescriptorExtractor
pd.setDescription( field.getComment() );
DocletTag deprecationTag = field.getTagByName( JavaMojoAnnotation.DEPRECATED );
DocletTag deprecationTag = field.getTagByName( JavadocMojoAnnotation.DEPRECATED );
if ( deprecationTag != null )
{
pd.setDeprecated( deprecationTag.getValue() );
}
DocletTag sinceTag = field.getTagByName( JavaMojoAnnotation.SINCE );
DocletTag sinceTag = field.getTagByName( JavadocMojoAnnotation.SINCE );
if ( sinceTag != null )
{
pd.setSince( sinceTag.getValue() );
}
DocletTag componentTag = field.getTagByName( JavaMojoAnnotation.COMPONENT );
DocletTag componentTag = field.getTagByName( JavadocMojoAnnotation.COMPONENT );
if ( componentTag != null )
{
// Component tag
String role = componentTag.getNamedParameter( JavaMojoAnnotation.COMPONENT_ROLE );
String role = componentTag.getNamedParameter( JavadocMojoAnnotation.COMPONENT_ROLE );
if ( role == null )
{
role = field.getType().toString();
}
String roleHint = componentTag.getNamedParameter( JavaMojoAnnotation.COMPONENT_ROLEHINT );
String roleHint = componentTag.getNamedParameter( JavadocMojoAnnotation.COMPONENT_ROLEHINT );
if ( roleHint == null )
{
@ -556,28 +557,28 @@ public class JavaMojoDescriptorExtractor
else
{
// Parameter tag
DocletTag parameter = field.getTagByName( JavaMojoAnnotation.PARAMETER );
DocletTag parameter = field.getTagByName( JavadocMojoAnnotation.PARAMETER );
pd.setRequired( field.getTagByName( JavaMojoAnnotation.REQUIRED ) != null );
pd.setRequired( field.getTagByName( JavadocMojoAnnotation.REQUIRED ) != null );
pd.setEditable( field.getTagByName( JavaMojoAnnotation.READONLY ) == null );
pd.setEditable( field.getTagByName( JavadocMojoAnnotation.READONLY ) == null );
String name = parameter.getNamedParameter( JavaMojoAnnotation.PARAMETER_NAME );
String name = parameter.getNamedParameter( JavadocMojoAnnotation.PARAMETER_NAME );
if ( !StringUtils.isEmpty( name ) )
{
pd.setName( name );
}
String alias = parameter.getNamedParameter( JavaMojoAnnotation.PARAMETER_ALIAS );
String alias = parameter.getNamedParameter( JavadocMojoAnnotation.PARAMETER_ALIAS );
if ( !StringUtils.isEmpty( alias ) )
{
pd.setAlias( alias );
}
String expression = parameter.getNamedParameter( JavaMojoAnnotation.PARAMETER_EXPRESSION );
String property = parameter.getNamedParameter( JavaMojoAnnotation.PARAMETER_PROPERTY );
String expression = parameter.getNamedParameter( JavadocMojoAnnotation.PARAMETER_EXPRESSION );
String property = parameter.getNamedParameter( JavadocMojoAnnotation.PARAMETER_PROPERTY );
if ( StringUtils.isNotEmpty( expression ) && StringUtils.isNotEmpty( property ) )
{
@ -623,9 +624,9 @@ public class JavaMojoDescriptorExtractor
mojoDescriptor.setRequiresReports( true );
}
pd.setDefaultValue( parameter.getNamedParameter( JavaMojoAnnotation.PARAMETER_DEFAULT_VALUE ) );
pd.setDefaultValue( parameter.getNamedParameter( JavadocMojoAnnotation.PARAMETER_DEFAULT_VALUE ) );
pd.setImplementation( parameter.getNamedParameter( JavaMojoAnnotation.PARAMETER_IMPLEMENTATION ) );
pd.setImplementation( parameter.getNamedParameter( JavadocMojoAnnotation.PARAMETER_IMPLEMENTATION ) );
}
mojoDescriptor.addParameter( pd );
@ -661,8 +662,8 @@ public class JavaMojoDescriptorExtractor
{
for ( JavaField field : classFields )
{
if ( field.getTagByName( JavaMojoAnnotation.PARAMETER ) != null
|| field.getTagByName( JavaMojoAnnotation.COMPONENT ) != null )
if ( field.getTagByName( JavadocMojoAnnotation.PARAMETER ) != null
|| field.getTagByName( JavadocMojoAnnotation.COMPONENT ) != null )
{
rawParams.put( field.getName(), field );
}

View File

@ -27,7 +27,7 @@ package org.apache.maven.tools.plugin.extractor.java;
* @since 2.4
*/
@SuppressWarnings( "checkstyle:interfaceistype" )
public interface JavaMojoAnnotation
public interface JavadocMojoAnnotation
{
// ----------------------------------------------------------------------
// Descriptor for type i.e. Mojo

View File

@ -29,7 +29,8 @@
Maven Plugin Tool for Java Annotated with Mojo Javadoc Tags
The Maven Plugin Tool for Java is the Java impl of {{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
The Maven Plugin Tool for Java is the <<<java-javadoc>>> implementation of
{{{../maven-plugin-tools-api/index.html}maven-plugin-tools-api}}
to extract descriptors for plugins written in Java annotated with Mojo Javadoc Tags.
* Supported Mojo Javadoc Tags

View File

@ -105,7 +105,7 @@ public class JavaMojoDescriptorExtractorTest
protected PluginDescriptor generate( String directory )
throws Exception
{
JavaMojoDescriptorExtractor extractor = new JavaMojoDescriptorExtractor();
JavaJavadocMojoDescriptorExtractor extractor = new JavaJavadocMojoDescriptorExtractor();
extractor.enableLogging( new ConsoleLogger( Logger.LEVEL_INFO, "test" ) );
PluginToolsRequest request = createRequest( directory );

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoAggregatorTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.AGGREGATOR;
private static final String NAME = JavadocMojoAnnotation.AGGREGATOR;
/** The Javadoc text which will be added to the generated page */
protected static final String HEADER = "Aggregates the Maven project and its child modules.";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -55,11 +55,11 @@ public class MojoComponentFieldTaglet
extends AbstractMojoFieldTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.COMPONENT;
private static final String NAME = JavadocMojoAnnotation.COMPONENT;
private static final String[] COMPONENTS_NAME = {
JavaMojoAnnotation.COMPONENT_ROLE,
JavaMojoAnnotation.COMPONENT_ROLEHINT };
JavadocMojoAnnotation.COMPONENT_ROLE,
JavadocMojoAnnotation.COMPONENT_ROLEHINT };
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is a Plexus component defined by";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -56,7 +56,7 @@ public class MojoConfiguratorTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.CONFIGURATOR;
private static final String NAME = JavadocMojoAnnotation.CONFIGURATOR;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is configured to the role hint";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -56,12 +56,12 @@ public class MojoExecuteTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.EXECUTE;
private static final String NAME = JavadocMojoAnnotation.EXECUTE;
private static final String[] PARAMETERS_NAME = {
JavaMojoAnnotation.EXECUTE_PHASE,
JavaMojoAnnotation.EXECUTE_LIFECYCLE,
JavaMojoAnnotation.EXECUTE_GOAL };
JavadocMojoAnnotation.EXECUTE_PHASE,
JavadocMojoAnnotation.EXECUTE_LIFECYCLE,
JavadocMojoAnnotation.EXECUTE_GOAL };
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is defined to be executed in";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -56,7 +56,7 @@ public class MojoExecutionStrategyTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.EXECUTION_STATEGY;
private static final String NAME = JavadocMojoAnnotation.EXECUTION_STATEGY;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is executed with the strategy";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -56,7 +56,7 @@ public class MojoGoalTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.GOAL;
private static final String NAME = JavadocMojoAnnotation.GOAL;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is defined by the goal name";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoInheritByDefaultTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.INHERIT_BY_DEFAULT;
private static final String NAME = JavadocMojoAnnotation.INHERIT_BY_DEFAULT;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is this Mojo inherited";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -56,7 +56,7 @@ public class MojoInstantiationStrategyTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.INSTANTIATION_STRATEGY;
private static final String NAME = JavadocMojoAnnotation.INSTANTIATION_STRATEGY;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is instantiated with the strategy";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -58,15 +58,15 @@ public class MojoParameterFieldTaglet
extends AbstractMojoFieldTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.PARAMETER;
private static final String NAME = JavadocMojoAnnotation.PARAMETER;
private static final String[] PARAMETERS_NAME = {
JavaMojoAnnotation.PARAMETER_NAME,
JavaMojoAnnotation.PARAMETER_ALIAS,
JavaMojoAnnotation.PARAMETER_DEFAULT_VALUE,
JavaMojoAnnotation.PARAMETER_EXPRESSION,
JavaMojoAnnotation.PARAMETER_IMPLEMENTATION,
JavaMojoAnnotation.PARAMETER_PROPERTY };
JavadocMojoAnnotation.PARAMETER_NAME,
JavadocMojoAnnotation.PARAMETER_ALIAS,
JavadocMojoAnnotation.PARAMETER_DEFAULT_VALUE,
JavadocMojoAnnotation.PARAMETER_EXPRESSION,
JavadocMojoAnnotation.PARAMETER_IMPLEMENTATION,
JavadocMojoAnnotation.PARAMETER_PROPERTY };
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is defined by";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -56,7 +56,7 @@ public class MojoPhaseTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.PHASE;
private static final String NAME = JavadocMojoAnnotation.PHASE;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is bound to the specified phase of the standard build lifecycle";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -60,7 +60,7 @@ public class MojoReadOnlyFieldTaglet
extends AbstractMojoFieldTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.READONLY;
private static final String NAME = JavadocMojoAnnotation.READONLY;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is readonly.";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -60,7 +60,7 @@ public class MojoRequiredFieldTaglet
extends AbstractMojoFieldTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRED;
private static final String NAME = JavadocMojoAnnotation.REQUIRED;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Is required.";

View File

@ -20,7 +20,7 @@ package org.apache.maven.tools.plugin.javadoc;
*/
import com.sun.tools.doclets.Taglet;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import java.util.Map;
@ -58,7 +58,7 @@ public class MojoRequiresDependencyCollectionTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRES_DEPENDENCY_COLLECTION;
private static final String NAME = JavadocMojoAnnotation.REQUIRES_DEPENDENCY_COLLECTION;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Collects the dependencies in this specified scope";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoRequiresDependencyResolutionTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION;
private static final String NAME = JavadocMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Requires the dependencies in this specified scope";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoRequiresDirectInvocationTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRES_DIRECT_INVOCATION;
private static final String NAME = JavadocMojoAnnotation.REQUIRES_DIRECT_INVOCATION;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Requires a direct invocation by the user";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoRequiresOnLineTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRES_ONLINE;
private static final String NAME = JavadocMojoAnnotation.REQUIRES_ONLINE;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Requires to be online to run";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoRequiresProjectTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRES_PROJECT;
private static final String NAME = JavadocMojoAnnotation.REQUIRES_PROJECT;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Requires a Maven project to run";

View File

@ -21,7 +21,7 @@ package org.apache.maven.tools.plugin.javadoc;
import java.util.Map;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import com.sun.tools.doclets.Taglet;
@ -57,7 +57,7 @@ public class MojoRequiresReportsTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.REQUIRES_REPORTS;
private static final String NAME = JavadocMojoAnnotation.REQUIRES_REPORTS;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Requires Maven reports to run";

View File

@ -20,7 +20,7 @@ package org.apache.maven.tools.plugin.javadoc;
*/
import com.sun.tools.doclets.Taglet;
import org.apache.maven.tools.plugin.extractor.java.JavaMojoAnnotation;
import org.apache.maven.tools.plugin.extractor.java.JavadocMojoAnnotation;
import java.util.Map;
@ -55,7 +55,7 @@ public class MojoThreadSafeTypeTaglet
extends AbstractMojoTypeTaglet
{
/** The Javadoc annotation */
private static final String NAME = JavaMojoAnnotation.THREAD_SAFE;
private static final String NAME = JavadocMojoAnnotation.THREAD_SAFE;
/** The Javadoc text which will be added to the generated page. */
protected static final String HEADER = "Mojo is thread safe";