source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/Exit.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: 21.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:19 NZST 2007 -->
6<TITLE>
7Exit (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Exit 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="Exit (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;<A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteWatchdog.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Expand.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> &nbsp;
56&nbsp;<A HREF="Exit.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;NESTED&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</FONT>
85<BR>
86Class Exit</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"><B>org.apache.tools.ant.taskdefs.Exit</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>Exit</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Exits the active build, giving an additional message
99 if available.
100
101 The <code>if</code> and <code>unless</code> attributes make the
102 failure conditional -both probe for the named property being defined.
103 The <code>if</code> tests for the property being defined, the
104 <code>unless</code> for a property being undefined.
105
106 If both attributes are set, then the test fails only if both tests
107 are true. i.e.
108 <pre>fail := defined(ifProperty) && !defined(unlessProperty)</pre>
109
110 A single nested<CODE>&lt;condition&gt;</CODE> element can be specified
111 instead of using <CODE>if</CODE>/<CODE>unless</CODE> (a combined
112 effect can be achieved using <CODE>isset</CODE> conditions).
113<P>
114
115<P>
116<DL>
117<DT><B>Since:</B></DT>
118 <DD>Ant 1.2</DD>
119</DL>
120<HR>
121
122<P>
123<!-- ======== NESTED CLASS SUMMARY ======== -->
124
125
126<!-- =========== FIELD SUMMARY =========== -->
127
128<A NAME="field_summary"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
131<TD COLSPAN=2><FONT SIZE="+2">
132<B>Field Summary</B></FONT></TD>
133</TR>
134</TABLE>
135&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
138<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>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<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>
142</TR>
143</TABLE>
144&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
147<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>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
151</TR>
152</TABLE>
153&nbsp;
154<!-- ======== CONSTRUCTOR SUMMARY ======== -->
155
156<A NAME="constructor_summary"><!-- --></A>
157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
159<TD COLSPAN=2><FONT SIZE="+2">
160<B>Constructor Summary</B></FONT></TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#Exit()">Exit</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
167</TR>
168</TABLE>
169&nbsp;
170<!-- ========== METHOD SUMMARY =========== -->
171
172<A NAME="method_summary"><!-- --></A>
173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
175<TD COLSPAN=2><FONT SIZE="+2">
176<B>Method Summary</B></FONT></TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>&nbsp;void</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#addText(java.lang.String)">addText</A></B>(java.lang.String&nbsp;msg)</CODE>
182
183<BR>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a multiline message.</TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/condition/ConditionBase.html" title="class in org.apache.tools.ant.taskdefs.condition">ConditionBase</A></CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#createCondition()">createCondition</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a condition element.</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>&nbsp;void</CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#execute()">execute</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Throw a <CODE>BuildException</CODE> to exit (fail) the build.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;void</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#setIf(java.lang.String)">setIf</A></B>(java.lang.String&nbsp;c)</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Only fail if a property of the given name exists in the current project.</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;void</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#setMessage(java.lang.String)">setMessage</A></B>(java.lang.String&nbsp;value)</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A message giving further information on why the build exited.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>&nbsp;void</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#setStatus(int)">setStatus</A></B>(int&nbsp;i)</CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the status code to associate with the thrown Exception.</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;void</CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Exit.html#setUnless(java.lang.String)">setUnless</A></B>(java.lang.String&nbsp;c)</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Only fail if a property of the given name does not
233 exist in the current project.</TD>
234</TR>
235</TABLE>
236&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
237<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
238<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
239<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>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<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>
243</TR>
244</TABLE>
245&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
246<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
247<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
248<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>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<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>
252</TR>
253</TABLE>
254&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
255<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
256<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
257<TD><B>Methods inherited from class java.lang.Object</B></TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
261</TR>
262</TABLE>
263&nbsp;
264<P>
265
266<!-- ============ FIELD DETAIL =========== -->
267
268
269<!-- ========= CONSTRUCTOR DETAIL ======== -->
270
271<A NAME="constructor_detail"><!-- --></A>
272<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
273<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
274<TD COLSPAN=1><FONT SIZE="+2">
275<B>Constructor Detail</B></FONT></TD>
276</TR>
277</TABLE>
278
279<A NAME="Exit()"><!-- --></A><H3>
280Exit</H3>
281<PRE>
282public <B>Exit</B>()</PRE>
283<DL>
284</DL>
285
286<!-- ============ METHOD DETAIL ========== -->
287
288<A NAME="method_detail"><!-- --></A>
289<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
290<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
291<TD COLSPAN=1><FONT SIZE="+2">
292<B>Method Detail</B></FONT></TD>
293</TR>
294</TABLE>
295
296<A NAME="setMessage(java.lang.String)"><!-- --></A><H3>
297setMessage</H3>
298<PRE>
299public void <B>setMessage</B>(java.lang.String&nbsp;value)</PRE>
300<DL>
301<DD>A message giving further information on why the build exited.
302<P>
303<DD><DL>
304<DT><B>Parameters:</B><DD><CODE>value</CODE> - message to output</DL>
305</DD>
306</DL>
307<HR>
308
309<A NAME="setIf(java.lang.String)"><!-- --></A><H3>
310setIf</H3>
311<PRE>
312public void <B>setIf</B>(java.lang.String&nbsp;c)</PRE>
313<DL>
314<DD>Only fail if a property of the given name exists in the current project.
315<P>
316<DD><DL>
317<DT><B>Parameters:</B><DD><CODE>c</CODE> - property name</DL>
318</DD>
319</DL>
320<HR>
321
322<A NAME="setUnless(java.lang.String)"><!-- --></A><H3>
323setUnless</H3>
324<PRE>
325public void <B>setUnless</B>(java.lang.String&nbsp;c)</PRE>
326<DL>
327<DD>Only fail if a property of the given name does not
328 exist in the current project.
329<P>
330<DD><DL>
331<DT><B>Parameters:</B><DD><CODE>c</CODE> - property name</DL>
332</DD>
333</DL>
334<HR>
335
336<A NAME="setStatus(int)"><!-- --></A><H3>
337setStatus</H3>
338<PRE>
339public void <B>setStatus</B>(int&nbsp;i)</PRE>
340<DL>
341<DD>Set the status code to associate with the thrown Exception.
342<P>
343<DD><DL>
344<DT><B>Parameters:</B><DD><CODE>i</CODE> - the <CODE>int</CODE> status</DL>
345</DD>
346</DL>
347<HR>
348
349<A NAME="execute()"><!-- --></A><H3>
350execute</H3>
351<PRE>
352public void <B>execute</B>()
353 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
354<DL>
355<DD>Throw a <CODE>BuildException</CODE> to exit (fail) the build.
356 If specified, evaluate conditions:
357 A single nested condition is accepted, but requires that the
358 <CODE>if</CODE>/<code>unless</code> attributes be omitted.
359 If the nested condition evaluates to true, or the
360 ifCondition is true or unlessCondition is false, the build will exit.
361 The error message is constructed from the text fields, from
362 the nested condition (if specified), or finally from
363 the if and unless parameters (if present).
364<P>
365<DD><DL>
366<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>
367</DD>
368<DD><DL>
369
370<DT><B>Throws:</B>
371<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - on error</DL>
372</DD>
373</DL>
374<HR>
375
376<A NAME="addText(java.lang.String)"><!-- --></A><H3>
377addText</H3>
378<PRE>
379public void <B>addText</B>(java.lang.String&nbsp;msg)</PRE>
380<DL>
381<DD>Set a multiline message.
382<P>
383<DD><DL>
384<DT><B>Parameters:</B><DD><CODE>msg</CODE> - the message to display</DL>
385</DD>
386</DL>
387<HR>
388
389<A NAME="createCondition()"><!-- --></A><H3>
390createCondition</H3>
391<PRE>
392public <A HREF="../../../../../org/apache/tools/ant/taskdefs/condition/ConditionBase.html" title="class in org.apache.tools.ant.taskdefs.condition">ConditionBase</A> <B>createCondition</B>()</PRE>
393<DL>
394<DD>Add a condition element.
395<P>
396<DD><DL>
397
398<DT><B>Returns:</B><DD><CODE>ConditionBase</CODE>.<DT><B>Since:</B></DT>
399 <DD>Ant 1.6.2</DD>
400</DL>
401</DD>
402</DL>
403<!-- ========= END OF CLASS DATA ========= -->
404<HR>
405
406
407<!-- ======= START OF BOTTOM NAVBAR ====== -->
408<A NAME="navbar_bottom"><!-- --></A>
409<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
410<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
411<TR>
412<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
413<A NAME="navbar_bottom_firstrow"><!-- --></A>
414<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
415 <TR ALIGN="center" VALIGN="top">
416 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
417 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
418 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
419 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
420 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
423 </TR>
424</TABLE>
425</TD>
426<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
427</EM>
428</TD>
429</TR>
430
431<TR>
432<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
433&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/ExecuteWatchdog.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
434&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Expand.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
435<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
436 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
437&nbsp;<A HREF="Exit.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
438&nbsp;<SCRIPT type="text/javascript">
439 <!--
440 if(window==top) {
441 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
442 }
443 //-->
444</SCRIPT>
445<NOSCRIPT>
446 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
447</NOSCRIPT>
448
449</FONT></TD>
450</TR>
451<TR>
452<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
453 SUMMARY:&nbsp;NESTED&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>
454<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
455DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
456</TR>
457</TABLE>
458<A NAME="skip-navbar_bottom"></A>
459<!-- ======== END OF BOTTOM NAVBAR ======= -->
460
461<HR>
462Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
463</BODY>
464</HTML>
Note: See TracBrowser for help on using the repository browser.