source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 28.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:29 NZST 2007 -->
6<TITLE>
7ScriptDef (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.script.ScriptDef class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="ScriptDef (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html" title="class in org.apache.tools.ant.taskdefs.optional.script"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="ScriptDef.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.script</FONT>
85<BR>
86Class ScriptDef</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/AntlibDefinition.html" title="class in org.apache.tools.ant.taskdefs">org.apache.tools.ant.taskdefs.AntlibDefinition</A>
92 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html" title="class in org.apache.tools.ant.taskdefs">org.apache.tools.ant.taskdefs.DefBase</A>
93 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.script.ScriptDef</B>
94</PRE>
95<HR>
96<DL>
97<DT>public class <B>ScriptDef</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html" title="class in org.apache.tools.ant.taskdefs">DefBase</A></DL>
98
99<P>
100Define a task using a script
101<P>
102
103<P>
104<DL>
105<DT><B>Since:</B></DT>
106 <DD>Ant 1.6</DD>
107</DL>
108<HR>
109
110<P>
111<!-- ======== NESTED CLASS SUMMARY ======== -->
112
113<A NAME="nested_class_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TD COLSPAN=2><FONT SIZE="+2">
117<B>Nested Class Summary</B></FONT></TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<CODE>static&nbsp;class</CODE></FONT></TD>
122<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html" title="class in org.apache.tools.ant.taskdefs.optional.script">ScriptDef.Attribute</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class representing an attribute definition</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>static&nbsp;class</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.NestedElement.html" title="class in org.apache.tools.ant.taskdefs.optional.script">ScriptDef.NestedElement</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class to represent a nested element definition</TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- =========== FIELD SUMMARY =========== -->
138
139<A NAME="field_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TD COLSPAN=2><FONT SIZE="+2">
143<B>Field Summary</B></FONT></TD>
144</TR>
145</TABLE>
146&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
149<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
153</TR>
154</TABLE>
155&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
158<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ======== CONSTRUCTOR SUMMARY ======== -->
166
167<A NAME="constructor_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TD COLSPAN=2><FONT SIZE="+2">
171<B>Constructor Summary</B></FONT></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#ScriptDef()">ScriptDef</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
178</TR>
179</TABLE>
180&nbsp;
181<!-- ========== METHOD SUMMARY =========== -->
182
183<A NAME="method_summary"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TD COLSPAN=2><FONT SIZE="+2">
187<B>Method Summary</B></FONT></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;void</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#addAttribute(org.apache.tools.ant.taskdefs.optional.script.ScriptDef.Attribute)">addAttribute</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html" title="class in org.apache.tools.ant.taskdefs.optional.script">ScriptDef.Attribute</A>&nbsp;attribute)</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an attribute definition to this script.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#addElement(org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement)">addElement</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.NestedElement.html" title="class in org.apache.tools.ant.taskdefs.optional.script">ScriptDef.NestedElement</A>&nbsp;nestedElement)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a nested element definition.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#addText(java.lang.String)">addText</A></B>(java.lang.String&nbsp;text)</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the script text.</TD>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#createNestedElement(java.lang.String)">createNestedElement</A></B>(java.lang.String&nbsp;elementName)</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a nested element to be configured.</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;void</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#execute()">execute</A></B>()</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Define the script.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#executeScript(java.util.Map, java.util.Map)">executeScript</A></B>(java.util.Map&nbsp;attributes,
233 java.util.Map&nbsp;elements)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the script.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;boolean</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#isAttributeSupported(java.lang.String)">isAttributeSupported</A></B>(java.lang.String&nbsp;attributeName)</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the task supports a given attribute name</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String&nbsp;language)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines the language (required).</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the name under which this script will be activated in a build
261 file</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;void</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html#setSrc(java.io.File)">setSrc</A></B>(java.io.File&nbsp;file)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Load the script from an external file ; optional.</TD>
270</TR>
271</TABLE>
272&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.DefBase"><!-- --></A>
273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
274<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
275<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html" title="class in org.apache.tools.ant.taskdefs">DefBase</A></B></TD>
276</TR>
277<TR BGCOLOR="white" CLASS="TableRowColor">
278<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#createClasspath()">createClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#createLoader()">createLoader</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#getClasspath()">getClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#getClasspathId()">getClasspathId</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#getLoaderId()">getLoaderId</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#init()">init</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#isReverseLoader()">isReverseLoader</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#setLoaderRef(org.apache.tools.ant.types.Reference)">setLoaderRef</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/DefBase.html#setReverseLoader(boolean)">setReverseLoader</A></CODE></TD>
279</TR>
280</TABLE>
281&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.AntlibDefinition"><!-- --></A>
282<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
283<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
284<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/AntlibDefinition.html" title="class in org.apache.tools.ant.taskdefs">AntlibDefinition</A></B></TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/AntlibDefinition.html#getAntlibClassLoader()">getAntlibClassLoader</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/AntlibDefinition.html#getURI()">getURI</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/AntlibDefinition.html#setAntlibClassLoader(java.lang.ClassLoader)">setAntlibClassLoader</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/AntlibDefinition.html#setURI(java.lang.String)">setURI</A></CODE></TD>
288</TR>
289</TABLE>
290&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
291<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
292<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
293<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
297</TR>
298</TABLE>
299&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
300<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
302<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
303</TR>
304<TR BGCOLOR="white" CLASS="TableRowColor">
305<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
306</TR>
307</TABLE>
308&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
311<TD><B>Methods inherited from class java.lang.Object</B></TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
315</TR>
316</TABLE>
317&nbsp;
318<P>
319
320<!-- ============ FIELD DETAIL =========== -->
321
322
323<!-- ========= CONSTRUCTOR DETAIL ======== -->
324
325<A NAME="constructor_detail"><!-- --></A>
326<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
327<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
328<TD COLSPAN=1><FONT SIZE="+2">
329<B>Constructor Detail</B></FONT></TD>
330</TR>
331</TABLE>
332
333<A NAME="ScriptDef()"><!-- --></A><H3>
334ScriptDef</H3>
335<PRE>
336public <B>ScriptDef</B>()</PRE>
337<DL>
338</DL>
339
340<!-- ============ METHOD DETAIL ========== -->
341
342<A NAME="method_detail"><!-- --></A>
343<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
344<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
345<TD COLSPAN=1><FONT SIZE="+2">
346<B>Method Detail</B></FONT></TD>
347</TR>
348</TABLE>
349
350<A NAME="setName(java.lang.String)"><!-- --></A><H3>
351setName</H3>
352<PRE>
353public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
354<DL>
355<DD>set the name under which this script will be activated in a build
356 file
357<P>
358<DD><DL>
359<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the script</DL>
360</DD>
361</DL>
362<HR>
363
364<A NAME="isAttributeSupported(java.lang.String)"><!-- --></A><H3>
365isAttributeSupported</H3>
366<PRE>
367public boolean <B>isAttributeSupported</B>(java.lang.String&nbsp;attributeName)</PRE>
368<DL>
369<DD>Indicates whether the task supports a given attribute name
370<P>
371<DD><DL>
372<DT><B>Parameters:</B><DD><CODE>attributeName</CODE> - the name of the attribute.
373<DT><B>Returns:</B><DD>true if the attribute is supported by the script.</DL>
374</DD>
375</DL>
376<HR>
377
378<A NAME="addAttribute(org.apache.tools.ant.taskdefs.optional.script.ScriptDef.Attribute)"><!-- --></A><H3>
379addAttribute</H3>
380<PRE>
381public void <B>addAttribute</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html" title="class in org.apache.tools.ant.taskdefs.optional.script">ScriptDef.Attribute</A>&nbsp;attribute)</PRE>
382<DL>
383<DD>Add an attribute definition to this script.
384<P>
385<DD><DL>
386<DT><B>Parameters:</B><DD><CODE>attribute</CODE> - the attribute definition.</DL>
387</DD>
388</DL>
389<HR>
390
391<A NAME="addElement(org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement)"><!-- --></A><H3>
392addElement</H3>
393<PRE>
394public void <B>addElement</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.NestedElement.html" title="class in org.apache.tools.ant.taskdefs.optional.script">ScriptDef.NestedElement</A>&nbsp;nestedElement)</PRE>
395<DL>
396<DD>Add a nested element definition.
397<P>
398<DD><DL>
399<DT><B>Parameters:</B><DD><CODE>nestedElement</CODE> - the nested element definition.</DL>
400</DD>
401</DL>
402<HR>
403
404<A NAME="execute()"><!-- --></A><H3>
405execute</H3>
406<PRE>
407public void <B>execute</B>()</PRE>
408<DL>
409<DD>Define the script.
410<P>
411<DD><DL>
412<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
413</DD>
414<DD><DL>
415</DL>
416</DD>
417</DL>
418<HR>
419
420<A NAME="createNestedElement(java.lang.String)"><!-- --></A><H3>
421createNestedElement</H3>
422<PRE>
423public java.lang.Object <B>createNestedElement</B>(java.lang.String&nbsp;elementName)</PRE>
424<DL>
425<DD>Create a nested element to be configured.
426<P>
427<DD><DL>
428<DT><B>Parameters:</B><DD><CODE>elementName</CODE> - the name of the nested element.
429<DT><B>Returns:</B><DD>object representing the element name.</DL>
430</DD>
431</DL>
432<HR>
433
434<A NAME="executeScript(java.util.Map, java.util.Map)"><!-- --></A><H3>
435executeScript</H3>
436<PRE>
437public void <B>executeScript</B>(java.util.Map&nbsp;attributes,
438 java.util.Map&nbsp;elements)</PRE>
439<DL>
440<DD>Execute the script.
441<P>
442<DD><DL>
443<DT><B>Parameters:</B><DD><CODE>attributes</CODE> - collection of attributes<DD><CODE>elements</CODE> - a list of nested element values.</DL>
444</DD>
445</DL>
446<HR>
447
448<A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
449setLanguage</H3>
450<PRE>
451public void <B>setLanguage</B>(java.lang.String&nbsp;language)</PRE>
452<DL>
453<DD>Defines the language (required).
454<P>
455<DD><DL>
456<DT><B>Parameters:</B><DD><CODE>language</CODE> - the scripting language name for the script.</DL>
457</DD>
458</DL>
459<HR>
460
461<A NAME="setSrc(java.io.File)"><!-- --></A><H3>
462setSrc</H3>
463<PRE>
464public void <B>setSrc</B>(java.io.File&nbsp;file)</PRE>
465<DL>
466<DD>Load the script from an external file ; optional.
467<P>
468<DD><DL>
469<DT><B>Parameters:</B><DD><CODE>file</CODE> - the file containing the script source.</DL>
470</DD>
471</DL>
472<HR>
473
474<A NAME="addText(java.lang.String)"><!-- --></A><H3>
475addText</H3>
476<PRE>
477public void <B>addText</B>(java.lang.String&nbsp;text)</PRE>
478<DL>
479<DD>Set the script text.
480<P>
481<DD><DL>
482<DT><B>Parameters:</B><DD><CODE>text</CODE> - a component of the script text to be added.</DL>
483</DD>
484</DL>
485<!-- ========= END OF CLASS DATA ========= -->
486<HR>
487
488
489<!-- ======= START OF BOTTOM NAVBAR ====== -->
490<A NAME="navbar_bottom"><!-- --></A>
491<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
492<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
493<TR>
494<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
495<A NAME="navbar_bottom_firstrow"><!-- --></A>
496<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
497 <TR ALIGN="center" VALIGN="top">
498 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
499 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
500 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
501 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
502 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
503 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
504 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
505 </TR>
506</TABLE>
507</TD>
508<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
509</EM>
510</TD>
511</TR>
512
513<TR>
514<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
515&nbsp;PREV CLASS&nbsp;
516&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html" title="class in org.apache.tools.ant.taskdefs.optional.script"><B>NEXT CLASS</B></A></FONT></TD>
517<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
518 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
519&nbsp;<A HREF="ScriptDef.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
520&nbsp;<SCRIPT type="text/javascript">
521 <!--
522 if(window==top) {
523 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
524 }
525 //-->
526</SCRIPT>
527<NOSCRIPT>
528 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
529</NOSCRIPT>
530
531</FONT></TD>
532</TR>
533<TR>
534<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
535 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
536<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
537DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
538</TR>
539</TABLE>
540<A NAME="skip-navbar_bottom"></A>
541<!-- ======== END OF BOTTOM NAVBAR ======= -->
542
543<HR>
544Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
545</BODY>
546</HTML>
Note: See TracBrowser for help on using the repository browser.