org.apache.avalon.fortress.tools
Class AbstractQDoxMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.avalon.fortress.tools.AbstractQDoxMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
ComponentMetaMavenMojo

public class AbstractQDoxMojo
extends org.apache.maven.plugin.AbstractMojo

An abstract class that provides the common logic of getting directory and file-set configuration information from Maven before creating the list of classes and source files that will be parsed by QDox. Classes extending this class must call the execute() method, after which the allSources and allClasses fields are filled in.

Version:
CVS $Revision: 1.1 $ $Date: 2005/12/25 08:29:44 $
Author:
The Excalibur Team

Field Summary
protected  ArrayList allClasses
           
protected  ArrayList allSources
           
protected  HashMap fileMap
           
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AbstractQDoxMojo()
           
 
Method Summary
protected  void buildFileMap()
           
protected  void buildFileMap(File directory, String[] sourceFiles)
           
protected  org.apache.maven.model.FileSet[] createDefaultFileset()
           
protected  com.thoughtworks.qdox.model.DocletTagFactory createDocletTagFactory()
           
 void execute()
           
 File getDestDir()
           
protected  void processClasses(com.thoughtworks.qdox.model.JavaClass[] classes)
           
protected  void processSources(com.thoughtworks.qdox.model.JavaSource[] sources)
           
protected  void validateAttributes()
           
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fileMap

protected HashMap fileMap

allSources

protected ArrayList allSources

allClasses

protected ArrayList allClasses
Constructor Detail

AbstractQDoxMojo

public AbstractQDoxMojo()
Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException

buildFileMap

protected void buildFileMap()

buildFileMap

protected void buildFileMap(File directory,
                            String[] sourceFiles)

createDocletTagFactory

protected com.thoughtworks.qdox.model.DocletTagFactory createDocletTagFactory()

processSources

protected void processSources(com.thoughtworks.qdox.model.JavaSource[] sources)

processClasses

protected void processClasses(com.thoughtworks.qdox.model.JavaClass[] classes)

validateAttributes

protected void validateAttributes()
                           throws org.apache.maven.plugin.MojoExecutionException
Throws:
org.apache.maven.plugin.MojoExecutionException

createDefaultFileset

protected org.apache.maven.model.FileSet[] createDefaultFileset()

getDestDir

public File getDestDir()


Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.