| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_12) on Mon Aug 13 16:24:44 GMT+00:00 2007 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| DVSLTask (DVSL 1.0 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.dvsl.DVSLTask class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="DVSLTask (DVSL 1.0 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DVSLTask.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/dvsl/DVSLNode.html" title="interface in org.apache.dvsl"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/dvsl/DVSLTask.Tool.html" title="class in org.apache.dvsl"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/dvsl/DVSLTask.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DVSLTask.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.dvsl</FONT> |
| <BR> |
| Class DVSLTask</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">MatchingTask |
| <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.dvsl.DVSLTask</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/tools/dvsl/DVSLTask.html" title="class in org.apache.tools.dvsl">DVSLTask</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>DVSLTask</B><DT>extends MatchingTask</DL> |
| </PRE> |
| |
| <P> |
| A Task to process via DVSL a set of XML documents. This is |
| useful for building views of XML based documentation. |
| arguments: |
| <ul> |
| <li>basedir |
| <li>destdir |
| <li>style |
| <li>in |
| <li>out |
| <li>logfile |
| <li>includes |
| <li>excludes |
| <li>force |
| <li>extension |
| <li>outputencoding |
| <li>classpath |
| <li>classpathref |
| <li>toolboxfile |
| <li>velocityconfigclass |
| <li> |
| </ul> |
| <p>Of these arguments, the <b>sourcedir</b> and <b>destdir</b> are required, or, |
| <b>in</b> and <b>out</b> are required.</p> |
| <p>Following are the supported nested elements:</p> |
| <ul> |
| <li><include> |
| <li><exclude> |
| <li><classpath> |
| <li><tool name="toolbox-property" value="value-or-object" /> |
| <li><velconfig name="velocity-config-name" value="config-value" /> |
| </ul> |
| <p>This task will recursively scan the sourcedir and destdir |
| looking for XML documents to process via DVSL. </p> |
| |
| <p>This task was adapted from Ant's <style> task (XSLTProcess class) from the |
| 1.4.1 release.</p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD><a href="mailto:kvisco@exoffice.com">Keith Visco</a>, <a href="mailto:rubys@us.ibm.com">Sam Ruby</a>, <a href="mailto:russgold@acm.org">Russell Gold</a>, <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>, <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>, <a href="mailto:billb@progress.com">Bill Burton.</a></DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.Tool.html" title="class in org.apache.dvsl">DVSLTask.Tool</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.VelocityConfig.html" title="class in org.apache.dvsl">DVSLTask.VelocityConfig</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#INFILENAME">INFILENAME</A></B></CODE> |
| |
| <BR> |
| Supported app values</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#OUTFILENAME">OUTFILENAME</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#DVSLTask()">DVSLTask</A></B>()</CODE> |
| |
| <BR> |
| Creates a new DVSLTask Task.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> Path</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#createClasspath()">createClasspath</A></B>()</CODE> |
| |
| <BR> |
| Set the classpath to load the Processor through (nested element).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/dvsl/DVSLTask.Tool.html" title="class in org.apache.dvsl">DVSLTask.Tool</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#createTool()">createTool</A></B>()</CODE> |
| |
| <BR> |
| support for <tool> nested element</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../org/apache/dvsl/DVSLTask.VelocityConfig.html" title="class in org.apache.dvsl">DVSLTask.VelocityConfig</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#createVelConfig()">createVelConfig</A></B>()</CODE> |
| |
| <BR> |
| support for <velconfig> nested element</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#execute()">execute</A></B>()</CODE> |
| |
| <BR> |
| Executes the task.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#putAppValue(java.lang.String, java.lang.Object)">putAppValue</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</CODE> |
| |
| <BR> |
| Sets an application value from outside of the DVSL task</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setBasedir(java.io.File)">setBasedir</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dir)</CODE> |
| |
| <BR> |
| Set the base directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setClasspath(Path)">setClasspath</A></B>(Path classpath)</CODE> |
| |
| <BR> |
| Set the classpath to load the Processor through (attribute).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setClasspathRef(Reference)">setClasspathRef</A></B>(Reference r)</CODE> |
| |
| <BR> |
| Set the classpath to load the Processor through via reference |
| (attribute).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setDestdir(java.io.File)">setDestdir</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dir)</CODE> |
| |
| <BR> |
| Set the destination directory where the generated |
| files should be directed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setExtension(java.lang.String)">setExtension</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Set the desired file extension to be used for the target files.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setForce(boolean)">setForce</A></B>(boolean force)</CODE> |
| |
| <BR> |
| Set whether to check dependencies, or always generate.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setIn(java.io.File)">setIn</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> inFile)</CODE> |
| |
| <BR> |
| Sets an input xml file to be styled</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setLogFile(java.io.File)">setLogFile</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> logFile)</CODE> |
| |
| <BR> |
| Sets the file to use for logging.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setOut(java.io.File)">setOut</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> outFile)</CODE> |
| |
| <BR> |
| Sets an output file</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setOutputEncoding(java.lang.String)">setOutputEncoding</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> encoding)</CODE> |
| |
| <BR> |
| Sets the character encoding for output files.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setStyle(java.io.File)">setStyle</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dvslFile)</CODE> |
| |
| <BR> |
| Sets the file to use for stylesheet.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setStyleEncoding(java.lang.String)">setStyleEncoding</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> dvslFileEncoding)</CODE> |
| |
| <BR> |
| Sets the encoding of stylesheet file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setToolbox(java.lang.String)">setToolbox</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> toolboxFile)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>use setToolboxFile instead</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setToolboxFile(java.io.File)">setToolboxFile</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> toolboxFile)</CODE> |
| |
| <BR> |
| Sets the Toolbox properties file to use.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setValidatingParser(boolean)">setValidatingParser</A></B>(boolean validating)</CODE> |
| |
| <BR> |
| Sets the flag to have DVSL use a validating parser for the |
| input documents</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../org/apache/dvsl/DVSLTask.html#setVelocityConfigClass(java.lang.String)">setVelocityConfigClass</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> classname)</CODE> |
| |
| <BR> |
| Allows the user to specify a class that implements |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html" title="class or interface in java.util"><CODE>Properties</CODE></A> that will have user properties |
| to be used when setting up DVSL.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="INFILENAME"><!-- --></A><H3> |
| INFILENAME</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>INFILENAME</B></PRE> |
| <DL> |
| <DD>Supported app values |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.dvsl.DVSLTask.INFILENAME">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="OUTFILENAME"><!-- --></A><H3> |
| OUTFILENAME</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>OUTFILENAME</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.dvsl.DVSLTask.OUTFILENAME">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DVSLTask()"><!-- --></A><H3> |
| DVSLTask</H3> |
| <PRE> |
| public <B>DVSLTask</B>()</PRE> |
| <DL> |
| <DD>Creates a new DVSLTask Task. |
| <P> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="execute()"><!-- --></A><H3> |
| execute</H3> |
| <PRE> |
| public void <B>execute</B>() |
| throws BuildException</PRE> |
| <DL> |
| <DD>Executes the task. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>BuildException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setForce(boolean)"><!-- --></A><H3> |
| setForce</H3> |
| <PRE> |
| public void <B>setForce</B>(boolean force)</PRE> |
| <DL> |
| <DD>Set whether to check dependencies, or always generate. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>force</CODE> - false to check dependencies, true to always generate</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setBasedir(java.io.File)"><!-- --></A><H3> |
| setBasedir</H3> |
| <PRE> |
| public void <B>setBasedir</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dir)</PRE> |
| <DL> |
| <DD>Set the base directory. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dir</CODE> - name of the base directory</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDestdir(java.io.File)"><!-- --></A><H3> |
| setDestdir</H3> |
| <PRE> |
| public void <B>setDestdir</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dir)</PRE> |
| <DL> |
| <DD>Set the destination directory where the generated |
| files should be directed. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dir</CODE> - name of the destination directory</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExtension(java.lang.String)"><!-- --></A><H3> |
| setExtension</H3> |
| <PRE> |
| public void <B>setExtension</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>Set the desired file extension to be used for the target files. |
| If not specified, "<code>.html</code>" is used. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the extension to use</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStyle(java.io.File)"><!-- --></A><H3> |
| setStyle</H3> |
| <PRE> |
| public void <B>setStyle</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dvslFile)</PRE> |
| <DL> |
| <DD>Sets the file to use for stylesheet. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dvslFile</CODE> - stylesheet filename</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStyleEncoding(java.lang.String)"><!-- --></A><H3> |
| setStyleEncoding</H3> |
| <PRE> |
| public void <B>setStyleEncoding</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> dvslFileEncoding)</PRE> |
| <DL> |
| <DD>Sets the encoding of stylesheet file. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dvslFileEncoding</CODE> - encoding of stylesheet file</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLogFile(java.io.File)"><!-- --></A><H3> |
| setLogFile</H3> |
| <PRE> |
| public void <B>setLogFile</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> logFile)</PRE> |
| <DL> |
| <DD>Sets the file to use for logging. If not specified, all logging |
| is directed through Ant's logging system. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>logFile</CODE> - logging filename</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setToolbox(java.lang.String)"><!-- --></A><H3> |
| setToolbox</H3> |
| <PRE> |
| public void <B>setToolbox</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> toolboxFile)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>use setToolboxFile instead</I> |
| <P> |
| <DD>Sets the Toolbox properties file to use. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>toolboxFile</CODE> - properties file of tools</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setToolboxFile(java.io.File)"><!-- --></A><H3> |
| setToolboxFile</H3> |
| <PRE> |
| public void <B>setToolboxFile</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> toolboxFile)</PRE> |
| <DL> |
| <DD>Sets the Toolbox properties file to use. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>toolboxFile</CODE> - properties file of tools</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVelocityConfigClass(java.lang.String)"><!-- --></A><H3> |
| setVelocityConfigClass</H3> |
| <PRE> |
| public void <B>setVelocityConfigClass</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> classname)</PRE> |
| <DL> |
| <DD>Allows the user to specify a class that implements |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html" title="class or interface in java.util"><CODE>Properties</CODE></A> that will have user properties |
| to be used when setting up DVSL. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>classname</CODE> - Velocity configuration class to load</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOut(java.io.File)"><!-- --></A><H3> |
| setOut</H3> |
| <PRE> |
| public void <B>setOut</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> outFile)</PRE> |
| <DL> |
| <DD>Sets an output file |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>outFile</CODE> - output file</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIn(java.io.File)"><!-- --></A><H3> |
| setIn</H3> |
| <PRE> |
| public void <B>setIn</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> inFile)</PRE> |
| <DL> |
| <DD>Sets an input xml file to be styled |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>inFile</CODE> - input file</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOutputEncoding(java.lang.String)"><!-- --></A><H3> |
| setOutputEncoding</H3> |
| <PRE> |
| public void <B>setOutputEncoding</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> encoding)</PRE> |
| <DL> |
| <DD>Sets the character encoding for output files. If not specified, |
| output is written with UTF-8 encodin6g. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>encoding</CODE> - Output encoding</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setClasspath(Path)"><!-- --></A><H3> |
| setClasspath</H3> |
| <PRE> |
| public void <B>setClasspath</B>(Path classpath)</PRE> |
| <DL> |
| <DD>Set the classpath to load the Processor through (attribute). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>classpath</CODE> - classpath to set</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createClasspath()"><!-- --></A><H3> |
| createClasspath</H3> |
| <PRE> |
| public Path <B>createClasspath</B>()</PRE> |
| <DL> |
| <DD>Set the classpath to load the Processor through (nested element). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setClasspathRef(Reference)"><!-- --></A><H3> |
| setClasspathRef</H3> |
| <PRE> |
| public void <B>setClasspathRef</B>(Reference r)</PRE> |
| <DL> |
| <DD>Set the classpath to load the Processor through via reference |
| (attribute). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>r</CODE> - reference to classpath</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValidatingParser(boolean)"><!-- --></A><H3> |
| setValidatingParser</H3> |
| <PRE> |
| public void <B>setValidatingParser</B>(boolean validating)</PRE> |
| <DL> |
| <DD>Sets the flag to have DVSL use a validating parser for the |
| input documents |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="putAppValue(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| putAppValue</H3> |
| <PRE> |
| public void <B>putAppValue</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> o)</PRE> |
| <DL> |
| <DD>Sets an application value from outside of the DVSL task |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createTool()"><!-- --></A><H3> |
| createTool</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/dvsl/DVSLTask.Tool.html" title="class in org.apache.dvsl">DVSLTask.Tool</A> <B>createTool</B>()</PRE> |
| <DL> |
| <DD>support for <tool> nested element |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createVelConfig()"><!-- --></A><H3> |
| createVelConfig</H3> |
| <PRE> |
| public <A HREF="../../../org/apache/dvsl/DVSLTask.VelocityConfig.html" title="class in org.apache.dvsl">DVSLTask.VelocityConfig</A> <B>createVelConfig</B>()</PRE> |
| <DL> |
| <DD>support for <velconfig> nested element |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DVSLTask.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../org/apache/dvsl/DVSLNode.html" title="interface in org.apache.dvsl"><B>PREV CLASS</B></A> |
| <A HREF="../../../org/apache/dvsl/DVSLTask.Tool.html" title="class in org.apache.dvsl"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?org/apache/dvsl/DVSLTask.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DVSLTask.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2002-2007 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
