|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.dvsl.DVSLTask
A Task to process via DVSL a set of XML documents. This is useful for building views of XML based documentation. arguments:
Of these arguments, the sourcedir and destdir are required, or, in and out are required.
Following are the supported nested elements:
This task will recursively scan the sourcedir and destdir looking for XML documents to process via DVSL.
This task was adapted from Ant's <style> task (XSLTProcess class) from the 1.4.1 release.
Nested Class Summary | |
class |
DVSLTask.Tool
|
class |
DVSLTask.VelocityConfig
|
Field Summary | |
static String |
INFILENAME
Supported app values |
static String |
OUTFILENAME
|
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
fileset |
Fields inherited from class org.apache.tools.ant.Task |
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
description, location, project |
Constructor Summary | |
DVSLTask()
Creates a new DVSLTask Task. |
Method Summary | |
org.apache.tools.ant.types.Path |
createClasspath()
Set the classpath to load the Processor through (nested element). |
DVSLTask.Tool |
createTool()
support for <tool> nested element |
DVSLTask.VelocityConfig |
createVelConfig()
support for <velconfig> nested element |
void |
execute()
Executes the task. |
void |
putAppValue(String name,
Object o)
Sets an application value from outside of the DVSL task |
void |
setBasedir(File dir)
Set the base directory. |
void |
setClasspath(org.apache.tools.ant.types.Path classpath)
Set the classpath to load the Processor through (attribute). |
void |
setClasspathRef(org.apache.tools.ant.types.Reference r)
Set the classpath to load the Processor through via reference (attribute). |
void |
setDestdir(File dir)
Set the destination directory where the generated files should be directed. |
void |
setExtension(String name)
Set the desired file extension to be used for the target files. |
void |
setForce(boolean force)
Set whether to check dependencies, or always generate. |
void |
setIn(File inFile)
Sets an input xml file to be styled |
void |
setLogFile(File logFile)
Sets the file to use for logging. |
void |
setOut(File outFile)
Sets an output file |
void |
setOutputEncoding(String encoding)
Sets the character encoding for output files. |
void |
setStyle(File dvslFile)
Sets the file to use for stylesheet. |
void |
setStyleEncoding(String dvslFileEncoding)
Sets the encoding of stylesheet file. |
void |
setToolbox(String toolboxFile)
Deprecated. use setToolboxFile instead |
void |
setToolboxFile(File toolboxFile)
Sets the Toolbox properties file to use. |
void |
setValidatingParser(boolean validating)
Sets the flag to have DVSL use a validating parser for the input documents |
void |
setVelocityConfigClass(String classname)
Allows the user to specify a class that implements Properties that will have user properties
to be used when setting up DVSL. |
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 |
Field Detail |
public static final String INFILENAME
public static final String OUTFILENAME
Constructor Detail |
public DVSLTask()
Method Detail |
public void execute() throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
public void setForce(boolean force)
force
- false to check dependencies, true to always generatepublic void setBasedir(File dir)
dir
- name of the base directorypublic void setDestdir(File dir)
dir
- name of the destination directorypublic void setExtension(String name)
.html
" is used.
name
- the extension to usepublic void setStyle(File dvslFile)
dvslFile
- stylesheet filenamepublic void setStyleEncoding(String dvslFileEncoding)
dvslFileEncoding
- encoding of stylesheet filepublic void setLogFile(File logFile)
logFile
- logging filenamepublic void setToolbox(String toolboxFile)
toolboxFile
- properties file of toolspublic void setToolboxFile(File toolboxFile)
toolboxFile
- properties file of toolspublic void setVelocityConfigClass(String classname)
Properties
that will have user properties
to be used when setting up DVSL.
classname
- Velocity configuration class to loadpublic void setOut(File outFile)
outFile
- output filepublic void setIn(File inFile)
inFile
- input filepublic void setOutputEncoding(String encoding)
encoding
- Output encodingpublic void setClasspath(org.apache.tools.ant.types.Path classpath)
classpath
- classpath to setpublic org.apache.tools.ant.types.Path createClasspath()
public void setClasspathRef(org.apache.tools.ant.types.Reference r)
r
- reference to classpathpublic void setValidatingParser(boolean validating)
public void putAppValue(String name, Object o)
public DVSLTask.Tool createTool()
public DVSLTask.VelocityConfig createVelConfig()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |