org.apache.avalon.fortress.tools
Class ComponentMetaInfoCollector

java.lang.Object
  extended by org.apache.avalon.fortress.tools.ComponentMetaInfoCollector

public final class ComponentMetaInfoCollector
extends Object

QDox-based engine to collect all the meta information for the components. This common class is utilized by both Ant and Maven plgins, and possibly others in the future.

Version:
CVS $Revision: 1.1 $ $Date: 2004/04/02 08:29:44 $
Author:
The Avalon Team

Field Summary
protected  ArrayList m_allClasses
          The list of classes to extract metadata from
protected  BuildLogger m_logger
          To log messages - varies by build system used
 
Constructor Summary
ComponentMetaInfoCollector(BuildLogger logger)
           
 
Method Summary
 void execute()
          Execute generator task.
protected  org.apache.avalon.fortress.tools.Service getService(String type)
          Get the unique Service object for the specified type.
 void setAllClasses(ArrayList allClasses)
          Set the list of classes to extract metadata from
 void setDestDir(File destDir)
          Set the destination directory for the meta information.
 void writeServiceList(Iterator it)
          Write the service list to the "/service.list" file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_logger

protected BuildLogger m_logger
To log messages - varies by build system used


m_allClasses

protected ArrayList m_allClasses
The list of classes to extract metadata from

Constructor Detail

ComponentMetaInfoCollector

public ComponentMetaInfoCollector(BuildLogger logger)
Method Detail

execute

public void execute()
             throws Exception
Execute generator task.

Throws:
BuildException - if there was a problem collecting the info
Exception

writeServiceList

public void writeServiceList(Iterator it)
                      throws IOException
Write the service list to the "/service.list" file.

Parameters:
it - The iterator for the services
Throws:
IOException - if there is a problem writing the file

getService

protected org.apache.avalon.fortress.tools.Service getService(String type)
Get the unique Service object for the specified type.

Parameters:
type - The service type name
Returns:
the Service object

setAllClasses

public void setAllClasses(ArrayList allClasses)
Set the list of classes to extract metadata from

Parameters:
allClasses - The list of classes

setDestDir

public void setDestDir(File destDir)
Set the destination directory for the meta information.

Parameters:
destDir - The destination directory


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