source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/util/facade/FacadeTaskHelper.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 15.6 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:35 NZST 2007 -->
6<TITLE>
7FacadeTaskHelper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.facade.FacadeTaskHelper 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="FacadeTaskHelper (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/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade"><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="FacadeTaskHelper.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;FIELD&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.util.facade</FONT>
85<BR>
86Class FacadeTaskHelper</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.util.facade.FacadeTaskHelper</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>FacadeTaskHelper</B><DT>extends java.lang.Object</DL>
94
95<P>
96Helper class for facade implementations - encapsulates treatment of
97 explicit implementation choices, magic properties and
98 implementation specific command line arguments.
99<P>
100
101<P>
102<DL>
103<DT><B>Since:</B></DT>
104 <DD>Ant 1.5</DD>
105</DL>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111
112<!-- =========== FIELD SUMMARY =========== -->
113
114
115<!-- ======== CONSTRUCTOR SUMMARY ======== -->
116
117<A NAME="constructor_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>Constructor Summary</B></FONT></TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#FacadeTaskHelper(java.lang.String)">FacadeTaskHelper</A></B>(java.lang.String&nbsp;defaultValue)</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#FacadeTaskHelper(java.lang.String, java.lang.String)">FacadeTaskHelper</A></B>(java.lang.String&nbsp;defaultValue,
131 java.lang.String&nbsp;magicValue)</CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
135</TR>
136</TABLE>
137&nbsp;
138<!-- ========== METHOD SUMMARY =========== -->
139
140<A NAME="method_summary"><!-- --></A>
141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
143<TD COLSPAN=2><FONT SIZE="+2">
144<B>Method Summary</B></FONT></TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;void</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#addImplementationArgument(org.apache.tools.ant.util.facade.ImplementationSpecificArgument)">addImplementationArgument</A></B>(<A HREF="../../../../../../org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade">ImplementationSpecificArgument</A>&nbsp;arg)</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Command line argument.</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#getArgs()">getArgs</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the command line arguments enabled for the current
161 facade implementation.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#getExplicitChoice()">getExplicitChoice</A></B>()</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the explicit user choice.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#getImplementation()">getImplementation</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the implementation.</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>&nbsp;boolean</CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#hasBeenSet()">hasBeenSet</A></B>()</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether the implementation has been chosen by the user
186 (either via a magic property or explicitly.</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;void</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#setImplementation(java.lang.String)">setImplementation</A></B>(java.lang.String&nbsp;userChoice)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for explicit user choices.</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;void</CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/facade/FacadeTaskHelper.html#setMagicValue(java.lang.String)">setMagicValue</A></B>(java.lang.String&nbsp;magicValue)</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used to set the value of the magic property.</TD>
203</TR>
204</TABLE>
205&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
208<TD><B>Methods inherited from class java.lang.Object</B></TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
212</TR>
213</TABLE>
214&nbsp;
215<P>
216
217<!-- ============ FIELD DETAIL =========== -->
218
219
220<!-- ========= CONSTRUCTOR DETAIL ======== -->
221
222<A NAME="constructor_detail"><!-- --></A>
223<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
224<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
225<TD COLSPAN=1><FONT SIZE="+2">
226<B>Constructor Detail</B></FONT></TD>
227</TR>
228</TABLE>
229
230<A NAME="FacadeTaskHelper(java.lang.String)"><!-- --></A><H3>
231FacadeTaskHelper</H3>
232<PRE>
233public <B>FacadeTaskHelper</B>(java.lang.String&nbsp;defaultValue)</PRE>
234<DL>
235<DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - The default value for the implementation.
236 Must not be null.</DL>
237<HR>
238
239<A NAME="FacadeTaskHelper(java.lang.String, java.lang.String)"><!-- --></A><H3>
240FacadeTaskHelper</H3>
241<PRE>
242public <B>FacadeTaskHelper</B>(java.lang.String&nbsp;defaultValue,
243 java.lang.String&nbsp;magicValue)</PRE>
244<DL>
245<DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - The default value for the implementation.
246 Must not be null.<DD><CODE>magicValue</CODE> - the value of a magic property that may hold a user.
247 choice. May be null.</DL>
248
249<!-- ============ METHOD DETAIL ========== -->
250
251<A NAME="method_detail"><!-- --></A>
252<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
253<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
254<TD COLSPAN=1><FONT SIZE="+2">
255<B>Method Detail</B></FONT></TD>
256</TR>
257</TABLE>
258
259<A NAME="setMagicValue(java.lang.String)"><!-- --></A><H3>
260setMagicValue</H3>
261<PRE>
262public void <B>setMagicValue</B>(java.lang.String&nbsp;magicValue)</PRE>
263<DL>
264<DD>Used to set the value of the magic property.
265<P>
266<DD><DL>
267<DT><B>Parameters:</B><DD><CODE>magicValue</CODE> - the value of a magic property that may hold a user.</DL>
268</DD>
269</DL>
270<HR>
271
272<A NAME="setImplementation(java.lang.String)"><!-- --></A><H3>
273setImplementation</H3>
274<PRE>
275public void <B>setImplementation</B>(java.lang.String&nbsp;userChoice)</PRE>
276<DL>
277<DD>Used for explicit user choices.
278<P>
279<DD><DL>
280<DT><B>Parameters:</B><DD><CODE>userChoice</CODE> - the explicitly chosen implementation.</DL>
281</DD>
282</DL>
283<HR>
284
285<A NAME="getImplementation()"><!-- --></A><H3>
286getImplementation</H3>
287<PRE>
288public java.lang.String <B>getImplementation</B>()</PRE>
289<DL>
290<DD>Retrieves the implementation.
291<P>
292<DD><DL>
293
294<DT><B>Returns:</B><DD>the implementation.</DL>
295</DD>
296</DL>
297<HR>
298
299<A NAME="getExplicitChoice()"><!-- --></A><H3>
300getExplicitChoice</H3>
301<PRE>
302public java.lang.String <B>getExplicitChoice</B>()</PRE>
303<DL>
304<DD>Retrieves the explicit user choice.
305<P>
306<DD><DL>
307
308<DT><B>Returns:</B><DD>the explicit user choice.</DL>
309</DD>
310</DL>
311<HR>
312
313<A NAME="addImplementationArgument(org.apache.tools.ant.util.facade.ImplementationSpecificArgument)"><!-- --></A><H3>
314addImplementationArgument</H3>
315<PRE>
316public void <B>addImplementationArgument</B>(<A HREF="../../../../../../org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade">ImplementationSpecificArgument</A>&nbsp;arg)</PRE>
317<DL>
318<DD>Command line argument.
319<P>
320<DD><DL>
321<DT><B>Parameters:</B><DD><CODE>arg</CODE> - an argument to add.</DL>
322</DD>
323</DL>
324<HR>
325
326<A NAME="getArgs()"><!-- --></A><H3>
327getArgs</H3>
328<PRE>
329public java.lang.String[] <B>getArgs</B>()</PRE>
330<DL>
331<DD>Retrieves the command line arguments enabled for the current
332 facade implementation.
333<P>
334<DD><DL>
335
336<DT><B>Returns:</B><DD>an array of command line arguements.</DL>
337</DD>
338</DL>
339<HR>
340
341<A NAME="hasBeenSet()"><!-- --></A><H3>
342hasBeenSet</H3>
343<PRE>
344public boolean <B>hasBeenSet</B>()</PRE>
345<DL>
346<DD>Tests whether the implementation has been chosen by the user
347 (either via a magic property or explicitly.
348<P>
349<DD><DL>
350
351<DT><B>Returns:</B><DD>true if magic or user choice has be set.<DT><B>Since:</B></DT>
352 <DD>Ant 1.5.2</DD>
353</DL>
354</DD>
355</DL>
356<!-- ========= END OF CLASS DATA ========= -->
357<HR>
358
359
360<!-- ======= START OF BOTTOM NAVBAR ====== -->
361<A NAME="navbar_bottom"><!-- --></A>
362<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
363<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
364<TR>
365<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
366<A NAME="navbar_bottom_firstrow"><!-- --></A>
367<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
368 <TR ALIGN="center" VALIGN="top">
369 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
370 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
371 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
372 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
373 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
374 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
375 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
376 </TR>
377</TABLE>
378</TD>
379<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
380</EM>
381</TD>
382</TR>
383
384<TR>
385<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
386&nbsp;PREV CLASS&nbsp;
387&nbsp;<A HREF="../../../../../../org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.util.facade"><B>NEXT CLASS</B></A></FONT></TD>
388<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
389 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
390&nbsp;<A HREF="FacadeTaskHelper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
391&nbsp;<SCRIPT type="text/javascript">
392 <!--
393 if(window==top) {
394 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
395 }
396 //-->
397</SCRIPT>
398<NOSCRIPT>
399 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
400</NOSCRIPT>
401
402</FONT></TD>
403</TR>
404<TR>
405<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
406 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
407<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
408DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
409</TR>
410</TABLE>
411<A NAME="skip-navbar_bottom"></A>
412<!-- ======== END OF BOTTOM NAVBAR ======= -->
413
414<HR>
415Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
416</BODY>
417</HTML>
Note: See TracBrowser for help on using the repository browser.