diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java index 8c90d8d..9be8364 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java @@ -38,11 +38,13 @@ import java.util.TreeMap; /** * @author jdcasey + * @version $Id$ */ public abstract class AbstractScriptedMojoDescriptorExtractor extends AbstractLogEnabled implements MojoDescriptorExtractor { + /** {@inheritDoc} */ public List execute( MavenProject project, PluginDescriptor pluginDescriptor ) throws ExtractionException, InvalidPluginDescriptorException { diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java index 260bd94..783531f 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java @@ -19,18 +19,32 @@ package org.apache.maven.tools.plugin.extractor; * under the License. */ +/** + * Wrap errors when extraction exception occurred. + * + * @author Vincent Siveton + * @version $Id$ + */ public class ExtractionException extends Exception { + /** serialVersionUID */ + static final long serialVersionUID = 9074953540861573535L; + /** + * @param message given message + * @param cause given cause + */ public ExtractionException( String message, Throwable cause ) { super( message, cause ); } + /** + * @param message a given message + */ public ExtractionException( String message ) { super( message ); } - } diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java index a8a2886..4fad4ec 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java @@ -27,11 +27,22 @@ import java.util.List; /** * @author jdcasey + * @version $Id$ */ public interface MojoDescriptorExtractor { + /** Plexus role for lookup */ String ROLE = MojoDescriptorExtractor.class.getName(); + /** + * Execute the mojo extraction. + * + * @param project not null Maven project + * @param pluginDescriptor not null plugin descriptor + * @return a list of mojo descriptors. + * @throws ExtractionException if any + * @throws InvalidPluginDescriptorException if any + */ List execute( MavenProject project, PluginDescriptor pluginDescriptor ) throws ExtractionException, InvalidPluginDescriptorException; } \ No newline at end of file