org.apache.avalon.meta.info.ant
Class MetaTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.thoughtworks.qdox.ant.AbstractQdoxTask
              org.apache.avalon.meta.info.ant.MetaTask

public class MetaTask

extends AbstractQdoxTask

Generate a meta info model from javadoc tags.

Version:

$Revision: 1.1.1.5 $ $Date: 2003/12/23 00:19:51 $

Author:

Avalon Development Team

Field Summary

static int	SER_TYPE Serial output type code.
static int	XML_TYPE XML output type code.

Fields inherited from class com.thoughtworks.qdox.ant.AbstractQdoxTask

allClasses, allSources, fileMap

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

MetaTask()

Method Summary

void	execute() Execute generator task.
protected File	getDestDir() Return the destination directory in which files are generated.
void	setDestDir(File destDir) Set the desitation directory to generate output files to.
void	setForce(boolean force) Set force to be true indicating that destination files should always be regenerated.
void	setFormat(FormatEnum format) Specify the output format.
void	setPostfix(String postfix) Set the file type to be used for meta info type documents.

Methods inherited from class com.thoughtworks.qdox.ant.AbstractQdoxTask

addFileset, buildFileMap, buildFileMap, processClasses, processSources, validateAttributes

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_TYPE

public static final int XML_TYPE

XML output type code.

See Also:

Constant Field Values

SER_TYPE

public static final int SER_TYPE

Serial output type code.

See Also:

Constant Field Values

Constructor Detail

MetaTask

public MetaTask()

Method Detail

setDestDir

public void setDestDir(File destDir)

Set the desitation directory to generate output files to.

Parameters:

destDir - The destination directory

setFormat

public void setFormat(FormatEnum format)

Specify the output format. Must be one of xml or serialized.

Parameters:

format - the output format

setForce

public void setForce(boolean force)

Set force to be true indicating that destination files should always be regenerated.

Parameters:

force - the flag for forcing output

setPostfix

public void setPostfix(String postfix)

Set the file type to be used for meta info type documents. May be one of "xinfo" or "xtype".

Parameters:

postfix - the postfix value

execute

public void execute()
             throws BuildException

Execute generator task.

Throws:

BuildException - if a build error occurs

getDestDir

protected final File getDestDir()

Return the destination directory in which files are generated.

Returns:

the destination directory in which files are generated.