org.apache.avalon.fortress.tools
Class ComponentMetaInfoCollector

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

public final class ComponentMetaInfoCollector

extends java.lang.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 java.util.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(java.lang.String type) Get the unique Service object for the specified type.
void	setAllClasses(java.util.ArrayList allClasses) Set the list of classes to extract metadata from
void	setDestDir(java.io.File destDir) Set the destination directory for the meta information.
void	writeServiceList(java.util.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 java.util.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 java.lang.Exception

Execute generator task.

Throws:

BuildException - if there was a problem collecting the info

java.lang.Exception

writeServiceList

public void writeServiceList(java.util.Iterator it)
                      throws java.io.IOException

Write the service list to the "/service.list" file.

Parameters:

it - The iterator for the services

Throws:

java.io.IOException - if there is a problem writing the file

getService

protected org.apache.avalon.fortress.tools.Service getService(java.lang.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(java.util.ArrayList allClasses)

Set the list of classes to extract metadata from

Parameters:

allClasses - The list of classes

setDestDir

public void setDestDir(java.io.File destDir)

Set the destination directory for the meta information.

Parameters:

destDir - The destination directory