org.codehaus.enunciate.main
Class EnunciateTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.tools.ant.taskdefs.MatchingTask
              org.codehaus.enunciate.main.EnunciateTask

All Implemented Interfaces:

java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer

public class EnunciateTask
extends org.apache.tools.ant.taskdefs.MatchingTask

Ant task for enunciate.

Author:

Ryan Heaton

Nested Class Summary

static class

EnunciateTask.Export A nested export task.

Field Summary

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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

taskName, taskType, wrapper

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

description, location, project

Constructor Summary

EnunciateTask()

Method Summary

org.apache.tools.ant.types.Path	createClasspath() Adds a path to the classpath.
EnunciateTask.Export	createExport() Creates a nested export task.
void	execute() Executes the enunciate task.
org.apache.tools.ant.types.Path	getClasspath() The classpath to use to enunciate.
boolean	isCompileDebugInfo() Whether to compile with debug info.
void	setBasedir(java.io.File basedir) The base directory for the source files.
void	setBuildDir(java.io.File buildDir) The build directory.
void	setClasspath(org.apache.tools.ant.types.Path classpath) The classpath to use to enunciate.
void	setClasspathRef(org.apache.tools.ant.types.Reference ref) Adds a reference to a classpath defined elsewhere.
void	setCompileDebugInfo(boolean compileDebugInfo) Whether to compile with debug info.
void	setCompileDir(java.io.File compileDir) The compile directory.
void	setConfigFile(java.io.File config) The enunciate config file.
void	setDebug(boolean debug) Whether to print debugging information.
void	setDir(java.io.File basedir) The base directory for the source files.
void	setFlexHome(java.io.File flexHome) The path to flex home.
void	setGenerateDir(java.io.File generateDir) The generate directory.
void	setGwtHome(java.io.File gwtHome) The path to gwt home.
void	setPackageDir(java.io.File packageDir) The package directory.
void	setScratchDir(java.io.File scratchDir) Enunciate scratch directory.
void	setTarget(java.lang.String target) The target.
void	setVerbose(boolean verbose) Whether to be verbose.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

clone, getDescription, getLocation, getProject, setDescription, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

EnunciateTask

public EnunciateTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Executes the enunciate task.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

setBasedir

public void setBasedir(java.io.File basedir)

The base directory for the source files.

Parameters:

basedir - The base directory for the source files.

setDir

public void setDir(java.io.File basedir)

The base directory for the source files.

Parameters:

basedir - The base directory for the source files.

setGenerateDir

public void setGenerateDir(java.io.File generateDir)

The generate directory.

Parameters:

generateDir - The generate directory.

setCompileDir

public void setCompileDir(java.io.File compileDir)

The compile directory.

Parameters:

compileDir - The compile directory.

setBuildDir

public void setBuildDir(java.io.File buildDir)

The build directory.

Parameters:

buildDir - The build directory.

setPackageDir

public void setPackageDir(java.io.File packageDir)

The package directory.

Parameters:

packageDir - The package directory.

setScratchDir

public void setScratchDir(java.io.File scratchDir)

Enunciate scratch directory.

Parameters:

scratchDir - The scratch directory

setVerbose

public void setVerbose(boolean verbose)

Whether to be verbose.

Parameters:

verbose - Whether to be verbose.

setDebug

public void setDebug(boolean debug)

Whether to print debugging information.

Parameters:

debug - Whether to print debugging information.

setConfigFile

public void setConfigFile(java.io.File config)

The enunciate config file.

Parameters:

config - The enunciate config file.

setTarget

public void setTarget(java.lang.String target)

The target.

Parameters:

target - The target.

setGwtHome

public void setGwtHome(java.io.File gwtHome)

The path to gwt home.

Parameters:

gwtHome - The path to gwt home.

setFlexHome

public void setFlexHome(java.io.File flexHome)

The path to flex home.

Parameters:

flexHome - The path to flex home.

isCompileDebugInfo

public boolean isCompileDebugInfo()

Whether to compile with debug info.

Returns:

Whether to compile with debug info.

setCompileDebugInfo

public void setCompileDebugInfo(boolean compileDebugInfo)

Whether to compile with debug info.

Parameters:

compileDebugInfo - Whether to compile with debug info.

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)

The classpath to use to enunciate.

Parameters:

classpath - The classpath to use to enunciate.

getClasspath

public org.apache.tools.ant.types.Path getClasspath()

The classpath to use to enunciate.

Returns:

The classpath to use to enunciate.

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

Adds a path to the classpath.

Returns:

The path.

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference ref)

Adds a reference to a classpath defined elsewhere.

Parameters:

ref - a reference to a classpath.

createExport

public EnunciateTask.Export createExport()

Creates a nested export task.

Returns:

the nested export task.