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

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

initial import of LiRK3

File size: 40.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:15 NZST 2007 -->
6<TITLE>
7ProjectHelper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.ProjectHelper 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="ProjectHelper (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/ProjectComponent.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../org/apache/tools/ant/PropertyHelper.html" title="class in org.apache.tools.ant"><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="ProjectHelper.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="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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</FONT>
85<BR>
86Class ProjectHelper</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.ProjectHelper</B>
90</PRE>
91<DL>
92<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/tools/ant/helper/ProjectHelper2.html" title="class in org.apache.tools.ant.helper">ProjectHelper2</A>, <A HREF="../../../../org/apache/tools/ant/helper/ProjectHelperImpl.html" title="class in org.apache.tools.ant.helper">ProjectHelperImpl</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>ProjectHelper</B><DT>extends java.lang.Object</DL>
97
98<P>
99Configures a Project (complete with Targets and Tasks) based on
100 a XML build file. It'll rely on a plugin to do the actual processing
101 of the xml file.
102
103 This class also provide static wrappers for common introspection.
104
105 All helper plugins must provide backward compatibility with the
106 original ant patterns, unless a different behavior is explicitly
107 specified. For example, if namespace is used on the &lt;project&gt; tag
108 the helper can expect the entire build file to be namespace-enabled.
109 Namespaces or helper-specific tags can provide meta-information to
110 the helper, allowing it to use new ( or different policies ).
111
112 However, if no namespace is used the behavior should be exactly
113 identical with the default helper.
114<P>
115
116<P>
117<HR>
118
119<P>
120<!-- ======== NESTED CLASS SUMMARY ======== -->
121
122
123<!-- =========== FIELD SUMMARY =========== -->
124
125<A NAME="field_summary"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TD COLSPAN=2><FONT SIZE="+2">
129<B>Field Summary</B></FONT></TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANT_CORE_URI">ANT_CORE_URI</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The URI for ant name space</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANT_CURRENT_URI">ANT_CURRENT_URI</A></B></CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The URI for antlib current definitions</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANT_TYPE">ANT_TYPE</A></B></CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Polymorphic attribute</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#ANTLIB_URI">ANTLIB_URI</A></B></CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The URI for defined types/tasks - the format is antlib:<package></TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#HELPER_PROPERTY">HELPER_PROPERTY</A></B></CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of JVM system property which provides the name of the
170 ProjectHelper class to use.</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#SERVICE_ID">SERVICE_ID</A></B></CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The service identifier in jars which provide Project Helper
179 implementations.</TD>
180</TR>
181</TABLE>
182&nbsp;
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/ProjectHelper.html#ProjectHelper()">ProjectHelper</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor</TD>
196</TR>
197</TABLE>
198&nbsp;
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>static&nbsp;<A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#addLocationToBuildException(org.apache.tools.ant.BuildException, org.apache.tools.ant.Location)">addLocationToBuildException</A></B>(<A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A>&nbsp;ex,
211 <A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A>&nbsp;newLocation)</CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add location to build exception.</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>static&nbsp;void</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#addText(org.apache.tools.ant.Project, java.lang.Object, char[], int, int)">addText</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
220 java.lang.Object&nbsp;target,
221 char[]&nbsp;buf,
222 int&nbsp;start,
223 int&nbsp;count)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the content of #PCDATA sections to an element.</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>static&nbsp;void</CODE></FONT></TD>
231<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#addText(org.apache.tools.ant.Project, java.lang.Object, java.lang.String)">addText</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
232 java.lang.Object&nbsp;target,
233 java.lang.String&nbsp;text)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the content of #PCDATA sections to an element.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>static&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#configure(java.lang.Object, org.xml.sax.AttributeList, org.apache.tools.ant.Project)">configure</A></B>(java.lang.Object&nbsp;target,
242 org.xml.sax.AttributeList&nbsp;attrs,
243 <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use IntrospectionHelper for each property</I></TD>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250<CODE>static&nbsp;void</CODE></FONT></TD>
251<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#configureProject(org.apache.tools.ant.Project, java.io.File)">configureProject</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
252 java.io.File&nbsp;buildFile)</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use the non-static parse method</I></TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
260<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#extractNameFromComponentName(java.lang.String)">extractNameFromComponentName</A></B>(java.lang.String&nbsp;componentName)</CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extract the element name from a component name</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#extractUriFromComponentName(java.lang.String)">extractUriFromComponentName</A></B>(java.lang.String&nbsp;componentName)</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extract a uri from a component name</TD>
272</TR>
273<TR BGCOLOR="white" CLASS="TableRowColor">
274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
276<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#genComponentName(java.lang.String, java.lang.String)">genComponentName</A></B>(java.lang.String&nbsp;uri,
277 java.lang.String&nbsp;name)</CODE>
278
279<BR>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Map a namespaced {uri,name} to an internal string format.</TD>
281</TR>
282<TR BGCOLOR="white" CLASS="TableRowColor">
283<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284<CODE>static&nbsp;java.lang.ClassLoader</CODE></FONT></TD>
285<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getContextClassLoader()">getContextClassLoader</A></B>()</CODE>
286
287<BR>
288&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use LoaderUtils.getContextClassLoader()</I></TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292<CODE>&nbsp;java.util.Vector</CODE></FONT></TD>
293<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getImportStack()">getImportStack</A></B>()</CODE>
294
295<BR>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;EXPERIMENTAL WILL_CHANGE
297 Import stack.</TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301<CODE>static&nbsp;<A HREF="../../../../org/apache/tools/ant/ProjectHelper.html" title="class in org.apache.tools.ant">ProjectHelper</A></CODE></FONT></TD>
302<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#getProjectHelper()">getProjectHelper</A></B>()</CODE>
303
304<BR>
305&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Discovers a project helper instance.</TD>
306</TR>
307<TR BGCOLOR="white" CLASS="TableRowColor">
308<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309<CODE>&nbsp;void</CODE></FONT></TD>
310<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#parse(org.apache.tools.ant.Project, java.lang.Object)">parse</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
311 java.lang.Object&nbsp;source)</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parses the project file, configuring the project as it goes.</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>static&nbsp;void</CODE></FONT></TD>
319<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#parsePropertyString(java.lang.String, java.util.Vector, java.util.Vector)">parsePropertyString</A></B>(java.lang.String&nbsp;value,
320 java.util.Vector&nbsp;fragments,
321 java.util.Vector&nbsp;propertyRefs)</CODE>
322
323<BR>
324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use PropertyHelper</I></TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
329<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#replaceProperties(org.apache.tools.ant.Project, java.lang.String)">replaceProperties</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
330 java.lang.String&nbsp;value)</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use project.replaceProperties()</I></TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
338<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#replaceProperties(org.apache.tools.ant.Project, java.lang.String, java.util.Hashtable)">replaceProperties</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
339 java.lang.String&nbsp;value,
340 java.util.Hashtable&nbsp;keys)</CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use PropertyHelper</I></TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>static&nbsp;void</CODE></FONT></TD>
348<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ProjectHelper.html#storeChild(org.apache.tools.ant.Project, java.lang.Object, java.lang.Object, java.lang.String)">storeChild</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
349 java.lang.Object&nbsp;parent,
350 java.lang.Object&nbsp;child,
351 java.lang.String&nbsp;tag)</CODE>
352
353<BR>
354&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores a configured child element within its parent object.</TD>
355</TR>
356</TABLE>
357&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
358<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
359<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
360<TD><B>Methods inherited from class java.lang.Object</B></TD>
361</TR>
362<TR BGCOLOR="white" CLASS="TableRowColor">
363<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
364</TR>
365</TABLE>
366&nbsp;
367<P>
368
369<!-- ============ FIELD DETAIL =========== -->
370
371<A NAME="field_detail"><!-- --></A>
372<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
373<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
374<TD COLSPAN=1><FONT SIZE="+2">
375<B>Field Detail</B></FONT></TD>
376</TR>
377</TABLE>
378
379<A NAME="ANT_CORE_URI"><!-- --></A><H3>
380ANT_CORE_URI</H3>
381<PRE>
382public static final java.lang.String <B>ANT_CORE_URI</B></PRE>
383<DL>
384<DD>The URI for ant name space
385<P>
386<DL>
387<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANT_CORE_URI">Constant Field Values</A></DL>
388</DL>
389<HR>
390
391<A NAME="ANT_CURRENT_URI"><!-- --></A><H3>
392ANT_CURRENT_URI</H3>
393<PRE>
394public static final java.lang.String <B>ANT_CURRENT_URI</B></PRE>
395<DL>
396<DD>The URI for antlib current definitions
397<P>
398<DL>
399<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANT_CURRENT_URI">Constant Field Values</A></DL>
400</DL>
401<HR>
402
403<A NAME="ANTLIB_URI"><!-- --></A><H3>
404ANTLIB_URI</H3>
405<PRE>
406public static final java.lang.String <B>ANTLIB_URI</B></PRE>
407<DL>
408<DD>The URI for defined types/tasks - the format is antlib:<package>
409<P>
410<DL>
411<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANTLIB_URI">Constant Field Values</A></DL>
412</DL>
413<HR>
414
415<A NAME="ANT_TYPE"><!-- --></A><H3>
416ANT_TYPE</H3>
417<PRE>
418public static final java.lang.String <B>ANT_TYPE</B></PRE>
419<DL>
420<DD>Polymorphic attribute
421<P>
422<DL>
423<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.ANT_TYPE">Constant Field Values</A></DL>
424</DL>
425<HR>
426
427<A NAME="HELPER_PROPERTY"><!-- --></A><H3>
428HELPER_PROPERTY</H3>
429<PRE>
430public static final java.lang.String <B>HELPER_PROPERTY</B></PRE>
431<DL>
432<DD>Name of JVM system property which provides the name of the
433 ProjectHelper class to use.
434<P>
435<DL>
436<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.HELPER_PROPERTY">Constant Field Values</A></DL>
437</DL>
438<HR>
439
440<A NAME="SERVICE_ID"><!-- --></A><H3>
441SERVICE_ID</H3>
442<PRE>
443public static final java.lang.String <B>SERVICE_ID</B></PRE>
444<DL>
445<DD>The service identifier in jars which provide Project Helper
446 implementations.
447<P>
448<DL>
449<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.tools.ant.ProjectHelper.SERVICE_ID">Constant Field Values</A></DL>
450</DL>
451
452<!-- ========= CONSTRUCTOR DETAIL ======== -->
453
454<A NAME="constructor_detail"><!-- --></A>
455<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
456<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
457<TD COLSPAN=1><FONT SIZE="+2">
458<B>Constructor Detail</B></FONT></TD>
459</TR>
460</TABLE>
461
462<A NAME="ProjectHelper()"><!-- --></A><H3>
463ProjectHelper</H3>
464<PRE>
465public <B>ProjectHelper</B>()</PRE>
466<DL>
467<DD>Default constructor
468<P>
469</DL>
470
471<!-- ============ METHOD DETAIL ========== -->
472
473<A NAME="method_detail"><!-- --></A>
474<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
475<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
476<TD COLSPAN=1><FONT SIZE="+2">
477<B>Method Detail</B></FONT></TD>
478</TR>
479</TABLE>
480
481<A NAME="configureProject(org.apache.tools.ant.Project, java.io.File)"><!-- --></A><H3>
482configureProject</H3>
483<PRE>
484public static void <B>configureProject</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
485 java.io.File&nbsp;buildFile)
486 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
487<DL>
488<DD><B>Deprecated.</B>&nbsp;<I>Use the non-static parse method</I>
489<P>
490<DD>Configures the project with the contents of the specified XML file.
491<P>
492<DD><DL>
493<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project to configure. Must not be <code>null</code>.<DD><CODE>buildFile</CODE> - An XML file giving the project's configuration.
494 Must not be <code>null</code>.
495<DT><B>Throws:</B>
496<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the configuration is invalid or cannot
497 be read</DL>
498</DD>
499</DL>
500<HR>
501
502<A NAME="getImportStack()"><!-- --></A><H3>
503getImportStack</H3>
504<PRE>
505public java.util.Vector <B>getImportStack</B>()</PRE>
506<DL>
507<DD>EXPERIMENTAL WILL_CHANGE
508 Import stack.
509 Used to keep track of imported files. Error reporting should
510 display the import path.
511<P>
512<DD><DL>
513
514<DT><B>Returns:</B><DD>the stack of import source objects.</DL>
515</DD>
516</DL>
517<HR>
518
519<A NAME="parse(org.apache.tools.ant.Project, java.lang.Object)"><!-- --></A><H3>
520parse</H3>
521<PRE>
522public void <B>parse</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
523 java.lang.Object&nbsp;source)
524 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
525<DL>
526<DD>Parses the project file, configuring the project as it goes.
527<P>
528<DD><DL>
529<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project for the resulting ProjectHelper to configure.
530 Must not be <code>null</code>.<DD><CODE>source</CODE> - The source for XML configuration. A helper must support
531 at least File, for backward compatibility. Helpers may
532 support URL, InputStream, etc or specialized types.
533<DT><B>Throws:</B>
534<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the configuration is invalid or cannot
535 be read<DT><B>Since:</B></DT>
536 <DD>Ant1.5</DD>
537</DL>
538</DD>
539</DL>
540<HR>
541
542<A NAME="getProjectHelper()"><!-- --></A><H3>
543getProjectHelper</H3>
544<PRE>
545public static <A HREF="../../../../org/apache/tools/ant/ProjectHelper.html" title="class in org.apache.tools.ant">ProjectHelper</A> <B>getProjectHelper</B>()
546 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
547<DL>
548<DD>Discovers a project helper instance. Uses the same patterns
549 as JAXP, commons-logging, etc: a system property, a JDK1.3
550 service discovery, default.
551<P>
552<DD><DL>
553
554<DT><B>Returns:</B><DD>a ProjectHelper, either a custom implementation
555 if one is available and configured, or the default implementation
556 otherwise.
557<DT><B>Throws:</B>
558<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if a specified helper class cannot
559 be loaded/instantiated.</DL>
560</DD>
561</DL>
562<HR>
563
564<A NAME="getContextClassLoader()"><!-- --></A><H3>
565getContextClassLoader</H3>
566<PRE>
567public static java.lang.ClassLoader <B>getContextClassLoader</B>()</PRE>
568<DL>
569<DD><B>Deprecated.</B>&nbsp;<I>Use LoaderUtils.getContextClassLoader()</I>
570<P>
571<DD>JDK1.1 compatible access to the context class loader.
572 Cut&paste from JAXP.
573<P>
574<DD><DL>
575
576<DT><B>Returns:</B><DD>the current context class loader, or <code>null</code>
577 if the context class loader is unavailable.</DL>
578</DD>
579</DL>
580<HR>
581
582<A NAME="configure(java.lang.Object, org.xml.sax.AttributeList, org.apache.tools.ant.Project)"><!-- --></A><H3>
583configure</H3>
584<PRE>
585public static void <B>configure</B>(java.lang.Object&nbsp;target,
586 org.xml.sax.AttributeList&nbsp;attrs,
587 <A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)
588 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
589<DL>
590<DD><B>Deprecated.</B>&nbsp;<I>Use IntrospectionHelper for each property</I>
591<P>
592<DD>Configures an object using an introspection handler.
593<P>
594<DD><DL>
595<DT><B>Parameters:</B><DD><CODE>target</CODE> - The target object to be configured.
596 Must not be <code>null</code>.<DD><CODE>attrs</CODE> - A list of attributes to configure within the target.
597 Must not be <code>null</code>.<DD><CODE>project</CODE> - The project containing the target.
598 Must not be <code>null</code>.
599<DT><B>Throws:</B>
600<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if any of the attributes can't be handled by
601 the target</DL>
602</DD>
603</DL>
604<HR>
605
606<A NAME="addText(org.apache.tools.ant.Project, java.lang.Object, char[], int, int)"><!-- --></A><H3>
607addText</H3>
608<PRE>
609public static void <B>addText</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
610 java.lang.Object&nbsp;target,
611 char[]&nbsp;buf,
612 int&nbsp;start,
613 int&nbsp;count)
614 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
615<DL>
616<DD>Adds the content of #PCDATA sections to an element.
617<P>
618<DD><DL>
619<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project containing the target.
620 Must not be <code>null</code>.<DD><CODE>target</CODE> - The target object to be configured.
621 Must not be <code>null</code>.<DD><CODE>buf</CODE> - A character array of the text within the element.
622 Will not be <code>null</code>.<DD><CODE>start</CODE> - The start element in the array.<DD><CODE>count</CODE> - The number of characters to read from the array.
623<DT><B>Throws:</B>
624<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the target object doesn't accept text</DL>
625</DD>
626</DL>
627<HR>
628
629<A NAME="addText(org.apache.tools.ant.Project, java.lang.Object, java.lang.String)"><!-- --></A><H3>
630addText</H3>
631<PRE>
632public static void <B>addText</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
633 java.lang.Object&nbsp;target,
634 java.lang.String&nbsp;text)
635 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
636<DL>
637<DD>Adds the content of #PCDATA sections to an element.
638<P>
639<DD><DL>
640<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project containing the target.
641 Must not be <code>null</code>.<DD><CODE>target</CODE> - The target object to be configured.
642 Must not be <code>null</code>.<DD><CODE>text</CODE> - Text to add to the target.
643 May be <code>null</code>, in which case this
644 method call is a no-op.
645<DT><B>Throws:</B>
646<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the target object doesn't accept text</DL>
647</DD>
648</DL>
649<HR>
650
651<A NAME="storeChild(org.apache.tools.ant.Project, java.lang.Object, java.lang.Object, java.lang.String)"><!-- --></A><H3>
652storeChild</H3>
653<PRE>
654public static void <B>storeChild</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
655 java.lang.Object&nbsp;parent,
656 java.lang.Object&nbsp;child,
657 java.lang.String&nbsp;tag)</PRE>
658<DL>
659<DD>Stores a configured child element within its parent object.
660<P>
661<DD><DL>
662<DT><B>Parameters:</B><DD><CODE>project</CODE> - Project containing the objects.
663 May be <code>null</code>.<DD><CODE>parent</CODE> - Parent object to add child to.
664 Must not be <code>null</code>.<DD><CODE>child</CODE> - Child object to store in parent.
665 Should not be <code>null</code>.<DD><CODE>tag</CODE> - Name of element which generated the child.
666 May be <code>null</code>, in which case
667 the child is not stored.</DL>
668</DD>
669</DL>
670<HR>
671
672<A NAME="replaceProperties(org.apache.tools.ant.Project, java.lang.String)"><!-- --></A><H3>
673replaceProperties</H3>
674<PRE>
675public static java.lang.String <B>replaceProperties</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
676 java.lang.String&nbsp;value)
677 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
678<DL>
679<DD><B>Deprecated.</B>&nbsp;<I>Use project.replaceProperties()</I>
680<P>
681<DD>Replaces <code>${xxx}</code> style constructions in the given value with
682 the string value of the corresponding properties.
683<P>
684<DD><DL>
685<DT><B>Parameters:</B><DD><CODE>project</CODE> - The project containing the properties to replace.
686 Must not be <code>null</code>.<DD><CODE>value</CODE> - The string to be scanned for property references.
687 May be <code>null</code>.
688<DT><B>Returns:</B><DD>the original string with the properties replaced, or
689 <code>null</code> if the original string is <code>null</code>.
690<DT><B>Throws:</B>
691<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the string contains an opening
692 <code>${</code> without a closing
693 <code>}</code><DT><B>Since:</B></DT>
694 <DD>1.5</DD>
695</DL>
696</DD>
697</DL>
698<HR>
699
700<A NAME="replaceProperties(org.apache.tools.ant.Project, java.lang.String, java.util.Hashtable)"><!-- --></A><H3>
701replaceProperties</H3>
702<PRE>
703public static java.lang.String <B>replaceProperties</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
704 java.lang.String&nbsp;value,
705 java.util.Hashtable&nbsp;keys)
706 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
707<DL>
708<DD><B>Deprecated.</B>&nbsp;<I>Use PropertyHelper</I>
709<P>
710<DD>Replaces <code>${xxx}</code> style constructions in the given value
711 with the string value of the corresponding data types.
712<P>
713<DD><DL>
714<DT><B>Parameters:</B><DD><CODE>project</CODE> - The container project. This is used solely for
715 logging purposes. Must not be <code>null</code>.<DD><CODE>value</CODE> - The string to be scanned for property references.
716 May be <code>null</code>, in which case this
717 method returns immediately with no effect.<DD><CODE>keys</CODE> - Mapping (String to String) of property names to their
718 values. Must not be <code>null</code>.
719<DT><B>Returns:</B><DD>the original string with the properties replaced, or
720 <code>null</code> if the original string is <code>null</code>.
721<DT><B>Throws:</B>
722<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the string contains an opening
723 <code>${</code> without a closing
724 <code>}</code></DL>
725</DD>
726</DL>
727<HR>
728
729<A NAME="parsePropertyString(java.lang.String, java.util.Vector, java.util.Vector)"><!-- --></A><H3>
730parsePropertyString</H3>
731<PRE>
732public static void <B>parsePropertyString</B>(java.lang.String&nbsp;value,
733 java.util.Vector&nbsp;fragments,
734 java.util.Vector&nbsp;propertyRefs)
735 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
736<DL>
737<DD><B>Deprecated.</B>&nbsp;<I>Use PropertyHelper</I>
738<P>
739<DD>Parses a string containing <code>${xxx}</code> style property
740 references into two lists. The first list is a collection
741 of text fragments, while the other is a set of string property names.
742 <code>null</code> entries in the first list indicate a property
743 reference from the second list.
744<P>
745<DD><DL>
746<DT><B>Parameters:</B><DD><CODE>value</CODE> - Text to parse. Must not be <code>null</code>.<DD><CODE>fragments</CODE> - List to add text fragments to.
747 Must not be <code>null</code>.<DD><CODE>propertyRefs</CODE> - List to add property names to.
748 Must not be <code>null</code>.
749<DT><B>Throws:</B>
750<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the string contains an opening
751 <code>${</code> without a closing
752 <code>}</code></DL>
753</DD>
754</DL>
755<HR>
756
757<A NAME="genComponentName(java.lang.String, java.lang.String)"><!-- --></A><H3>
758genComponentName</H3>
759<PRE>
760public static java.lang.String <B>genComponentName</B>(java.lang.String&nbsp;uri,
761 java.lang.String&nbsp;name)</PRE>
762<DL>
763<DD>Map a namespaced {uri,name} to an internal string format.
764 For BC purposes the names from the ant core uri will be
765 mapped to "name", other names will be mapped to
766 uri + ":" + name.
767<P>
768<DD><DL>
769<DT><B>Parameters:</B><DD><CODE>uri</CODE> - The namepace URI<DD><CODE>name</CODE> - The localname
770<DT><B>Returns:</B><DD>The stringified form of the ns name</DL>
771</DD>
772</DL>
773<HR>
774
775<A NAME="extractUriFromComponentName(java.lang.String)"><!-- --></A><H3>
776extractUriFromComponentName</H3>
777<PRE>
778public static java.lang.String <B>extractUriFromComponentName</B>(java.lang.String&nbsp;componentName)</PRE>
779<DL>
780<DD>extract a uri from a component name
781<P>
782<DD><DL>
783<DT><B>Parameters:</B><DD><CODE>componentName</CODE> - The stringified form for {uri, name}
784<DT><B>Returns:</B><DD>The uri or "" if not present</DL>
785</DD>
786</DL>
787<HR>
788
789<A NAME="extractNameFromComponentName(java.lang.String)"><!-- --></A><H3>
790extractNameFromComponentName</H3>
791<PRE>
792public static java.lang.String <B>extractNameFromComponentName</B>(java.lang.String&nbsp;componentName)</PRE>
793<DL>
794<DD>extract the element name from a component name
795<P>
796<DD><DL>
797<DT><B>Parameters:</B><DD><CODE>componentName</CODE> - The stringified form for {uri, name}
798<DT><B>Returns:</B><DD>The element name of the component</DL>
799</DD>
800</DL>
801<HR>
802
803<A NAME="addLocationToBuildException(org.apache.tools.ant.BuildException, org.apache.tools.ant.Location)"><!-- --></A><H3>
804addLocationToBuildException</H3>
805<PRE>
806public static <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A> <B>addLocationToBuildException</B>(<A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A>&nbsp;ex,
807 <A HREF="../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A>&nbsp;newLocation)</PRE>
808<DL>
809<DD>Add location to build exception.
810<P>
811<DD><DL>
812<DT><B>Parameters:</B><DD><CODE>ex</CODE> - the build exception, if the build exception
813 does not include<DD><CODE>newLocation</CODE> - the location of the calling task (may be null)
814<DT><B>Returns:</B><DD>a new build exception based in the build exception with
815 location set to newLocation. If the original exception
816 did not have a location, just return the build exception</DL>
817</DD>
818</DL>
819<!-- ========= END OF CLASS DATA ========= -->
820<HR>
821
822
823<!-- ======= START OF BOTTOM NAVBAR ====== -->
824<A NAME="navbar_bottom"><!-- --></A>
825<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
826<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
827<TR>
828<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
829<A NAME="navbar_bottom_firstrow"><!-- --></A>
830<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
831 <TR ALIGN="center" VALIGN="top">
832 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
833 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
834 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
835 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
836 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
837 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
838 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
839 </TR>
840</TABLE>
841</TD>
842<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
843</EM>
844</TD>
845</TR>
846
847<TR>
848<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
849&nbsp;<A HREF="../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>&nbsp;
850&nbsp;<A HREF="../../../../org/apache/tools/ant/PropertyHelper.html" title="class in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD>
851<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
852 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
853&nbsp;<A HREF="ProjectHelper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
854&nbsp;<SCRIPT type="text/javascript">
855 <!--
856 if(window==top) {
857 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
858 }
859 //-->
860</SCRIPT>
861<NOSCRIPT>
862 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
863</NOSCRIPT>
864
865</FONT></TD>
866</TR>
867<TR>
868<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
869 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
870<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
871DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
872</TR>
873</TABLE>
874<A NAME="skip-navbar_bottom"></A>
875<!-- ======== END OF BOTTOM NAVBAR ======= -->
876
877<HR>
878Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
879</BODY>
880</HTML>
Note: See TracBrowser for help on using the repository browser.