o more javadoc

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@629075 13f79535-47bb-0310-9956-ffa450edef68
master
Vincent Siveton 2008-02-19 11:37:25 +00:00
parent c0b1429c81
commit df38c418d9
3 changed files with 28 additions and 1 deletions

View File

@ -38,11 +38,13 @@ import java.util.TreeMap;
/** /**
* @author jdcasey * @author jdcasey
* @version $Id$
*/ */
public abstract class AbstractScriptedMojoDescriptorExtractor public abstract class AbstractScriptedMojoDescriptorExtractor
extends AbstractLogEnabled extends AbstractLogEnabled
implements MojoDescriptorExtractor implements MojoDescriptorExtractor
{ {
/** {@inheritDoc} */
public List execute( MavenProject project, PluginDescriptor pluginDescriptor ) public List execute( MavenProject project, PluginDescriptor pluginDescriptor )
throws ExtractionException, InvalidPluginDescriptorException throws ExtractionException, InvalidPluginDescriptorException
{ {

View File

@ -19,18 +19,32 @@ package org.apache.maven.tools.plugin.extractor;
* under the License. * 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 public class ExtractionException
extends Exception extends Exception
{ {
/** serialVersionUID */
static final long serialVersionUID = 9074953540861573535L;
/**
* @param message given message
* @param cause given cause
*/
public ExtractionException( String message, Throwable cause ) public ExtractionException( String message, Throwable cause )
{ {
super( message, cause ); super( message, cause );
} }
/**
* @param message a given message
*/
public ExtractionException( String message ) public ExtractionException( String message )
{ {
super( message ); super( message );
} }
} }

View File

@ -27,11 +27,22 @@ import java.util.List;
/** /**
* @author jdcasey * @author jdcasey
* @version $Id$
*/ */
public interface MojoDescriptorExtractor public interface MojoDescriptorExtractor
{ {
/** Plexus role for lookup */
String ROLE = MojoDescriptorExtractor.class.getName(); 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 ) List execute( MavenProject project, PluginDescriptor pluginDescriptor )
throws ExtractionException, InvalidPluginDescriptorException; throws ExtractionException, InvalidPluginDescriptorException;
} }