com.aurigalogic.aurigadoc.ant
Class AurigaDocTask

java.lang.Object
  |
  +--Task
        |
        +--com.aurigalogic.aurigadoc.ant.AurigaDocTask

public class AurigaDocTask
extends Task

This class implements the ant task for invoking AurigaDoc from ant.

Version:
$Revision: 1.7 $ $Date: 2003/11/06 06:59:23 $
Author:
Khurshidali Shaikh
See Also:
Serialized Form

Constructor Summary
AurigaDocTask()
          Default constructor
 
Method Summary
 void addConfiguredParam(Param param)
          Adds the values submitted in the param element of the task.
 void execute()
          Executes the task.
 void setForce(boolean force)
          Sets the flag to force conversion
 void setFormat(java.lang.String fmt)
          Sets the output format required.
 void setInput(java.io.File in)
          Sets the input file.
 void setOutput(java.io.File out)
          Sets the output file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AurigaDocTask

public AurigaDocTask()
Default constructor

Method Detail

execute

public void execute()
             throws BuildException
Executes the task.

Throws:
BuildException - - if the build fails.

setInput

public void setInput(java.io.File in)
Sets the input file.

Parameters:
in - the input file

setOutput

public void setOutput(java.io.File out)
Sets the output file.

Parameters:
out - the output file.

setFormat

public void setFormat(java.lang.String fmt)
Sets the output format required.

Parameters:
fmt - the output format

setForce

public void setForce(boolean force)
Sets the flag to force conversion

Parameters:
force - whether to force conversion

addConfiguredParam

public void addConfiguredParam(Param param)
Adds the values submitted in the param element of the task.

Parameters:
param - the param element.


Copyright © 2000, 2003 Auriga Logic Pvt. Ltd. All Rights Reserved.