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:18 NZST 2007 -->
|
---|
6 | <TITLE>
|
---|
7 | ExecTask (Apache Ant API)
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.ExecTask class">
|
---|
11 |
|
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
---|
13 |
|
---|
14 | <SCRIPT type="text/javascript">
|
---|
15 | function windowTitle()
|
---|
16 | {
|
---|
17 | parent.document.title="ExecTask (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> </TD>
|
---|
36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Exec.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
|
---|
53 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs"><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>
|
---|
56 | <A HREF="ExecTask.html" target="_top"><B>NO FRAMES</B></A>
|
---|
57 | <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
74 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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">
|
---|
84 | org.apache.tools.ant.taskdefs</FONT>
|
---|
85 | <BR>
|
---|
86 | Class ExecTask</H2>
|
---|
87 | <PRE>
|
---|
88 | java.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"><B>org.apache.tools.ant.taskdefs.ExecTask</B>
|
---|
92 | </PRE>
|
---|
93 | <DL>
|
---|
94 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteOn.html" title="class in org.apache.tools.ant.taskdefs">ExecuteOn</A></DD>
|
---|
95 | </DL>
|
---|
96 | <HR>
|
---|
97 | <DL>
|
---|
98 | <DT>public class <B>ExecTask</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
|
---|
99 |
|
---|
100 | <P>
|
---|
101 | Executes a given command if the os platform is appropriate.
|
---|
102 | <P>
|
---|
103 |
|
---|
104 | <P>
|
---|
105 | <DL>
|
---|
106 | <DT><B>Since:</B></DT>
|
---|
107 | <DD>Ant 1.2</DD>
|
---|
108 | </DL>
|
---|
109 | <HR>
|
---|
110 |
|
---|
111 | <P>
|
---|
112 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
113 |
|
---|
114 |
|
---|
115 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
116 |
|
---|
117 | <A NAME="field_summary"><!-- --></A>
|
---|
118 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
119 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
120 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
121 | <B>Field Summary</B></FONT></TD>
|
---|
122 | </TR>
|
---|
123 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
124 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
125 | <CODE>protected <A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A></CODE></FONT></TD>
|
---|
126 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#cmdl">cmdl</A></B></CODE>
|
---|
127 |
|
---|
128 | <BR>
|
---|
129 | </TD>
|
---|
130 | </TR>
|
---|
131 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
132 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
133 | <CODE>protected boolean</CODE></FONT></TD>
|
---|
134 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#failOnError">failOnError</A></B></CODE>
|
---|
135 |
|
---|
136 | <BR>
|
---|
137 | </TD>
|
---|
138 | </TR>
|
---|
139 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
140 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
141 | <CODE>protected boolean</CODE></FONT></TD>
|
---|
142 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#newEnvironment">newEnvironment</A></B></CODE>
|
---|
143 |
|
---|
144 | <BR>
|
---|
145 | </TD>
|
---|
146 | </TR>
|
---|
147 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
148 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
149 | <CODE>protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/Redirector.html" title="class in org.apache.tools.ant.taskdefs">Redirector</A></CODE></FONT></TD>
|
---|
150 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#redirector">redirector</A></B></CODE>
|
---|
151 |
|
---|
152 | <BR>
|
---|
153 | </TD>
|
---|
154 | </TR>
|
---|
155 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
156 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
157 | <CODE>protected <A HREF="../../../../../org/apache/tools/ant/types/RedirectorElement.html" title="class in org.apache.tools.ant.types">RedirectorElement</A></CODE></FONT></TD>
|
---|
158 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#redirectorElement">redirectorElement</A></B></CODE>
|
---|
159 |
|
---|
160 | <BR>
|
---|
161 | </TD>
|
---|
162 | </TR>
|
---|
163 | </TABLE>
|
---|
164 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
|
---|
165 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
166 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
167 | <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>
|
---|
168 | </TR>
|
---|
169 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
170 | <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>
|
---|
171 | </TR>
|
---|
172 | </TABLE>
|
---|
173 | <A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
|
---|
174 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
175 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
176 | <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>
|
---|
177 | </TR>
|
---|
178 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
179 | <TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
|
---|
180 | </TR>
|
---|
181 | </TABLE>
|
---|
182 |
|
---|
183 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
184 |
|
---|
185 | <A NAME="constructor_summary"><!-- --></A>
|
---|
186 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
187 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
188 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
189 | <B>Constructor Summary</B></FONT></TD>
|
---|
190 | </TR>
|
---|
191 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
192 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#ExecTask()">ExecTask</A></B>()</CODE>
|
---|
193 |
|
---|
194 | <BR>
|
---|
195 | </TD>
|
---|
196 | </TR>
|
---|
197 | </TABLE>
|
---|
198 |
|
---|
199 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
200 |
|
---|
201 | <A NAME="method_summary"><!-- --></A>
|
---|
202 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
203 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
204 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
205 | <B>Method Summary</B></FONT></TD>
|
---|
206 | </TR>
|
---|
207 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
208 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
209 | <CODE> void</CODE></FONT></TD>
|
---|
210 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#addConfiguredRedirector(org.apache.tools.ant.types.RedirectorElement)">addConfiguredRedirector</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/RedirectorElement.html" title="class in org.apache.tools.ant.types">RedirectorElement</A> redirectorElement)</CODE>
|
---|
211 |
|
---|
212 | <BR>
|
---|
213 | Add a <code>RedirectorElement</code> to this task.</TD>
|
---|
214 | </TR>
|
---|
215 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
216 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
217 | <CODE> void</CODE></FONT></TD>
|
---|
218 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#addEnv(org.apache.tools.ant.types.Environment.Variable)">addEnv</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types">Environment.Variable</A> var)</CODE>
|
---|
219 |
|
---|
220 | <BR>
|
---|
221 | Add an environment variable to the launched process.</TD>
|
---|
222 | </TR>
|
---|
223 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
224 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
225 | <CODE>protected void</CODE></FONT></TD>
|
---|
226 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#checkConfiguration()">checkConfiguration</A></B>()</CODE>
|
---|
227 |
|
---|
228 | <BR>
|
---|
229 | Has the user set all necessary attributes?</TD>
|
---|
230 | </TR>
|
---|
231 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
232 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
233 | <CODE> <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A></CODE></FONT></TD>
|
---|
234 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#createArg()">createArg</A></B>()</CODE>
|
---|
235 |
|
---|
236 | <BR>
|
---|
237 | Adds a command-line argument.</TD>
|
---|
238 | </TR>
|
---|
239 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
240 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
241 | <CODE>protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A></CODE></FONT></TD>
|
---|
242 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#createHandler()">createHandler</A></B>()</CODE>
|
---|
243 |
|
---|
244 | <BR>
|
---|
245 | Create the StreamHandler to use with our Execute instance.</TD>
|
---|
246 | </TR>
|
---|
247 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
248 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
249 | <CODE>protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteWatchdog.html" title="class in org.apache.tools.ant.taskdefs">ExecuteWatchdog</A></CODE></FONT></TD>
|
---|
250 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#createWatchdog()">createWatchdog</A></B>()</CODE>
|
---|
251 |
|
---|
252 | <BR>
|
---|
253 | Create the Watchdog to kill a runaway process.</TD>
|
---|
254 | </TR>
|
---|
255 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
256 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
257 | <CODE> void</CODE></FONT></TD>
|
---|
258 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#execute()">execute</A></B>()</CODE>
|
---|
259 |
|
---|
260 | <BR>
|
---|
261 | Do the work.</TD>
|
---|
262 | </TR>
|
---|
263 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
264 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
265 | <CODE> boolean</CODE></FONT></TD>
|
---|
266 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#getResolveExecutable()">getResolveExecutable</A></B>()</CODE>
|
---|
267 |
|
---|
268 | <BR>
|
---|
269 | Indicates whether to attempt to resolve the executable to a
|
---|
270 | file.</TD>
|
---|
271 | </TR>
|
---|
272 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
273 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
274 | <CODE>protected boolean</CODE></FONT></TD>
|
---|
275 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#isValidOs()">isValidOs</A></B>()</CODE>
|
---|
276 |
|
---|
277 | <BR>
|
---|
278 | Is this the OS the user wanted?</TD>
|
---|
279 | </TR>
|
---|
280 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
281 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
282 | <CODE>protected void</CODE></FONT></TD>
|
---|
283 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#logFlush()">logFlush</A></B>()</CODE>
|
---|
284 |
|
---|
285 | <BR>
|
---|
286 | Flush the output stream - if there is one.</TD>
|
---|
287 | </TR>
|
---|
288 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
289 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
290 | <CODE>protected void</CODE></FONT></TD>
|
---|
291 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#maybeSetResultPropertyValue(int)">maybeSetResultPropertyValue</A></B>(int result)</CODE>
|
---|
292 |
|
---|
293 | <BR>
|
---|
294 | Helper method to set result property to the
|
---|
295 | passed in value if appropriate.</TD>
|
---|
296 | </TR>
|
---|
297 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
298 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
299 | <CODE>protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs">Execute</A></CODE></FONT></TD>
|
---|
300 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#prepareExec()">prepareExec</A></B>()</CODE>
|
---|
301 |
|
---|
302 | <BR>
|
---|
303 | Create an Execute instance with the correct working directory set.</TD>
|
---|
304 | </TR>
|
---|
305 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
306 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
307 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
308 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#resolveExecutable(java.lang.String, boolean)">resolveExecutable</A></B>(java.lang.String exec,
|
---|
309 | boolean mustSearchPath)</CODE>
|
---|
310 |
|
---|
311 | <BR>
|
---|
312 | The method attempts to figure out where the executable is so that we can feed
|
---|
313 | the full path.</TD>
|
---|
314 | </TR>
|
---|
315 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
316 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
317 | <CODE>protected void</CODE></FONT></TD>
|
---|
318 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#runExec(org.apache.tools.ant.taskdefs.Execute)">runExec</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs">Execute</A> exe)</CODE>
|
---|
319 |
|
---|
320 | <BR>
|
---|
321 | Run the command using the given Execute instance.</TD>
|
---|
322 | </TR>
|
---|
323 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
324 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
325 | <CODE>protected void</CODE></FONT></TD>
|
---|
326 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#runExecute(org.apache.tools.ant.taskdefs.Execute)">runExecute</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs">Execute</A> exe)</CODE>
|
---|
327 |
|
---|
328 | <BR>
|
---|
329 | A Utility method for this classes and subclasses to run an
|
---|
330 | Execute instance (an external command).</TD>
|
---|
331 | </TR>
|
---|
332 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
333 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
334 | <CODE> void</CODE></FONT></TD>
|
---|
335 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setAppend(boolean)">setAppend</A></B>(boolean append)</CODE>
|
---|
336 |
|
---|
337 | <BR>
|
---|
338 | Set whether output should be appended to or overwrite an existing file.</TD>
|
---|
339 | </TR>
|
---|
340 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
341 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
342 | <CODE> void</CODE></FONT></TD>
|
---|
343 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setCommand(org.apache.tools.ant.types.Commandline)">setCommand</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> cmdl)</CODE>
|
---|
344 |
|
---|
345 | <BR>
|
---|
346 | Sets a command line.</TD>
|
---|
347 | </TR>
|
---|
348 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
349 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
350 | <CODE> void</CODE></FONT></TD>
|
---|
351 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setDir(java.io.File)">setDir</A></B>(java.io.File d)</CODE>
|
---|
352 |
|
---|
353 | <BR>
|
---|
354 | Set the working directory of the process.</TD>
|
---|
355 | </TR>
|
---|
356 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
357 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
358 | <CODE> void</CODE></FONT></TD>
|
---|
359 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setError(java.io.File)">setError</A></B>(java.io.File error)</CODE>
|
---|
360 |
|
---|
361 | <BR>
|
---|
362 | Set the File to which the error stream of the process should be redirected.</TD>
|
---|
363 | </TR>
|
---|
364 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
365 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
366 | <CODE> void</CODE></FONT></TD>
|
---|
367 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setErrorProperty(java.lang.String)">setErrorProperty</A></B>(java.lang.String errorProperty)</CODE>
|
---|
368 |
|
---|
369 | <BR>
|
---|
370 | Sets the name of the property whose value should be set to the error of
|
---|
371 | the process.</TD>
|
---|
372 | </TR>
|
---|
373 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
374 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
375 | <CODE> void</CODE></FONT></TD>
|
---|
376 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setExecutable(java.lang.String)">setExecutable</A></B>(java.lang.String value)</CODE>
|
---|
377 |
|
---|
378 | <BR>
|
---|
379 | Set the name of the executable program.</TD>
|
---|
380 | </TR>
|
---|
381 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
382 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
383 | <CODE> void</CODE></FONT></TD>
|
---|
384 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setFailIfExecutionFails(boolean)">setFailIfExecutionFails</A></B>(boolean flag)</CODE>
|
---|
385 |
|
---|
386 | <BR>
|
---|
387 | Set whether to stop the build if program cannot be started.</TD>
|
---|
388 | </TR>
|
---|
389 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
390 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
391 | <CODE> void</CODE></FONT></TD>
|
---|
392 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setFailonerror(boolean)">setFailonerror</A></B>(boolean fail)</CODE>
|
---|
393 |
|
---|
394 | <BR>
|
---|
395 | Fail if the command exits with a non-zero return code.</TD>
|
---|
396 | </TR>
|
---|
397 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
398 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
399 | <CODE> void</CODE></FONT></TD>
|
---|
400 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setInput(java.io.File)">setInput</A></B>(java.io.File input)</CODE>
|
---|
401 |
|
---|
402 | <BR>
|
---|
403 | Set the input file to use for the task.</TD>
|
---|
404 | </TR>
|
---|
405 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
406 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
407 | <CODE> void</CODE></FONT></TD>
|
---|
408 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setInputString(java.lang.String)">setInputString</A></B>(java.lang.String inputString)</CODE>
|
---|
409 |
|
---|
410 | <BR>
|
---|
411 | Set the string to use as input.</TD>
|
---|
412 | </TR>
|
---|
413 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
414 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
415 | <CODE> void</CODE></FONT></TD>
|
---|
416 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setLogError(boolean)">setLogError</A></B>(boolean logError)</CODE>
|
---|
417 |
|
---|
418 | <BR>
|
---|
419 | Controls whether error output of exec is logged.</TD>
|
---|
420 | </TR>
|
---|
421 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
422 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
423 | <CODE> void</CODE></FONT></TD>
|
---|
424 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setNewenvironment(boolean)">setNewenvironment</A></B>(boolean newenv)</CODE>
|
---|
425 |
|
---|
426 | <BR>
|
---|
427 | Do not propagate old environment when new environment variables are specified.</TD>
|
---|
428 | </TR>
|
---|
429 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
430 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
431 | <CODE> void</CODE></FONT></TD>
|
---|
432 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setOs(java.lang.String)">setOs</A></B>(java.lang.String os)</CODE>
|
---|
433 |
|
---|
434 | <BR>
|
---|
435 | List of operating systems on which the command may be executed.</TD>
|
---|
436 | </TR>
|
---|
437 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
438 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
439 | <CODE> void</CODE></FONT></TD>
|
---|
440 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setOutput(java.io.File)">setOutput</A></B>(java.io.File out)</CODE>
|
---|
441 |
|
---|
442 | <BR>
|
---|
443 | File the output of the process is redirected to.</TD>
|
---|
444 | </TR>
|
---|
445 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
446 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
447 | <CODE> void</CODE></FONT></TD>
|
---|
448 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setOutputproperty(java.lang.String)">setOutputproperty</A></B>(java.lang.String outputProp)</CODE>
|
---|
449 |
|
---|
450 | <BR>
|
---|
451 | Sets the property name whose value should be set to the output of
|
---|
452 | the process.</TD>
|
---|
453 | </TR>
|
---|
454 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
455 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
456 | <CODE> void</CODE></FONT></TD>
|
---|
457 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setResolveExecutable(boolean)">setResolveExecutable</A></B>(boolean resolveExecutable)</CODE>
|
---|
458 |
|
---|
459 | <BR>
|
---|
460 | Set whether to attempt to resolve the executable to a file.</TD>
|
---|
461 | </TR>
|
---|
462 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
463 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
464 | <CODE> void</CODE></FONT></TD>
|
---|
465 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setResultProperty(java.lang.String)">setResultProperty</A></B>(java.lang.String resultProperty)</CODE>
|
---|
466 |
|
---|
467 | <BR>
|
---|
468 | Sets the name of a property in which the return code of the
|
---|
469 | command should be stored.</TD>
|
---|
470 | </TR>
|
---|
471 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
472 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
473 | <CODE> void</CODE></FONT></TD>
|
---|
474 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setSearchPath(boolean)">setSearchPath</A></B>(boolean searchPath)</CODE>
|
---|
475 |
|
---|
476 | <BR>
|
---|
477 | Set whether to search nested, then
|
---|
478 | system PATH environment variables for the executable.</TD>
|
---|
479 | </TR>
|
---|
480 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
481 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
482 | <CODE> void</CODE></FONT></TD>
|
---|
483 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setSpawn(boolean)">setSpawn</A></B>(boolean spawn)</CODE>
|
---|
484 |
|
---|
485 | <BR>
|
---|
486 | Set whether or not you want the process to be spawned.</TD>
|
---|
487 | </TR>
|
---|
488 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
489 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
490 | <CODE> void</CODE></FONT></TD>
|
---|
491 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setTimeout(java.lang.Integer)">setTimeout</A></B>(java.lang.Integer value)</CODE>
|
---|
492 |
|
---|
493 | <BR>
|
---|
494 | Set the timeout in milliseconds after which the process will be killed.</TD>
|
---|
495 | </TR>
|
---|
496 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
497 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
498 | <CODE> void</CODE></FONT></TD>
|
---|
499 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setTimeout(java.lang.Long)">setTimeout</A></B>(java.lang.Long value)</CODE>
|
---|
500 |
|
---|
501 | <BR>
|
---|
502 | Set the timeout in milliseconds after which the process will be killed.</TD>
|
---|
503 | </TR>
|
---|
504 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
505 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
506 | <CODE>protected void</CODE></FONT></TD>
|
---|
507 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setupRedirector()">setupRedirector</A></B>()</CODE>
|
---|
508 |
|
---|
509 | <BR>
|
---|
510 | Set up properties on the redirector that we needed to store locally.</TD>
|
---|
511 | </TR>
|
---|
512 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
513 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
514 | <CODE> void</CODE></FONT></TD>
|
---|
515 | <TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecTask.html#setVMLauncher(boolean)">setVMLauncher</A></B>(boolean vmLauncher)</CODE>
|
---|
516 |
|
---|
517 | <BR>
|
---|
518 | Set whether to launch new process with VM, otherwise use the OS's shell.</TD>
|
---|
519 | </TR>
|
---|
520 | </TABLE>
|
---|
521 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
|
---|
522 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
523 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
524 | <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>
|
---|
525 | </TR>
|
---|
526 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
527 | <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#init()">init</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>
|
---|
528 | </TR>
|
---|
529 | </TABLE>
|
---|
530 | <A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
|
---|
531 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
532 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
533 | <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>
|
---|
534 | </TR>
|
---|
535 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
536 | <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>
|
---|
537 | </TR>
|
---|
538 | </TABLE>
|
---|
539 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
540 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
541 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
542 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
543 | </TR>
|
---|
544 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
545 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
546 | </TR>
|
---|
547 | </TABLE>
|
---|
548 |
|
---|
549 | <P>
|
---|
550 |
|
---|
551 | <!-- ============ FIELD DETAIL =========== -->
|
---|
552 |
|
---|
553 | <A NAME="field_detail"><!-- --></A>
|
---|
554 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
555 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
556 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
557 | <B>Field Detail</B></FONT></TD>
|
---|
558 | </TR>
|
---|
559 | </TABLE>
|
---|
560 |
|
---|
561 | <A NAME="failOnError"><!-- --></A><H3>
|
---|
562 | failOnError</H3>
|
---|
563 | <PRE>
|
---|
564 | protected boolean <B>failOnError</B></PRE>
|
---|
565 | <DL>
|
---|
566 | <DL>
|
---|
567 | </DL>
|
---|
568 | </DL>
|
---|
569 | <HR>
|
---|
570 |
|
---|
571 | <A NAME="newEnvironment"><!-- --></A><H3>
|
---|
572 | newEnvironment</H3>
|
---|
573 | <PRE>
|
---|
574 | protected boolean <B>newEnvironment</B></PRE>
|
---|
575 | <DL>
|
---|
576 | <DL>
|
---|
577 | </DL>
|
---|
578 | </DL>
|
---|
579 | <HR>
|
---|
580 |
|
---|
581 | <A NAME="cmdl"><!-- --></A><H3>
|
---|
582 | cmdl</H3>
|
---|
583 | <PRE>
|
---|
584 | protected <A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> <B>cmdl</B></PRE>
|
---|
585 | <DL>
|
---|
586 | <DL>
|
---|
587 | </DL>
|
---|
588 | </DL>
|
---|
589 | <HR>
|
---|
590 |
|
---|
591 | <A NAME="redirector"><!-- --></A><H3>
|
---|
592 | redirector</H3>
|
---|
593 | <PRE>
|
---|
594 | protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/Redirector.html" title="class in org.apache.tools.ant.taskdefs">Redirector</A> <B>redirector</B></PRE>
|
---|
595 | <DL>
|
---|
596 | <DL>
|
---|
597 | </DL>
|
---|
598 | </DL>
|
---|
599 | <HR>
|
---|
600 |
|
---|
601 | <A NAME="redirectorElement"><!-- --></A><H3>
|
---|
602 | redirectorElement</H3>
|
---|
603 | <PRE>
|
---|
604 | protected <A HREF="../../../../../org/apache/tools/ant/types/RedirectorElement.html" title="class in org.apache.tools.ant.types">RedirectorElement</A> <B>redirectorElement</B></PRE>
|
---|
605 | <DL>
|
---|
606 | <DL>
|
---|
607 | </DL>
|
---|
608 | </DL>
|
---|
609 |
|
---|
610 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
611 |
|
---|
612 | <A NAME="constructor_detail"><!-- --></A>
|
---|
613 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
614 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
615 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
616 | <B>Constructor Detail</B></FONT></TD>
|
---|
617 | </TR>
|
---|
618 | </TABLE>
|
---|
619 |
|
---|
620 | <A NAME="ExecTask()"><!-- --></A><H3>
|
---|
621 | ExecTask</H3>
|
---|
622 | <PRE>
|
---|
623 | public <B>ExecTask</B>()</PRE>
|
---|
624 | <DL>
|
---|
625 | </DL>
|
---|
626 |
|
---|
627 | <!-- ============ METHOD DETAIL ========== -->
|
---|
628 |
|
---|
629 | <A NAME="method_detail"><!-- --></A>
|
---|
630 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
631 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
632 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
633 | <B>Method Detail</B></FONT></TD>
|
---|
634 | </TR>
|
---|
635 | </TABLE>
|
---|
636 |
|
---|
637 | <A NAME="setSpawn(boolean)"><!-- --></A><H3>
|
---|
638 | setSpawn</H3>
|
---|
639 | <PRE>
|
---|
640 | public void <B>setSpawn</B>(boolean spawn)</PRE>
|
---|
641 | <DL>
|
---|
642 | <DD>Set whether or not you want the process to be spawned.
|
---|
643 | Default is false.
|
---|
644 | <P>
|
---|
645 | <DD><DL>
|
---|
646 | <DT><B>Parameters:</B><DD><CODE>spawn</CODE> - if true you do not want Ant to wait for the end of the process.<DT><B>Since:</B></DT>
|
---|
647 | <DD>Ant 1.6</DD>
|
---|
648 | </DL>
|
---|
649 | </DD>
|
---|
650 | </DL>
|
---|
651 | <HR>
|
---|
652 |
|
---|
653 | <A NAME="setTimeout(java.lang.Long)"><!-- --></A><H3>
|
---|
654 | setTimeout</H3>
|
---|
655 | <PRE>
|
---|
656 | public void <B>setTimeout</B>(java.lang.Long value)</PRE>
|
---|
657 | <DL>
|
---|
658 | <DD>Set the timeout in milliseconds after which the process will be killed.
|
---|
659 | <P>
|
---|
660 | <DD><DL>
|
---|
661 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - timeout in milliseconds.<DT><B>Since:</B></DT>
|
---|
662 | <DD>Ant 1.5</DD>
|
---|
663 | </DL>
|
---|
664 | </DD>
|
---|
665 | </DL>
|
---|
666 | <HR>
|
---|
667 |
|
---|
668 | <A NAME="setTimeout(java.lang.Integer)"><!-- --></A><H3>
|
---|
669 | setTimeout</H3>
|
---|
670 | <PRE>
|
---|
671 | public void <B>setTimeout</B>(java.lang.Integer value)</PRE>
|
---|
672 | <DL>
|
---|
673 | <DD>Set the timeout in milliseconds after which the process will be killed.
|
---|
674 | <P>
|
---|
675 | <DD><DL>
|
---|
676 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - timeout in milliseconds.</DL>
|
---|
677 | </DD>
|
---|
678 | </DL>
|
---|
679 | <HR>
|
---|
680 |
|
---|
681 | <A NAME="setExecutable(java.lang.String)"><!-- --></A><H3>
|
---|
682 | setExecutable</H3>
|
---|
683 | <PRE>
|
---|
684 | public void <B>setExecutable</B>(java.lang.String value)</PRE>
|
---|
685 | <DL>
|
---|
686 | <DD>Set the name of the executable program.
|
---|
687 | <P>
|
---|
688 | <DD><DL>
|
---|
689 | <DT><B>Parameters:</B><DD><CODE>value</CODE> - the name of the executable program.</DL>
|
---|
690 | </DD>
|
---|
691 | </DL>
|
---|
692 | <HR>
|
---|
693 |
|
---|
694 | <A NAME="setDir(java.io.File)"><!-- --></A><H3>
|
---|
695 | setDir</H3>
|
---|
696 | <PRE>
|
---|
697 | public void <B>setDir</B>(java.io.File d)</PRE>
|
---|
698 | <DL>
|
---|
699 | <DD>Set the working directory of the process.
|
---|
700 | <P>
|
---|
701 | <DD><DL>
|
---|
702 | <DT><B>Parameters:</B><DD><CODE>d</CODE> - the working directory of the process.</DL>
|
---|
703 | </DD>
|
---|
704 | </DL>
|
---|
705 | <HR>
|
---|
706 |
|
---|
707 | <A NAME="setOs(java.lang.String)"><!-- --></A><H3>
|
---|
708 | setOs</H3>
|
---|
709 | <PRE>
|
---|
710 | public void <B>setOs</B>(java.lang.String os)</PRE>
|
---|
711 | <DL>
|
---|
712 | <DD>List of operating systems on which the command may be executed.
|
---|
713 | <P>
|
---|
714 | <DD><DL>
|
---|
715 | <DT><B>Parameters:</B><DD><CODE>os</CODE> - list of operating systems on which the command may be executed.</DL>
|
---|
716 | </DD>
|
---|
717 | </DL>
|
---|
718 | <HR>
|
---|
719 |
|
---|
720 | <A NAME="setCommand(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
|
---|
721 | setCommand</H3>
|
---|
722 | <PRE>
|
---|
723 | public void <B>setCommand</B>(<A HREF="../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> cmdl)</PRE>
|
---|
724 | <DL>
|
---|
725 | <DD>Sets a command line.
|
---|
726 | <P>
|
---|
727 | <DD><DL>
|
---|
728 | <DT><B>Parameters:</B><DD><CODE>cmdl</CODE> - command line.</DL>
|
---|
729 | </DD>
|
---|
730 | </DL>
|
---|
731 | <HR>
|
---|
732 |
|
---|
733 | <A NAME="setOutput(java.io.File)"><!-- --></A><H3>
|
---|
734 | setOutput</H3>
|
---|
735 | <PRE>
|
---|
736 | public void <B>setOutput</B>(java.io.File out)</PRE>
|
---|
737 | <DL>
|
---|
738 | <DD>File the output of the process is redirected to. If error is not
|
---|
739 | redirected, it too will appear in the output.
|
---|
740 | <P>
|
---|
741 | <DD><DL>
|
---|
742 | <DT><B>Parameters:</B><DD><CODE>out</CODE> - name of a file to which output should be sent.</DL>
|
---|
743 | </DD>
|
---|
744 | </DL>
|
---|
745 | <HR>
|
---|
746 |
|
---|
747 | <A NAME="setInput(java.io.File)"><!-- --></A><H3>
|
---|
748 | setInput</H3>
|
---|
749 | <PRE>
|
---|
750 | public void <B>setInput</B>(java.io.File input)</PRE>
|
---|
751 | <DL>
|
---|
752 | <DD>Set the input file to use for the task.
|
---|
753 | <P>
|
---|
754 | <DD><DL>
|
---|
755 | <DT><B>Parameters:</B><DD><CODE>input</CODE> - name of a file from which to get input.</DL>
|
---|
756 | </DD>
|
---|
757 | </DL>
|
---|
758 | <HR>
|
---|
759 |
|
---|
760 | <A NAME="setInputString(java.lang.String)"><!-- --></A><H3>
|
---|
761 | setInputString</H3>
|
---|
762 | <PRE>
|
---|
763 | public void <B>setInputString</B>(java.lang.String inputString)</PRE>
|
---|
764 | <DL>
|
---|
765 | <DD>Set the string to use as input.
|
---|
766 | <P>
|
---|
767 | <DD><DL>
|
---|
768 | <DT><B>Parameters:</B><DD><CODE>inputString</CODE> - the string which is used as the input source.</DL>
|
---|
769 | </DD>
|
---|
770 | </DL>
|
---|
771 | <HR>
|
---|
772 |
|
---|
773 | <A NAME="setLogError(boolean)"><!-- --></A><H3>
|
---|
774 | setLogError</H3>
|
---|
775 | <PRE>
|
---|
776 | public void <B>setLogError</B>(boolean logError)</PRE>
|
---|
777 | <DL>
|
---|
778 | <DD>Controls whether error output of exec is logged. This is only useful when
|
---|
779 | output is being redirected and error output is desired in the Ant log.
|
---|
780 | <P>
|
---|
781 | <DD><DL>
|
---|
782 | <DT><B>Parameters:</B><DD><CODE>logError</CODE> - set to true to log error output in the normal ant log.</DL>
|
---|
783 | </DD>
|
---|
784 | </DL>
|
---|
785 | <HR>
|
---|
786 |
|
---|
787 | <A NAME="setError(java.io.File)"><!-- --></A><H3>
|
---|
788 | setError</H3>
|
---|
789 | <PRE>
|
---|
790 | public void <B>setError</B>(java.io.File error)</PRE>
|
---|
791 | <DL>
|
---|
792 | <DD>Set the File to which the error stream of the process should be redirected.
|
---|
793 | <P>
|
---|
794 | <DD><DL>
|
---|
795 | <DT><B>Parameters:</B><DD><CODE>error</CODE> - a file to which stderr should be sent.<DT><B>Since:</B></DT>
|
---|
796 | <DD>Ant 1.6</DD>
|
---|
797 | </DL>
|
---|
798 | </DD>
|
---|
799 | </DL>
|
---|
800 | <HR>
|
---|
801 |
|
---|
802 | <A NAME="setOutputproperty(java.lang.String)"><!-- --></A><H3>
|
---|
803 | setOutputproperty</H3>
|
---|
804 | <PRE>
|
---|
805 | public void <B>setOutputproperty</B>(java.lang.String outputProp)</PRE>
|
---|
806 | <DL>
|
---|
807 | <DD>Sets the property name whose value should be set to the output of
|
---|
808 | the process.
|
---|
809 | <P>
|
---|
810 | <DD><DL>
|
---|
811 | <DT><B>Parameters:</B><DD><CODE>outputProp</CODE> - name of property.</DL>
|
---|
812 | </DD>
|
---|
813 | </DL>
|
---|
814 | <HR>
|
---|
815 |
|
---|
816 | <A NAME="setErrorProperty(java.lang.String)"><!-- --></A><H3>
|
---|
817 | setErrorProperty</H3>
|
---|
818 | <PRE>
|
---|
819 | public void <B>setErrorProperty</B>(java.lang.String errorProperty)</PRE>
|
---|
820 | <DL>
|
---|
821 | <DD>Sets the name of the property whose value should be set to the error of
|
---|
822 | the process.
|
---|
823 | <P>
|
---|
824 | <DD><DL>
|
---|
825 | <DT><B>Parameters:</B><DD><CODE>errorProperty</CODE> - name of property.<DT><B>Since:</B></DT>
|
---|
826 | <DD>Ant 1.6</DD>
|
---|
827 | </DL>
|
---|
828 | </DD>
|
---|
829 | </DL>
|
---|
830 | <HR>
|
---|
831 |
|
---|
832 | <A NAME="setFailonerror(boolean)"><!-- --></A><H3>
|
---|
833 | setFailonerror</H3>
|
---|
834 | <PRE>
|
---|
835 | public void <B>setFailonerror</B>(boolean fail)</PRE>
|
---|
836 | <DL>
|
---|
837 | <DD>Fail if the command exits with a non-zero return code.
|
---|
838 | <P>
|
---|
839 | <DD><DL>
|
---|
840 | <DT><B>Parameters:</B><DD><CODE>fail</CODE> - if true fail the command on non-zero return code.</DL>
|
---|
841 | </DD>
|
---|
842 | </DL>
|
---|
843 | <HR>
|
---|
844 |
|
---|
845 | <A NAME="setNewenvironment(boolean)"><!-- --></A><H3>
|
---|
846 | setNewenvironment</H3>
|
---|
847 | <PRE>
|
---|
848 | public void <B>setNewenvironment</B>(boolean newenv)</PRE>
|
---|
849 | <DL>
|
---|
850 | <DD>Do not propagate old environment when new environment variables are specified.
|
---|
851 | <P>
|
---|
852 | <DD><DL>
|
---|
853 | <DT><B>Parameters:</B><DD><CODE>newenv</CODE> - if true, do not propagate old environment
|
---|
854 | when new environment variables are specified.</DL>
|
---|
855 | </DD>
|
---|
856 | </DL>
|
---|
857 | <HR>
|
---|
858 |
|
---|
859 | <A NAME="setResolveExecutable(boolean)"><!-- --></A><H3>
|
---|
860 | setResolveExecutable</H3>
|
---|
861 | <PRE>
|
---|
862 | public void <B>setResolveExecutable</B>(boolean resolveExecutable)</PRE>
|
---|
863 | <DL>
|
---|
864 | <DD>Set whether to attempt to resolve the executable to a file.
|
---|
865 | <P>
|
---|
866 | <DD><DL>
|
---|
867 | <DT><B>Parameters:</B><DD><CODE>resolveExecutable</CODE> - if true, attempt to resolve the
|
---|
868 | path of the executable.</DL>
|
---|
869 | </DD>
|
---|
870 | </DL>
|
---|
871 | <HR>
|
---|
872 |
|
---|
873 | <A NAME="setSearchPath(boolean)"><!-- --></A><H3>
|
---|
874 | setSearchPath</H3>
|
---|
875 | <PRE>
|
---|
876 | public void <B>setSearchPath</B>(boolean searchPath)</PRE>
|
---|
877 | <DL>
|
---|
878 | <DD>Set whether to search nested, then
|
---|
879 | system PATH environment variables for the executable.
|
---|
880 | <P>
|
---|
881 | <DD><DL>
|
---|
882 | <DT><B>Parameters:</B><DD><CODE>searchPath</CODE> - if true, search PATHs.</DL>
|
---|
883 | </DD>
|
---|
884 | </DL>
|
---|
885 | <HR>
|
---|
886 |
|
---|
887 | <A NAME="getResolveExecutable()"><!-- --></A><H3>
|
---|
888 | getResolveExecutable</H3>
|
---|
889 | <PRE>
|
---|
890 | public boolean <B>getResolveExecutable</B>()</PRE>
|
---|
891 | <DL>
|
---|
892 | <DD>Indicates whether to attempt to resolve the executable to a
|
---|
893 | file.
|
---|
894 | <P>
|
---|
895 | <DD><DL>
|
---|
896 | <DT><B>Since:</B></DT>
|
---|
897 | <DD>Ant 1.6</DD>
|
---|
898 | </DL>
|
---|
899 | </DD>
|
---|
900 | </DL>
|
---|
901 | <HR>
|
---|
902 |
|
---|
903 | <A NAME="addEnv(org.apache.tools.ant.types.Environment.Variable)"><!-- --></A><H3>
|
---|
904 | addEnv</H3>
|
---|
905 | <PRE>
|
---|
906 | public void <B>addEnv</B>(<A HREF="../../../../../org/apache/tools/ant/types/Environment.Variable.html" title="class in org.apache.tools.ant.types">Environment.Variable</A> var)</PRE>
|
---|
907 | <DL>
|
---|
908 | <DD>Add an environment variable to the launched process.
|
---|
909 | <P>
|
---|
910 | <DD><DL>
|
---|
911 | <DT><B>Parameters:</B><DD><CODE>var</CODE> - new environment variable.</DL>
|
---|
912 | </DD>
|
---|
913 | </DL>
|
---|
914 | <HR>
|
---|
915 |
|
---|
916 | <A NAME="createArg()"><!-- --></A><H3>
|
---|
917 | createArg</H3>
|
---|
918 | <PRE>
|
---|
919 | public <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A> <B>createArg</B>()</PRE>
|
---|
920 | <DL>
|
---|
921 | <DD>Adds a command-line argument.
|
---|
922 | <P>
|
---|
923 | <DD><DL>
|
---|
924 |
|
---|
925 | <DT><B>Returns:</B><DD>new command line argument created.</DL>
|
---|
926 | </DD>
|
---|
927 | </DL>
|
---|
928 | <HR>
|
---|
929 |
|
---|
930 | <A NAME="setResultProperty(java.lang.String)"><!-- --></A><H3>
|
---|
931 | setResultProperty</H3>
|
---|
932 | <PRE>
|
---|
933 | public void <B>setResultProperty</B>(java.lang.String resultProperty)</PRE>
|
---|
934 | <DL>
|
---|
935 | <DD>Sets the name of a property in which the return code of the
|
---|
936 | command should be stored. Only of interest if failonerror=false.
|
---|
937 | <P>
|
---|
938 | <DD><DL>
|
---|
939 | <DT><B>Parameters:</B><DD><CODE>resultProperty</CODE> - name of property.<DT><B>Since:</B></DT>
|
---|
940 | <DD>Ant 1.5</DD>
|
---|
941 | </DL>
|
---|
942 | </DD>
|
---|
943 | </DL>
|
---|
944 | <HR>
|
---|
945 |
|
---|
946 | <A NAME="maybeSetResultPropertyValue(int)"><!-- --></A><H3>
|
---|
947 | maybeSetResultPropertyValue</H3>
|
---|
948 | <PRE>
|
---|
949 | protected void <B>maybeSetResultPropertyValue</B>(int result)</PRE>
|
---|
950 | <DL>
|
---|
951 | <DD>Helper method to set result property to the
|
---|
952 | passed in value if appropriate.
|
---|
953 | <P>
|
---|
954 | <DD><DL>
|
---|
955 | <DT><B>Parameters:</B><DD><CODE>result</CODE> - value desired for the result property value.</DL>
|
---|
956 | </DD>
|
---|
957 | </DL>
|
---|
958 | <HR>
|
---|
959 |
|
---|
960 | <A NAME="setFailIfExecutionFails(boolean)"><!-- --></A><H3>
|
---|
961 | setFailIfExecutionFails</H3>
|
---|
962 | <PRE>
|
---|
963 | public void <B>setFailIfExecutionFails</B>(boolean flag)</PRE>
|
---|
964 | <DL>
|
---|
965 | <DD>Set whether to stop the build if program cannot be started.
|
---|
966 | Defaults to true.
|
---|
967 | <P>
|
---|
968 | <DD><DL>
|
---|
969 | <DT><B>Parameters:</B><DD><CODE>flag</CODE> - stop the build if program cannot be started.<DT><B>Since:</B></DT>
|
---|
970 | <DD>Ant 1.5</DD>
|
---|
971 | </DL>
|
---|
972 | </DD>
|
---|
973 | </DL>
|
---|
974 | <HR>
|
---|
975 |
|
---|
976 | <A NAME="setAppend(boolean)"><!-- --></A><H3>
|
---|
977 | setAppend</H3>
|
---|
978 | <PRE>
|
---|
979 | public void <B>setAppend</B>(boolean append)</PRE>
|
---|
980 | <DL>
|
---|
981 | <DD>Set whether output should be appended to or overwrite an existing file.
|
---|
982 | Defaults to false.
|
---|
983 | <P>
|
---|
984 | <DD><DL>
|
---|
985 | <DT><B>Parameters:</B><DD><CODE>append</CODE> - if true append is desired.<DT><B>Since:</B></DT>
|
---|
986 | <DD>1.30, Ant 1.5</DD>
|
---|
987 | </DL>
|
---|
988 | </DD>
|
---|
989 | </DL>
|
---|
990 | <HR>
|
---|
991 |
|
---|
992 | <A NAME="addConfiguredRedirector(org.apache.tools.ant.types.RedirectorElement)"><!-- --></A><H3>
|
---|
993 | addConfiguredRedirector</H3>
|
---|
994 | <PRE>
|
---|
995 | public void <B>addConfiguredRedirector</B>(<A HREF="../../../../../org/apache/tools/ant/types/RedirectorElement.html" title="class in org.apache.tools.ant.types">RedirectorElement</A> redirectorElement)</PRE>
|
---|
996 | <DL>
|
---|
997 | <DD>Add a <code>RedirectorElement</code> to this task.
|
---|
998 | <P>
|
---|
999 | <DD><DL>
|
---|
1000 | <DT><B>Parameters:</B><DD><CODE>redirectorElement</CODE> - <code>RedirectorElement</code>.<DT><B>Since:</B></DT>
|
---|
1001 | <DD>Ant 1.6.2</DD>
|
---|
1002 | </DL>
|
---|
1003 | </DD>
|
---|
1004 | </DL>
|
---|
1005 | <HR>
|
---|
1006 |
|
---|
1007 | <A NAME="resolveExecutable(java.lang.String, boolean)"><!-- --></A><H3>
|
---|
1008 | resolveExecutable</H3>
|
---|
1009 | <PRE>
|
---|
1010 | protected java.lang.String <B>resolveExecutable</B>(java.lang.String exec,
|
---|
1011 | boolean mustSearchPath)</PRE>
|
---|
1012 | <DL>
|
---|
1013 | <DD>The method attempts to figure out where the executable is so that we can feed
|
---|
1014 | the full path. We first try basedir, then the exec dir, and then
|
---|
1015 | fallback to the straight executable name (i.e. on the path).
|
---|
1016 | <P>
|
---|
1017 | <DD><DL>
|
---|
1018 | <DT><B>Parameters:</B><DD><CODE>exec</CODE> - the name of the executable.<DD><CODE>mustSearchPath</CODE> - if true, the executable will be looked up in
|
---|
1019 | the PATH environment and the absolute path is returned.
|
---|
1020 | <DT><B>Returns:</B><DD>the executable as a full path if it can be determined.<DT><B>Since:</B></DT>
|
---|
1021 | <DD>Ant 1.6</DD>
|
---|
1022 | </DL>
|
---|
1023 | </DD>
|
---|
1024 | </DL>
|
---|
1025 | <HR>
|
---|
1026 |
|
---|
1027 | <A NAME="execute()"><!-- --></A><H3>
|
---|
1028 | execute</H3>
|
---|
1029 | <PRE>
|
---|
1030 | public void <B>execute</B>()
|
---|
1031 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1032 | <DL>
|
---|
1033 | <DD>Do the work.
|
---|
1034 | <P>
|
---|
1035 | <DD><DL>
|
---|
1036 | <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>
|
---|
1037 | </DD>
|
---|
1038 | <DD><DL>
|
---|
1039 |
|
---|
1040 | <DT><B>Throws:</B>
|
---|
1041 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - in a number of circumstances:
|
---|
1042 | <ul>
|
---|
1043 | <li>if failIfExecFails is set to true and the process cannot be started</li>
|
---|
1044 | <li>the java13command launcher can send build exceptions</li>
|
---|
1045 | <li>this list is not exhaustive or limitative</li>
|
---|
1046 | </ul></DL>
|
---|
1047 | </DD>
|
---|
1048 | </DL>
|
---|
1049 | <HR>
|
---|
1050 |
|
---|
1051 | <A NAME="checkConfiguration()"><!-- --></A><H3>
|
---|
1052 | checkConfiguration</H3>
|
---|
1053 | <PRE>
|
---|
1054 | protected void <B>checkConfiguration</B>()
|
---|
1055 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1056 | <DL>
|
---|
1057 | <DD>Has the user set all necessary attributes?
|
---|
1058 | <P>
|
---|
1059 | <DD><DL>
|
---|
1060 |
|
---|
1061 | <DT><B>Throws:</B>
|
---|
1062 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if there are missing required parameters.</DL>
|
---|
1063 | </DD>
|
---|
1064 | </DL>
|
---|
1065 | <HR>
|
---|
1066 |
|
---|
1067 | <A NAME="setupRedirector()"><!-- --></A><H3>
|
---|
1068 | setupRedirector</H3>
|
---|
1069 | <PRE>
|
---|
1070 | protected void <B>setupRedirector</B>()</PRE>
|
---|
1071 | <DL>
|
---|
1072 | <DD>Set up properties on the redirector that we needed to store locally.
|
---|
1073 | <P>
|
---|
1074 | <DD><DL>
|
---|
1075 | </DL>
|
---|
1076 | </DD>
|
---|
1077 | </DL>
|
---|
1078 | <HR>
|
---|
1079 |
|
---|
1080 | <A NAME="isValidOs()"><!-- --></A><H3>
|
---|
1081 | isValidOs</H3>
|
---|
1082 | <PRE>
|
---|
1083 | protected boolean <B>isValidOs</B>()</PRE>
|
---|
1084 | <DL>
|
---|
1085 | <DD>Is this the OS the user wanted?
|
---|
1086 | <P>
|
---|
1087 | <DD><DL>
|
---|
1088 |
|
---|
1089 | <DT><B>Returns:</B><DD>boolean.
|
---|
1090 | <ul>
|
---|
1091 | <li>
|
---|
1092 | <code>true</code> if the os under which Ant is running is
|
---|
1093 | matches one os in the os attribute
|
---|
1094 | or if the os attribute is null</li>
|
---|
1095 | <li><code>false</code> otherwise.</li>
|
---|
1096 | </ul></DL>
|
---|
1097 | </DD>
|
---|
1098 | </DL>
|
---|
1099 | <HR>
|
---|
1100 |
|
---|
1101 | <A NAME="setVMLauncher(boolean)"><!-- --></A><H3>
|
---|
1102 | setVMLauncher</H3>
|
---|
1103 | <PRE>
|
---|
1104 | public void <B>setVMLauncher</B>(boolean vmLauncher)</PRE>
|
---|
1105 | <DL>
|
---|
1106 | <DD>Set whether to launch new process with VM, otherwise use the OS's shell.
|
---|
1107 | Default value is true.
|
---|
1108 | <P>
|
---|
1109 | <DD><DL>
|
---|
1110 | <DT><B>Parameters:</B><DD><CODE>vmLauncher</CODE> - true if we want to launch new process with VM,
|
---|
1111 | false if we want to use the OS's shell.</DL>
|
---|
1112 | </DD>
|
---|
1113 | </DL>
|
---|
1114 | <HR>
|
---|
1115 |
|
---|
1116 | <A NAME="prepareExec()"><!-- --></A><H3>
|
---|
1117 | prepareExec</H3>
|
---|
1118 | <PRE>
|
---|
1119 | protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs">Execute</A> <B>prepareExec</B>()
|
---|
1120 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1121 | <DL>
|
---|
1122 | <DD>Create an Execute instance with the correct working directory set.
|
---|
1123 | <P>
|
---|
1124 | <DD><DL>
|
---|
1125 |
|
---|
1126 | <DT><B>Returns:</B><DD>an instance of the Execute class.
|
---|
1127 | <DT><B>Throws:</B>
|
---|
1128 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - under unknown circumstances.</DL>
|
---|
1129 | </DD>
|
---|
1130 | </DL>
|
---|
1131 | <HR>
|
---|
1132 |
|
---|
1133 | <A NAME="runExecute(org.apache.tools.ant.taskdefs.Execute)"><!-- --></A><H3>
|
---|
1134 | runExecute</H3>
|
---|
1135 | <PRE>
|
---|
1136 | protected final void <B>runExecute</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs">Execute</A> exe)
|
---|
1137 | throws java.io.IOException</PRE>
|
---|
1138 | <DL>
|
---|
1139 | <DD>A Utility method for this classes and subclasses to run an
|
---|
1140 | Execute instance (an external command).
|
---|
1141 | <P>
|
---|
1142 | <DD><DL>
|
---|
1143 | <DT><B>Parameters:</B><DD><CODE>exe</CODE> - instance of the execute class.
|
---|
1144 | <DT><B>Throws:</B>
|
---|
1145 | <DD><CODE>java.io.IOException</CODE> - in case of problem to attach to the stdin/stdout/stderr
|
---|
1146 | streams of the process.</DL>
|
---|
1147 | </DD>
|
---|
1148 | </DL>
|
---|
1149 | <HR>
|
---|
1150 |
|
---|
1151 | <A NAME="runExec(org.apache.tools.ant.taskdefs.Execute)"><!-- --></A><H3>
|
---|
1152 | runExec</H3>
|
---|
1153 | <PRE>
|
---|
1154 | protected void <B>runExec</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs">Execute</A> exe)
|
---|
1155 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1156 | <DL>
|
---|
1157 | <DD>Run the command using the given Execute instance. This may be
|
---|
1158 | overridden by subclasses.
|
---|
1159 | <P>
|
---|
1160 | <DD><DL>
|
---|
1161 | <DT><B>Parameters:</B><DD><CODE>exe</CODE> - instance of Execute to run.
|
---|
1162 | <DT><B>Throws:</B>
|
---|
1163 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the new process could not be started
|
---|
1164 | only if failIfExecFails is set to true (the default).</DL>
|
---|
1165 | </DD>
|
---|
1166 | </DL>
|
---|
1167 | <HR>
|
---|
1168 |
|
---|
1169 | <A NAME="createHandler()"><!-- --></A><H3>
|
---|
1170 | createHandler</H3>
|
---|
1171 | <PRE>
|
---|
1172 | protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html" title="interface in org.apache.tools.ant.taskdefs">ExecuteStreamHandler</A> <B>createHandler</B>()
|
---|
1173 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1174 | <DL>
|
---|
1175 | <DD>Create the StreamHandler to use with our Execute instance.
|
---|
1176 | <P>
|
---|
1177 | <DD><DL>
|
---|
1178 |
|
---|
1179 | <DT><B>Returns:</B><DD>instance of ExecuteStreamHandler.
|
---|
1180 | <DT><B>Throws:</B>
|
---|
1181 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - under unknown circumstances.</DL>
|
---|
1182 | </DD>
|
---|
1183 | </DL>
|
---|
1184 | <HR>
|
---|
1185 |
|
---|
1186 | <A NAME="createWatchdog()"><!-- --></A><H3>
|
---|
1187 | createWatchdog</H3>
|
---|
1188 | <PRE>
|
---|
1189 | protected <A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteWatchdog.html" title="class in org.apache.tools.ant.taskdefs">ExecuteWatchdog</A> <B>createWatchdog</B>()
|
---|
1190 | throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1191 | <DL>
|
---|
1192 | <DD>Create the Watchdog to kill a runaway process.
|
---|
1193 | <P>
|
---|
1194 | <DD><DL>
|
---|
1195 |
|
---|
1196 | <DT><B>Returns:</B><DD>instance of ExecuteWatchdog.
|
---|
1197 | <DT><B>Throws:</B>
|
---|
1198 | <DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - under unknown circumstances.</DL>
|
---|
1199 | </DD>
|
---|
1200 | </DL>
|
---|
1201 | <HR>
|
---|
1202 |
|
---|
1203 | <A NAME="logFlush()"><!-- --></A><H3>
|
---|
1204 | logFlush</H3>
|
---|
1205 | <PRE>
|
---|
1206 | protected void <B>logFlush</B>()</PRE>
|
---|
1207 | <DL>
|
---|
1208 | <DD>Flush the output stream - if there is one.
|
---|
1209 | <P>
|
---|
1210 | <DD><DL>
|
---|
1211 | </DL>
|
---|
1212 | </DD>
|
---|
1213 | </DL>
|
---|
1214 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
1215 | <HR>
|
---|
1216 |
|
---|
1217 |
|
---|
1218 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
1219 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
1220 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
1221 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
1222 | <TR>
|
---|
1223 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
1224 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
1225 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
1226 | <TR ALIGN="center" VALIGN="top">
|
---|
1227 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
1228 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
1229 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
1230 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
1231 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
1232 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
1233 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
1234 | </TR>
|
---|
1235 | </TABLE>
|
---|
1236 | </TD>
|
---|
1237 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
1238 | </EM>
|
---|
1239 | </TD>
|
---|
1240 | </TR>
|
---|
1241 |
|
---|
1242 | <TR>
|
---|
1243 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1244 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Exec.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
|
---|
1245 | <A HREF="../../../../../org/apache/tools/ant/taskdefs/Execute.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
1246 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1247 | <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
1248 | <A HREF="ExecTask.html" target="_top"><B>NO FRAMES</B></A>
|
---|
1249 | <SCRIPT type="text/javascript">
|
---|
1250 | <!--
|
---|
1251 | if(window==top) {
|
---|
1252 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
1253 | }
|
---|
1254 | //-->
|
---|
1255 | </SCRIPT>
|
---|
1256 | <NOSCRIPT>
|
---|
1257 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
1258 | </NOSCRIPT>
|
---|
1259 |
|
---|
1260 | </FONT></TD>
|
---|
1261 | </TR>
|
---|
1262 | <TR>
|
---|
1263 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1264 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
1265 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1266 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
1267 | </TR>
|
---|
1268 | </TABLE>
|
---|
1269 | <A NAME="skip-navbar_bottom"></A>
|
---|
1270 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
1271 |
|
---|
1272 | <HR>
|
---|
1273 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
1274 | </BODY>
|
---|
1275 | </HTML>
|
---|