<!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.6.0_04) on Tue Dec 02 17:12:23 PST 2008 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
TexenTask (Apache Velocity 1.6 API) | |
</TITLE> | |
<META NAME="date" CONTENT="2008-12-02"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="TexenTask (Apache Velocity 1.6 API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= 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/TexenTask.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"> | |
PREV CLASS | |
NEXT CLASS</FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/velocity/texen/ant/TexenTask.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="TexenTask.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: NESTED | <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.velocity.texen.ant</FONT> | |
<BR> | |
Class TexenTask</H2> | |
<PRE> | |
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.ProjectComponent | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.Task | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.texen.ant.TexenTask</B> | |
</PRE> | |
<HR> | |
<DL> | |
<DT><PRE>public class <B>TexenTask</B><DT>extends org.apache.tools.ant.Task</DL> | |
</PRE> | |
<P> | |
An ant task for generating output by using Velocity | |
<P> | |
<P> | |
<DL> | |
<DT><B>Version:</B></DT> | |
<DD>$Id: TexenTask.java 463298 2006-10-12 16:10:32Z henning $</DD> | |
<DT><B>Author:</B></DT> | |
<DD><a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>, <a href="robertdonkin@mac.com">Robert Burrell Donkin</a></DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- =========== 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>protected <A HREF="http://jakarta.apache.org/commons/collections/api-release/org/apache/commons/collections/ExtendedProperties.html?is-external=true" title="class or interface in org.apache.commons.collections">ExtendedProperties</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#contextProperties">contextProperties</A></B></CODE> | |
<BR> | |
| |
These are properties that are fed into the | |
initial context from a properties file.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#controlTemplate">controlTemplate</A></B></CODE> | |
<BR> | |
This is the control template that governs the output.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#inputEncoding">inputEncoding</A></B></CODE> | |
<BR> | |
This is the encoding for the input file(s) | |
(templates).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#logFile">logFile</A></B></CODE> | |
<BR> | |
The LogFile (incl.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#outputDirectory">outputDirectory</A></B></CODE> | |
<BR> | |
This is where texen will place all the output | |
that is a product of the generation process.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#outputEncoding">outputEncoding</A></B></CODE> | |
<BR> | |
This is the encoding for the output file(s).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#outputFile">outputFile</A></B></CODE> | |
<BR> | |
This is the file where the generated text | |
will be placed.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#resourceLoaderModificationCheckInterval">resourceLoaderModificationCheckInterval</A></B></CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#templatePath">templatePath</A></B></CODE> | |
<BR> | |
This is where Velocity will look for templates | |
using the file template loader.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#useClasspath">useClasspath</A></B></CODE> | |
<BR> | |
Property which controls whether the classpath | |
will be used when trying to locate templates.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#useResourceLoaderCache">useResourceLoaderCache</A></B></CODE> | |
<BR> | |
Property which controls whether the resource | |
loader will be told to cache.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.tools.ant.Task</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>description, location, target, taskName, taskType, wrapper</CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.tools.ant.ProjectComponent</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>project</CODE></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/velocity/texen/ant/TexenTask.html#TexenTask()">TexenTask</A></B>()</CODE> | |
<BR> | |
</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>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#cleanup()">cleanup</A></B>()</CODE> | |
<BR> | |
A hook method called at the end of <A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#execute()"><CODE>execute()</CODE></A> which can | |
be overridden to perform any necessary cleanup activities (such | |
as the release of database connections, etc.).</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/velocity/texen/ant/TexenTask.html#execute()">execute</A></B>()</CODE> | |
<BR> | |
Execute the input script with Velocity</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://jakarta.apache.org/commons/collections/api-release/org/apache/commons/collections/ExtendedProperties.html?is-external=true" title="class or interface in org.apache.commons.collections">ExtendedProperties</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#getContextProperties()">getContextProperties</A></B>()</CODE> | |
<BR> | |
Get the context properties that will be | |
fed into the initial context be the | |
generating process starts.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#getControlTemplate()">getControlTemplate</A></B>()</CODE> | |
<BR> | |
Get the control template for the | |
generating process.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#getLogFile()">getLogFile</A></B>()</CODE> | |
<BR> | |
Gets the log file.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#getOutputDirectory()">getOutputDirectory</A></B>()</CODE> | |
<BR> | |
Get the output directory.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#getOutputFile()">getOutputFile</A></B>()</CODE> | |
<BR> | |
Get the output file for the | |
generation process.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#getTemplatePath()">getTemplatePath</A></B>()</CODE> | |
<BR> | |
Get the path where Velocity will look | |
for templates using the file template | |
loader.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#initControlContext()">initControlContext</A></B>()</CODE> | |
<BR> | |
Creates a VelocityContext.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#populateInitialContext(org.apache.velocity.context.Context)">populateInitialContext</A></B>(<A HREF="../../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</A> context)</CODE> | |
<BR> | |
Place useful objects into the initial context.</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/velocity/texen/ant/TexenTask.html#setContextProperties(java.lang.String)">setContextProperties</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> file)</CODE> | |
<BR> | |
Set the context properties that will be | |
fed into the initial context be the | |
generating process starts.</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/velocity/texen/ant/TexenTask.html#setControlTemplate(java.lang.String)">setControlTemplate</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> controlTemplate)</CODE> | |
<BR> | |
[REQUIRED] Set the control template for the | |
generating process.</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/velocity/texen/ant/TexenTask.html#setInputEncoding(java.lang.String)">setInputEncoding</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> inputEncoding)</CODE> | |
<BR> | |
Set the input (template) encoding.</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/velocity/texen/ant/TexenTask.html#setLogFile(java.lang.String)">setLogFile</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> log)</CODE> | |
<BR> | |
Sets the log 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/velocity/texen/ant/TexenTask.html#setOutputDirectory(java.io.File)">setOutputDirectory</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> outputDirectory)</CODE> | |
<BR> | |
[REQUIRED] Set the output 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/velocity/texen/ant/TexenTask.html#setOutputEncoding(java.lang.String)">setOutputEncoding</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> outputEncoding)</CODE> | |
<BR> | |
Set the output encoding.</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/velocity/texen/ant/TexenTask.html#setOutputFile(java.lang.String)">setOutputFile</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> outputFile)</CODE> | |
<BR> | |
[REQUIRED] Set the output file for the | |
generation process.</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/velocity/texen/ant/TexenTask.html#setResourceLoaderModificationCheckInterval(java.lang.String)">setResourceLoaderModificationCheckInterval</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> resourceLoaderModificationCheckInterval)</CODE> | |
<BR> | |
</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/velocity/texen/ant/TexenTask.html#setTemplatePath(java.lang.String)">setTemplatePath</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> templatePath)</CODE> | |
<BR> | |
[REQUIRED] Set the path where Velocity will look | |
for templates using the file template | |
loader.</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/velocity/texen/ant/TexenTask.html#setUseClasspath(boolean)">setUseClasspath</A></B>(boolean useClasspath)</CODE> | |
<BR> | |
Set the use of the classpath in locating templates</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/velocity/texen/ant/TexenTask.html#setUseResourceLoaderCache(java.lang.String)">setUseResourceLoaderCache</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> useResourceLoaderCache)</CODE> | |
<BR> | |
</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.tools.ant.Task</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType</CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.tools.ant.ProjectComponent</B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE>getProject, setProject</CODE></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.4.2/docs/api/java/lang/Object.html?is-external=true" 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.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#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="controlTemplate"><!-- --></A><H3> | |
controlTemplate</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>controlTemplate</B></PRE> | |
<DL> | |
<DD>This is the control template that governs the output. | |
It may or may not invoke the services of worker | |
templates. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="templatePath"><!-- --></A><H3> | |
templatePath</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>templatePath</B></PRE> | |
<DL> | |
<DD>This is where Velocity will look for templates | |
using the file template loader. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="outputDirectory"><!-- --></A><H3> | |
outputDirectory</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>outputDirectory</B></PRE> | |
<DL> | |
<DD>This is where texen will place all the output | |
that is a product of the generation process. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="outputFile"><!-- --></A><H3> | |
outputFile</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>outputFile</B></PRE> | |
<DL> | |
<DD>This is the file where the generated text | |
will be placed. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="outputEncoding"><!-- --></A><H3> | |
outputEncoding</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>outputEncoding</B></PRE> | |
<DL> | |
<DD>This is the encoding for the output file(s). | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="inputEncoding"><!-- --></A><H3> | |
inputEncoding</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>inputEncoding</B></PRE> | |
<DL> | |
<DD>This is the encoding for the input file(s) | |
(templates). | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="contextProperties"><!-- --></A><H3> | |
contextProperties</H3> | |
<PRE> | |
protected <A HREF="http://jakarta.apache.org/commons/collections/api-release/org/apache/commons/collections/ExtendedProperties.html?is-external=true" title="class or interface in org.apache.commons.collections">ExtendedProperties</A> <B>contextProperties</B></PRE> | |
<DL> | |
<DD><p> | |
These are properties that are fed into the | |
initial context from a properties file. This | |
is simply a convenient way to set some values | |
that you wish to make available in the context. | |
</p> | |
<p> | |
These values are not critical, like the template path | |
or output path, but allow a convenient way to | |
set a value that may be specific to a particular | |
generation task. | |
</p> | |
<p> | |
For example, if you are generating scripts to allow | |
user to automatically create a database, then | |
you might want the <code>$databaseName</code> | |
to be placed | |
in the initial context so that it is available | |
in a script that might look something like the | |
following: | |
<code><pre> | |
#!bin/sh | |
echo y | mysqladmin create $databaseName | |
</pre></code> | |
The value of <code>$databaseName</code> isn't critical to | |
output, and you obviously don't want to change | |
the ant task to simply take a database name. | |
So initial context values can be set with | |
properties file. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="useClasspath"><!-- --></A><H3> | |
useClasspath</H3> | |
<PRE> | |
protected boolean <B>useClasspath</B></PRE> | |
<DL> | |
<DD>Property which controls whether the classpath | |
will be used when trying to locate templates. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="logFile"><!-- --></A><H3> | |
logFile</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>logFile</B></PRE> | |
<DL> | |
<DD>The LogFile (incl. path) to log to. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="useResourceLoaderCache"><!-- --></A><H3> | |
useResourceLoaderCache</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>useResourceLoaderCache</B></PRE> | |
<DL> | |
<DD>Property which controls whether the resource | |
loader will be told to cache. Default false | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="resourceLoaderModificationCheckInterval"><!-- --></A><H3> | |
resourceLoaderModificationCheckInterval</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>resourceLoaderModificationCheckInterval</B></PRE> | |
<DL> | |
<DL> | |
</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="TexenTask()"><!-- --></A><H3> | |
TexenTask</H3> | |
<PRE> | |
public <B>TexenTask</B>()</PRE> | |
<DL> | |
</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="setControlTemplate(java.lang.String)"><!-- --></A><H3> | |
setControlTemplate</H3> | |
<PRE> | |
public void <B>setControlTemplate</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> controlTemplate)</PRE> | |
<DL> | |
<DD>[REQUIRED] Set the control template for the | |
generating process. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>controlTemplate</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getControlTemplate()"><!-- --></A><H3> | |
getControlTemplate</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getControlTemplate</B>()</PRE> | |
<DL> | |
<DD>Get the control template for the | |
generating process. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The current control template.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setTemplatePath(java.lang.String)"><!-- --></A><H3> | |
setTemplatePath</H3> | |
<PRE> | |
public void <B>setTemplatePath</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> templatePath) | |
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> | |
<DL> | |
<DD>[REQUIRED] Set the path where Velocity will look | |
for templates using the file template | |
loader. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>templatePath</CODE> - | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getTemplatePath()"><!-- --></A><H3> | |
getTemplatePath</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getTemplatePath</B>()</PRE> | |
<DL> | |
<DD>Get the path where Velocity will look | |
for templates using the file template | |
loader. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The template path.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setOutputDirectory(java.io.File)"><!-- --></A><H3> | |
setOutputDirectory</H3> | |
<PRE> | |
public void <B>setOutputDirectory</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> outputDirectory)</PRE> | |
<DL> | |
<DD>[REQUIRED] Set the output directory. It will be | |
created if it doesn't exist. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>outputDirectory</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getOutputDirectory()"><!-- --></A><H3> | |
getOutputDirectory</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOutputDirectory</B>()</PRE> | |
<DL> | |
<DD>Get the output directory. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The output directory.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setOutputFile(java.lang.String)"><!-- --></A><H3> | |
setOutputFile</H3> | |
<PRE> | |
public void <B>setOutputFile</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> outputFile)</PRE> | |
<DL> | |
<DD>[REQUIRED] Set the output file for the | |
generation process. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>outputFile</CODE> - </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.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> outputEncoding)</PRE> | |
<DL> | |
<DD>Set the output encoding. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>outputEncoding</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setInputEncoding(java.lang.String)"><!-- --></A><H3> | |
setInputEncoding</H3> | |
<PRE> | |
public void <B>setInputEncoding</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> inputEncoding)</PRE> | |
<DL> | |
<DD>Set the input (template) encoding. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>inputEncoding</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getOutputFile()"><!-- --></A><H3> | |
getOutputFile</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOutputFile</B>()</PRE> | |
<DL> | |
<DD>Get the output file for the | |
generation process. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The output file.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setLogFile(java.lang.String)"><!-- --></A><H3> | |
setLogFile</H3> | |
<PRE> | |
public void <B>setLogFile</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> log)</PRE> | |
<DL> | |
<DD>Sets the log file. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>log</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getLogFile()"><!-- --></A><H3> | |
getLogFile</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLogFile</B>()</PRE> | |
<DL> | |
<DD>Gets the log file. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The log file.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setContextProperties(java.lang.String)"><!-- --></A><H3> | |
setContextProperties</H3> | |
<PRE> | |
public void <B>setContextProperties</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> file)</PRE> | |
<DL> | |
<DD>Set the context properties that will be | |
fed into the initial context be the | |
generating process starts. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>file</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getContextProperties()"><!-- --></A><H3> | |
getContextProperties</H3> | |
<PRE> | |
public <A HREF="http://jakarta.apache.org/commons/collections/api-release/org/apache/commons/collections/ExtendedProperties.html?is-external=true" title="class or interface in org.apache.commons.collections">ExtendedProperties</A> <B>getContextProperties</B>()</PRE> | |
<DL> | |
<DD>Get the context properties that will be | |
fed into the initial context be the | |
generating process starts. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>The current context properties.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setUseClasspath(boolean)"><!-- --></A><H3> | |
setUseClasspath</H3> | |
<PRE> | |
public void <B>setUseClasspath</B>(boolean useClasspath)</PRE> | |
<DL> | |
<DD>Set the use of the classpath in locating templates | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>useClasspath</CODE> - true means the classpath will be used.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setUseResourceLoaderCache(java.lang.String)"><!-- --></A><H3> | |
setUseResourceLoaderCache</H3> | |
<PRE> | |
public void <B>setUseResourceLoaderCache</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> useResourceLoaderCache)</PRE> | |
<DL> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>useResourceLoaderCache</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setResourceLoaderModificationCheckInterval(java.lang.String)"><!-- --></A><H3> | |
setResourceLoaderModificationCheckInterval</H3> | |
<PRE> | |
public void <B>setResourceLoaderModificationCheckInterval</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> resourceLoaderModificationCheckInterval)</PRE> | |
<DL> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>resourceLoaderModificationCheckInterval</CODE> - </DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="initControlContext()"><!-- --></A><H3> | |
initControlContext</H3> | |
<PRE> | |
public <A HREF="../../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</A> <B>initControlContext</B>() | |
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> | |
<DL> | |
<DD>Creates a VelocityContext. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>new Context | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - the execute method will catch | |
and rethrow as a <code>BuildException</code></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="execute()"><!-- --></A><H3> | |
execute</H3> | |
<PRE> | |
public void <B>execute</B>() | |
throws org.apache.tools.ant.BuildException</PRE> | |
<DL> | |
<DD>Execute the input script with Velocity | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE>execute</CODE> in class <CODE>org.apache.tools.ant.Task</CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE>org.apache.tools.ant.BuildException</CODE> - BuildExceptions are thrown when required attributes are missing. | |
Exceptions thrown by Velocity are rethrown as BuildExceptions.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="populateInitialContext(org.apache.velocity.context.Context)"><!-- --></A><H3> | |
populateInitialContext</H3> | |
<PRE> | |
protected void <B>populateInitialContext</B>(<A HREF="../../../../../org/apache/velocity/context/Context.html" title="interface in org.apache.velocity.context">Context</A> context) | |
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> | |
<DL> | |
<DD><p>Place useful objects into the initial context.</p> | |
<p>TexenTask places <code>Date().toString()</code> into the | |
context as <code>$now</code>. Subclasses who want to vary the | |
objects in the context should override this method.</p> | |
<p><code>$generator</code> is not put into the context in this | |
method.</p> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>context</CODE> - The context to populate, as retrieved from | |
<A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#initControlContext()"><CODE>initControlContext()</CODE></A>. | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - Error while populating context. The <A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#execute()"><CODE>execute()</CODE></A> method will catch and rethrow as a | |
<code>BuildException</code>.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="cleanup()"><!-- --></A><H3> | |
cleanup</H3> | |
<PRE> | |
protected void <B>cleanup</B>() | |
throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> | |
<DL> | |
<DD>A hook method called at the end of <A HREF="../../../../../org/apache/velocity/texen/ant/TexenTask.html#execute()"><CODE>execute()</CODE></A> which can | |
be overridden to perform any necessary cleanup activities (such | |
as the release of database connections, etc.). By default, | |
does nothing. | |
<P> | |
<DD><DL> | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - Problem cleaning up.</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/TexenTask.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"> | |
PREV CLASS | |
NEXT CLASS</FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/velocity/texen/ant/TexenTask.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="TexenTask.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: NESTED | <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 © 2000-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
</BODY> | |
</HTML> |