You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2008/02/19 12:37:31 UTC
svn commit: r629075 - in
/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor:
AbstractScriptedMojoDescriptorExtractor.java ExtractionException.java
MojoDescriptorExtractor.java
Author: vsiveton
Date: Tue Feb 19 03:37:25 2008
New Revision: 629075
URL: http://svn.apache.org/viewvc?rev=629075&view=rev
Log:
o more javadoc
Modified:
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java
Modified: maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java?rev=629075&r1=629074&r2=629075&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java Tue Feb 19 03:37:25 2008
@@ -38,11 +38,13 @@
/**
* @author jdcasey
+ * @version $Id$
*/
public abstract class AbstractScriptedMojoDescriptorExtractor
extends AbstractLogEnabled
implements MojoDescriptorExtractor
{
+ /** {@inheritDoc} */
public List execute( MavenProject project, PluginDescriptor pluginDescriptor )
throws ExtractionException, InvalidPluginDescriptorException
{
Modified: maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java?rev=629075&r1=629074&r2=629075&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/ExtractionException.java Tue Feb 19 03:37:25 2008
@@ -19,18 +19,32 @@
* under the License.
*/
+/**
+ * Wrap errors when extraction exception occurred.
+ *
+ * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
+ * @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 );
}
-
}
Modified: maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java?rev=629075&r1=629074&r2=629075&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/MojoDescriptorExtractor.java Tue Feb 19 03:37:25 2008
@@ -27,11 +27,22 @@
/**
* @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;
}