Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\util\ScriptRunnerBase.html
<!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_22) on Mon Feb 01 19:36:00 EST 2010 --> <TITLE> ScriptRunnerBase (Apache Ant API) </TITLE> <META NAME="keywords" CONTENT="org.apache.tools.ant.util.ScriptRunnerBase class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="ScriptRunnerBase (Apache Ant 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="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/tools/ant/util/ScriptRunner.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerCreator.html" title="class in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/tools/ant/util/ScriptRunnerBase.html" target="_top"><B>FRAMES</B></A> <A HREF="ScriptRunnerBase.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <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.tools.ant.util</FONT> <BR> Class ScriptRunnerBase</H2> <PRE> java.lang.Object <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.tools.ant.util.ScriptRunnerBase</B> </PRE> <DL> <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/util/optional/JavaxScriptRunner.html" title="class in org.apache.tools.ant.util.optional">JavaxScriptRunner</A>, <A HREF="../../../../../org/apache/tools/ant/util/optional/ScriptRunner.html" title="class in org.apache.tools.ant.util.optional">ScriptRunner</A></DD> </DL> <HR> <DL> <DT><PRE>public abstract class <B>ScriptRunnerBase</B><DT>extends java.lang.Object</DL> </PRE> <P> This is a common abstract base case for script runners. These classes need to implement executeScript, evaluateScript and supportsLanguage. <P> <P> <DL> <DT><B>Since:</B></DT> <DD>Ant 1.7.0</DD> </DL> <HR> <P> <!-- ======== 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/tools/ant/util/ScriptRunnerBase.html#ScriptRunnerBase()">ScriptRunnerBase</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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#addBean(java.lang.String, java.lang.Object)">addBean</A></B>(java.lang.String key, java.lang.Object bean)</CODE> <BR> Add a single object into the script 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/tools/ant/util/ScriptRunnerBase.html#addBeans(java.util.Map)">addBeans</A></B>(java.util.Map dictionary)</CODE> <BR> Add a list of named objects to the list to be exported to the script</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/tools/ant/util/ScriptRunnerBase.html#addText(java.lang.String)">addText</A></B>(java.lang.String text)</CODE> <BR> Set the script text.</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/tools/ant/util/ScriptRunnerBase.html#bindToComponent(org.apache.tools.ant.ProjectComponent)">bindToComponent</A></B>(<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A> component)</CODE> <BR> Bind the runner to a project component.</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/tools/ant/util/ScriptRunnerBase.html#bindToComponentMinimum(org.apache.tools.ant.ProjectComponent)">bindToComponentMinimum</A></B>(<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A> component)</CODE> <BR> Bind the runner to a project component.</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/tools/ant/util/ScriptRunnerBase.html#checkLanguage()">checkLanguage</A></B>()</CODE> <BR> Check if the language attribute is set.</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/tools/ant/util/ScriptRunnerBase.html#clearScript()">clearScript</A></B>()</CODE> <BR> Clear the current script text content.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract java.lang.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#evaluateScript(java.lang.String)">evaluateScript</A></B>(java.lang.String execName)</CODE> <BR> Evaluate the script.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#executeScript(java.lang.String)">executeScript</A></B>(java.lang.String execName)</CODE> <BR> Do the work.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.util.Map</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getBeans()">getBeans</A></B>()</CODE> <BR> Get the beans used for the script.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getKeepEngine()">getKeepEngine</A></B>()</CODE> <BR> Get the keep engine attribute.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getLanguage()">getLanguage</A></B>()</CODE> <BR> Get the script language</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getManagerName()">getManagerName</A></B>()</CODE> <BR> Get the name of the manager prefix used for this scriptrunner.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getProject()">getProject</A></B>()</CODE> <BR> Get the project for this runner.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getScript()">getScript</A></B>()</CODE> <BR> Get the current script text content.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.ClassLoader</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#getScriptClassLoader()">getScriptClassLoader</A></B>()</CODE> <BR> Get the classloader used to load the script engine.</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/tools/ant/util/ScriptRunnerBase.html#loadResource(org.apache.tools.ant.types.Resource)">loadResource</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> sourceResource)</CODE> <BR> Add a resource to the source list.</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/tools/ant/util/ScriptRunnerBase.html#loadResources(org.apache.tools.ant.types.ResourceCollection)">loadResources</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/ResourceCollection.html" title="interface in org.apache.tools.ant.types">ResourceCollection</A> collection)</CODE> <BR> Add all resources in a resource collection to the source list.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected java.lang.ClassLoader</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#replaceContextLoader()">replaceContextLoader</A></B>()</CODE> <BR> Replace the current context classloader with the script context classloader.</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/tools/ant/util/ScriptRunnerBase.html#restoreContextLoader(java.lang.ClassLoader)">restoreContextLoader</A></B>(java.lang.ClassLoader origLoader)</CODE> <BR> Restore the context loader with the original context classloader.</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/tools/ant/util/ScriptRunnerBase.html#setKeepEngine(boolean)">setKeepEngine</A></B>(boolean keepEngine)</CODE> <BR> Whether to keep the script engine between calls.</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/tools/ant/util/ScriptRunnerBase.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String language)</CODE> <BR> Defines the language (required).</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/tools/ant/util/ScriptRunnerBase.html#setProject(org.apache.tools.ant.Project)">setProject</A></B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project)</CODE> <BR> Set the project for this runner.</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/tools/ant/util/ScriptRunnerBase.html#setScriptClassLoader(java.lang.ClassLoader)">setScriptClassLoader</A></B>(java.lang.ClassLoader classLoader)</CODE> <BR> Set the script classloader.</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/tools/ant/util/ScriptRunnerBase.html#setSrc(java.io.File)">setSrc</A></B>(java.io.File file)</CODE> <BR> Load the script from an external file; optional.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>abstract boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerBase.html#supportsLanguage()">supportsLanguage</A></B>()</CODE> <BR> Check if a script engine can be created for this language.</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.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ========= 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="ScriptRunnerBase()"><!-- --></A><H3> ScriptRunnerBase</H3> <PRE> public <B>ScriptRunnerBase</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="addBeans(java.util.Map)"><!-- --></A><H3> addBeans</H3> <PRE> public void <B>addBeans</B>(java.util.Map dictionary)</PRE> <DL> <DD>Add a list of named objects to the list to be exported to the script <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>dictionary</CODE> - a map of objects to be placed into the script context indexed by String names.</DL> </DD> </DL> <HR> <A NAME="addBean(java.lang.String, java.lang.Object)"><!-- --></A><H3> addBean</H3> <PRE> public void <B>addBean</B>(java.lang.String key, java.lang.Object bean)</PRE> <DL> <DD>Add a single object into the script context. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>key</CODE> - the name in the context this object is to stored under.<DD><CODE>bean</CODE> - the object to be stored in the script context.</DL> </DD> </DL> <HR> <A NAME="getBeans()"><!-- --></A><H3> getBeans</H3> <PRE> protected java.util.Map <B>getBeans</B>()</PRE> <DL> <DD>Get the beans used for the script. <P> <DD><DL> <DT><B>Returns:</B><DD>the map of beans.</DL> </DD> </DL> <HR> <A NAME="executeScript(java.lang.String)"><!-- --></A><H3> executeScript</H3> <PRE> public abstract void <B>executeScript</B>(java.lang.String execName)</PRE> <DL> <DD>Do the work. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>execName</CODE> - the name that will be passed to BSF for this script execution.</DL> </DD> </DL> <HR> <A NAME="evaluateScript(java.lang.String)"><!-- --></A><H3> evaluateScript</H3> <PRE> public abstract java.lang.Object <B>evaluateScript</B>(java.lang.String execName)</PRE> <DL> <DD>Evaluate the script. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>execName</CODE> - the name that will be passed to the scripting engine for this script execution. <DT><B>Returns:</B><DD>the result of evaluating the script.</DL> </DD> </DL> <HR> <A NAME="supportsLanguage()"><!-- --></A><H3> supportsLanguage</H3> <PRE> public abstract boolean <B>supportsLanguage</B>()</PRE> <DL> <DD>Check if a script engine can be created for this language. <P> <DD><DL> <DT><B>Returns:</B><DD>true if a script engine can be created, false otherwise.</DL> </DD> </DL> <HR> <A NAME="getManagerName()"><!-- --></A><H3> getManagerName</H3> <PRE> public abstract java.lang.String <B>getManagerName</B>()</PRE> <DL> <DD>Get the name of the manager prefix used for this scriptrunner. <P> <DD><DL> <DT><B>Returns:</B><DD>the prefix string.</DL> </DD> </DL> <HR> <A NAME="setLanguage(java.lang.String)"><!-- --></A><H3> setLanguage</H3> <PRE> public void <B>setLanguage</B>(java.lang.String language)</PRE> <DL> <DD>Defines the language (required). <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>language</CODE> - the scripting language name for the script.</DL> </DD> </DL> <HR> <A NAME="getLanguage()"><!-- --></A><H3> getLanguage</H3> <PRE> public java.lang.String <B>getLanguage</B>()</PRE> <DL> <DD>Get the script language <P> <DD><DL> <DT><B>Returns:</B><DD>the script language</DL> </DD> </DL> <HR> <A NAME="setScriptClassLoader(java.lang.ClassLoader)"><!-- --></A><H3> setScriptClassLoader</H3> <PRE> public void <B>setScriptClassLoader</B>(java.lang.ClassLoader classLoader)</PRE> <DL> <DD>Set the script classloader. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>classLoader</CODE> - the classloader to use.</DL> </DD> </DL> <HR> <A NAME="getScriptClassLoader()"><!-- --></A><H3> getScriptClassLoader</H3> <PRE> protected java.lang.ClassLoader <B>getScriptClassLoader</B>()</PRE> <DL> <DD>Get the classloader used to load the script engine. <P> <DD><DL> <DT><B>Returns:</B><DD>the classloader.</DL> </DD> </DL> <HR> <A NAME="setKeepEngine(boolean)"><!-- --></A><H3> setKeepEngine</H3> <PRE> public void <B>setKeepEngine</B>(boolean keepEngine)</PRE> <DL> <DD>Whether to keep the script engine between calls. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>keepEngine</CODE> - if true, keep the engine.</DL> </DD> </DL> <HR> <A NAME="getKeepEngine()"><!-- --></A><H3> getKeepEngine</H3> <PRE> public boolean <B>getKeepEngine</B>()</PRE> <DL> <DD>Get the keep engine attribute. <P> <DD><DL> <DT><B>Returns:</B><DD>the attribute.</DL> </DD> </DL> <HR> <A NAME="setSrc(java.io.File)"><!-- --></A><H3> setSrc</H3> <PRE> public void <B>setSrc</B>(java.io.File file)</PRE> <DL> <DD>Load the script from an external file; optional. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>file</CODE> - the file containing the script source.</DL> </DD> </DL> <HR> <A NAME="loadResource(org.apache.tools.ant.types.Resource)"><!-- --></A><H3> loadResource</H3> <PRE> public void <B>loadResource</B>(<A HREF="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</A> sourceResource)</PRE> <DL> <DD>Add a resource to the source list. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>sourceResource</CODE> - the resource to load <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the resource cannot be read<DT><B>Since:</B></DT> <DD>Ant 1.7.1</DD> </DL> </DD> </DL> <HR> <A NAME="loadResources(org.apache.tools.ant.types.ResourceCollection)"><!-- --></A><H3> loadResources</H3> <PRE> public void <B>loadResources</B>(<A HREF="../../../../../org/apache/tools/ant/types/ResourceCollection.html" title="interface in org.apache.tools.ant.types">ResourceCollection</A> collection)</PRE> <DL> <DD>Add all resources in a resource collection to the source list. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>collection</CODE> - the resource to load <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if a resource cannot be read<DT><B>Since:</B></DT> <DD>Ant 1.7.1</DD> </DL> </DD> </DL> <HR> <A NAME="addText(java.lang.String)"><!-- --></A><H3> addText</H3> <PRE> public void <B>addText</B>(java.lang.String text)</PRE> <DL> <DD>Set the script text. Properties in the text are not expanded! <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>text</CODE> - a component of the script text to be added.</DL> </DD> </DL> <HR> <A NAME="getScript()"><!-- --></A><H3> getScript</H3> <PRE> public java.lang.String <B>getScript</B>()</PRE> <DL> <DD>Get the current script text content. <P> <DD><DL> <DT><B>Returns:</B><DD>the script text.</DL> </DD> </DL> <HR> <A NAME="clearScript()"><!-- --></A><H3> clearScript</H3> <PRE> public void <B>clearScript</B>()</PRE> <DL> <DD>Clear the current script text content. <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setProject(org.apache.tools.ant.Project)"><!-- --></A><H3> setProject</H3> <PRE> public void <B>setProject</B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> project)</PRE> <DL> <DD>Set the project for this runner. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>project</CODE> - the project.</DL> </DD> </DL> <HR> <A NAME="getProject()"><!-- --></A><H3> getProject</H3> <PRE> public <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> <B>getProject</B>()</PRE> <DL> <DD>Get the project for this runner. <P> <DD><DL> <DT><B>Returns:</B><DD>the project.</DL> </DD> </DL> <HR> <A NAME="bindToComponent(org.apache.tools.ant.ProjectComponent)"><!-- --></A><H3> bindToComponent</H3> <PRE> public void <B>bindToComponent</B>(<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A> component)</PRE> <DL> <DD>Bind the runner to a project component. Properties, targets and references are all added as beans; project is bound to project, and self to the component. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>component</CODE> - to become <code>self</code></DL> </DD> </DL> <HR> <A NAME="bindToComponentMinimum(org.apache.tools.ant.ProjectComponent)"><!-- --></A><H3> bindToComponentMinimum</H3> <PRE> public void <B>bindToComponentMinimum</B>(<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A> component)</PRE> <DL> <DD>Bind the runner to a project component. The project and self are the only beans set. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>component</CODE> - to become <code>self</code></DL> </DD> </DL> <HR> <A NAME="checkLanguage()"><!-- --></A><H3> checkLanguage</H3> <PRE> protected void <B>checkLanguage</B>()</PRE> <DL> <DD>Check if the language attribute is set. <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if it is not.</DL> </DD> </DL> <HR> <A NAME="replaceContextLoader()"><!-- --></A><H3> replaceContextLoader</H3> <PRE> protected java.lang.ClassLoader <B>replaceContextLoader</B>()</PRE> <DL> <DD>Replace the current context classloader with the script context classloader. <P> <DD><DL> <DT><B>Returns:</B><DD>the current context classloader.</DL> </DD> </DL> <HR> <A NAME="restoreContextLoader(java.lang.ClassLoader)"><!-- --></A><H3> restoreContextLoader</H3> <PRE> protected void <B>restoreContextLoader</B>(java.lang.ClassLoader origLoader)</PRE> <DL> <DD>Restore the context loader with the original context classloader. script context loader. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>origLoader</CODE> - the original context classloader.</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="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/tools/ant/util/ScriptRunner.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/tools/ant/util/ScriptRunnerCreator.html" title="class in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/tools/ant/util/ScriptRunnerBase.html" target="_top"><B>FRAMES</B></A> <A HREF="ScriptRunnerBase.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <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> </BODY> </HTML>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de