source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/ComponentHelper.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: 34.2 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:14 NZST 2007 -->
6<TITLE>
7ComponentHelper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.ComponentHelper 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="ComponentHelper (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/BuildEvent.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../org/apache/tools/ant/DefaultLogger.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="ComponentHelper.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</FONT>
85<BR>
86Class ComponentHelper</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.ComponentHelper</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>ComponentHelper</B><DT>extends java.lang.Object</DL>
94
95<P>
96Component creation and configuration.
97
98 The class is based around handing component
99 definitions in an AntTypeTable.
100
101 The old task/type methods have been kept
102 for backward compatibly.
103 Project will just delegate its calls to this class.
104
105 A very simple hook mechanism is provided that allows users to plug
106 in custom code. It is also possible to replace the default behavior
107 ( for example in an app embedding ant )
108<P>
109
110<P>
111<DL>
112<DT><B>Since:</B></DT>
113 <DD>Ant1.6</DD>
114</DL>
115<HR>
116
117<P>
118<!-- ======== NESTED CLASS SUMMARY ======== -->
119
120
121<!-- =========== FIELD SUMMARY =========== -->
122
123
124<!-- ======== CONSTRUCTOR SUMMARY ======== -->
125
126<A NAME="constructor_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TD COLSPAN=2><FONT SIZE="+2">
130<B>Constructor Summary</B></FONT></TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>protected </CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#ComponentHelper()">ComponentHelper</A></B>()</CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ComponentHelper instance.</TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- ========== METHOD SUMMARY =========== -->
143
144<A NAME="method_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TD COLSPAN=2><FONT SIZE="+2">
148<B>Method Summary</B></FONT></TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>&nbsp;void</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#addDataTypeDefinition(org.apache.tools.ant.AntTypeDefinition)">addDataTypeDefinition</A></B>(<A HREF="../../../../org/apache/tools/ant/AntTypeDefinition.html" title="class in org.apache.tools.ant">AntTypeDefinition</A>&nbsp;def)</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Describe <code>addDataTypeDefinition</code> method here.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;void</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#addDataTypeDefinition(java.lang.String, java.lang.Class)">addDataTypeDefinition</A></B>(java.lang.String&nbsp;typeName,
162 java.lang.Class&nbsp;typeClass)</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a new datatype definition.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#addTaskDefinition(java.lang.String, java.lang.Class)">addTaskDefinition</A></B>(java.lang.String&nbsp;taskName,
171 java.lang.Class&nbsp;taskClass)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a new task definition to the project.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#checkTaskClass(java.lang.Class)">checkTaskClass</A></B>(java.lang.Class&nbsp;taskClass)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether or not a class is suitable for serving as Ant task.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#createComponent(java.lang.String)">createComponent</A></B>(java.lang.String&nbsp;componentName)</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an object for a component.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#createComponent(org.apache.tools.ant.UnknownElement, java.lang.String, java.lang.String)">createComponent</A></B>(<A HREF="../../../../org/apache/tools/ant/UnknownElement.html" title="class in org.apache.tools.ant">UnknownElement</A>&nbsp;ue,
196 java.lang.String&nbsp;ns,
197 java.lang.String&nbsp;componentType)</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Factory method to create the components.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#createDataType(java.lang.String)">createDataType</A></B>(java.lang.String&nbsp;typeName)</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance of a data type.</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;<A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#createTask(java.lang.String)">createTask</A></B>(java.lang.String&nbsp;taskType)</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance of a task, adding it to a list of
217 created tasks for later invalidation.</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>&nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#enterAntLib(java.lang.String)">enterAntLib</A></B>(java.lang.String&nbsp;uri)</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called at the start of processing an antlib.</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;void</CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#exitAntLib()">exitAntLib</A></B>()</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called at the end of processing an antlib.</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>&nbsp;java.util.Hashtable</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getAntTypeTable()">getAntTypeTable</A></B>()</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current datatype definition hashtable.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>&nbsp;java.lang.Class</CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getComponentClass(java.lang.String)">getComponentClass</A></B>(java.lang.String&nbsp;componentName)</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the class of the component name.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>static&nbsp;<A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A></CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getComponentHelper(org.apache.tools.ant.Project)">getComponentHelper</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Find a project component for a specific project, creating
258 it if it does not exist.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getCurrentAntlibUri()">getCurrentAntlibUri</A></B>()</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>&nbsp;java.util.Hashtable</CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getDataTypeDefinitions()">getDataTypeDefinitions</A></B>()</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current type definition hashtable.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;<A HREF="../../../../org/apache/tools/ant/AntTypeDefinition.html" title="class in org.apache.tools.ant">AntTypeDefinition</A></CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getDefinition(java.lang.String)">getDefinition</A></B>(java.lang.String&nbsp;componentName)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the antTypeDefinition for a componentName.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getElementName(java.lang.Object)">getElementName</A></B>(java.lang.Object&nbsp;element)</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a description of the type of the given element.</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;<A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A></CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getNext()">getNext</A></B>()</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the next chained component helper.</TD>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302<CODE>&nbsp;java.util.Hashtable</CODE></FONT></TD>
303<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#getTaskDefinitions()">getTaskDefinitions</A></B>()</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current task definition hashtable.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>&nbsp;void</CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#initDefaultDefinitions()">initDefaultDefinitions</A></B>()</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is initialization code implementing the original ant component
315 loading from /org/apache/tools/ant/taskdefs/default.properties
316 and /org/apache/tools/ant/types/default.properties.</TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320<CODE>&nbsp;void</CODE></FONT></TD>
321<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#initSubProject(org.apache.tools.ant.ComponentHelper)">initSubProject</A></B>(<A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A>&nbsp;helper)</CODE>
322
323<BR>
324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used with creating child projects.</TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328<CODE>&nbsp;void</CODE></FONT></TD>
329<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#setNext(org.apache.tools.ant.ComponentHelper)">setNext</A></B>(<A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A>&nbsp;next)</CODE>
330
331<BR>
332&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the next chained component helper.</TD>
333</TR>
334<TR BGCOLOR="white" CLASS="TableRowColor">
335<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336<CODE>&nbsp;void</CODE></FONT></TD>
337<TD><CODE><B><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#setProject(org.apache.tools.ant.Project)">setProject</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</CODE>
338
339<BR>
340&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the project for this component helper.</TD>
341</TR>
342</TABLE>
343&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
344<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
345<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
346<TD><B>Methods inherited from class java.lang.Object</B></TD>
347</TR>
348<TR BGCOLOR="white" CLASS="TableRowColor">
349<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
350</TR>
351</TABLE>
352&nbsp;
353<P>
354
355<!-- ============ FIELD DETAIL =========== -->
356
357
358<!-- ========= CONSTRUCTOR DETAIL ======== -->
359
360<A NAME="constructor_detail"><!-- --></A>
361<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
362<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
363<TD COLSPAN=1><FONT SIZE="+2">
364<B>Constructor Detail</B></FONT></TD>
365</TR>
366</TABLE>
367
368<A NAME="ComponentHelper()"><!-- --></A><H3>
369ComponentHelper</H3>
370<PRE>
371protected <B>ComponentHelper</B>()</PRE>
372<DL>
373<DD>Creates a new ComponentHelper instance.
374<P>
375</DL>
376
377<!-- ============ METHOD DETAIL ========== -->
378
379<A NAME="method_detail"><!-- --></A>
380<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
381<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
382<TD COLSPAN=1><FONT SIZE="+2">
383<B>Method Detail</B></FONT></TD>
384</TR>
385</TABLE>
386
387<A NAME="getComponentHelper(org.apache.tools.ant.Project)"><!-- --></A><H3>
388getComponentHelper</H3>
389<PRE>
390public static <A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A> <B>getComponentHelper</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</PRE>
391<DL>
392<DD>Find a project component for a specific project, creating
393 it if it does not exist.
394<P>
395<DD><DL>
396<DT><B>Parameters:</B><DD><CODE>project</CODE> - the project.
397<DT><B>Returns:</B><DD>the project component for a specific project.</DL>
398</DD>
399</DL>
400<HR>
401
402<A NAME="setNext(org.apache.tools.ant.ComponentHelper)"><!-- --></A><H3>
403setNext</H3>
404<PRE>
405public void <B>setNext</B>(<A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A>&nbsp;next)</PRE>
406<DL>
407<DD>Set the next chained component helper.
408<P>
409<DD><DL>
410<DT><B>Parameters:</B><DD><CODE>next</CODE> - the next chained component helper.</DL>
411</DD>
412</DL>
413<HR>
414
415<A NAME="getNext()"><!-- --></A><H3>
416getNext</H3>
417<PRE>
418public <A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A> <B>getNext</B>()</PRE>
419<DL>
420<DD>Get the next chained component helper.
421<P>
422<DD><DL>
423
424<DT><B>Returns:</B><DD>the next chained component helper.</DL>
425</DD>
426</DL>
427<HR>
428
429<A NAME="setProject(org.apache.tools.ant.Project)"><!-- --></A><H3>
430setProject</H3>
431<PRE>
432public void <B>setProject</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project)</PRE>
433<DL>
434<DD>Sets the project for this component helper.
435<P>
436<DD><DL>
437<DT><B>Parameters:</B><DD><CODE>project</CODE> - the project for this helper.</DL>
438</DD>
439</DL>
440<HR>
441
442<A NAME="initSubProject(org.apache.tools.ant.ComponentHelper)"><!-- --></A><H3>
443initSubProject</H3>
444<PRE>
445public void <B>initSubProject</B>(<A HREF="../../../../org/apache/tools/ant/ComponentHelper.html" title="class in org.apache.tools.ant">ComponentHelper</A>&nbsp;helper)</PRE>
446<DL>
447<DD>Used with creating child projects. Each child
448 project inherits the component definitions
449 from its parent.
450<P>
451<DD><DL>
452<DT><B>Parameters:</B><DD><CODE>helper</CODE> - the component helper of the parent project.</DL>
453</DD>
454</DL>
455<HR>
456
457<A NAME="createComponent(org.apache.tools.ant.UnknownElement, java.lang.String, java.lang.String)"><!-- --></A><H3>
458createComponent</H3>
459<PRE>
460public java.lang.Object <B>createComponent</B>(<A HREF="../../../../org/apache/tools/ant/UnknownElement.html" title="class in org.apache.tools.ant">UnknownElement</A>&nbsp;ue,
461 java.lang.String&nbsp;ns,
462 java.lang.String&nbsp;componentType)
463 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
464<DL>
465<DD>Factory method to create the components.
466
467 This should be called by UnknownElement.
468<P>
469<DD><DL>
470<DT><B>Parameters:</B><DD><CODE>ue</CODE> - The Unknown Element creating this component.<DD><CODE>ns</CODE> - Namespace URI. Also available as ue.getNamespace().<DD><CODE>componentType</CODE> - The component type,
471 Also available as ue.getComponentName().
472<DT><B>Returns:</B><DD>the created component.
473<DT><B>Throws:</B>
474<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if an error occurs.</DL>
475</DD>
476</DL>
477<HR>
478
479<A NAME="createComponent(java.lang.String)"><!-- --></A><H3>
480createComponent</H3>
481<PRE>
482public java.lang.Object <B>createComponent</B>(java.lang.String&nbsp;componentName)</PRE>
483<DL>
484<DD>Create an object for a component.
485<P>
486<DD><DL>
487<DT><B>Parameters:</B><DD><CODE>componentName</CODE> - the name of the component, if
488 the component is in a namespace, the
489 name is prefixed with the namespace uri and ":".
490<DT><B>Returns:</B><DD>the class if found or null if not.</DL>
491</DD>
492</DL>
493<HR>
494
495<A NAME="getComponentClass(java.lang.String)"><!-- --></A><H3>
496getComponentClass</H3>
497<PRE>
498public java.lang.Class <B>getComponentClass</B>(java.lang.String&nbsp;componentName)</PRE>
499<DL>
500<DD>Return the class of the component name.
501<P>
502<DD><DL>
503<DT><B>Parameters:</B><DD><CODE>componentName</CODE> - the name of the component, if
504 the component is in a namespace, the
505 name is prefixed with the namespace uri and ":".
506<DT><B>Returns:</B><DD>the class if found or null if not.</DL>
507</DD>
508</DL>
509<HR>
510
511<A NAME="getDefinition(java.lang.String)"><!-- --></A><H3>
512getDefinition</H3>
513<PRE>
514public <A HREF="../../../../org/apache/tools/ant/AntTypeDefinition.html" title="class in org.apache.tools.ant">AntTypeDefinition</A> <B>getDefinition</B>(java.lang.String&nbsp;componentName)</PRE>
515<DL>
516<DD>Return the antTypeDefinition for a componentName.
517<P>
518<DD><DL>
519<DT><B>Parameters:</B><DD><CODE>componentName</CODE> - the name of the component.
520<DT><B>Returns:</B><DD>the ant definition or null if not present.</DL>
521</DD>
522</DL>
523<HR>
524
525<A NAME="initDefaultDefinitions()"><!-- --></A><H3>
526initDefaultDefinitions</H3>
527<PRE>
528public void <B>initDefaultDefinitions</B>()</PRE>
529<DL>
530<DD>This method is initialization code implementing the original ant component
531 loading from /org/apache/tools/ant/taskdefs/default.properties
532 and /org/apache/tools/ant/types/default.properties.
533<P>
534<DD><DL>
535</DL>
536</DD>
537</DL>
538<HR>
539
540<A NAME="addTaskDefinition(java.lang.String, java.lang.Class)"><!-- --></A><H3>
541addTaskDefinition</H3>
542<PRE>
543public void <B>addTaskDefinition</B>(java.lang.String&nbsp;taskName,
544 java.lang.Class&nbsp;taskClass)</PRE>
545<DL>
546<DD>Adds a new task definition to the project.
547 Attempting to override an existing definition with an
548 equivalent one (i.e. with the same classname) results in
549 a verbose log message. Attempting to override an existing definition
550 with a different one results in a warning log message and
551 invalidates any tasks which have already been created with the
552 old definition.
553<P>
554<DD><DL>
555<DT><B>Parameters:</B><DD><CODE>taskName</CODE> - The name of the task to add.
556 Must not be <code>null</code>.<DD><CODE>taskClass</CODE> - The full name of the class implementing the task.
557 Must not be <code>null</code>.
558<DT><B>Throws:</B>
559<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the class is unsuitable for being an Ant
560 task. An error level message is logged before
561 this exception is thrown.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/tools/ant/ComponentHelper.html#checkTaskClass(java.lang.Class)"><CODE>checkTaskClass(Class)</CODE></A></DL>
562</DD>
563</DL>
564<HR>
565
566<A NAME="checkTaskClass(java.lang.Class)"><!-- --></A><H3>
567checkTaskClass</H3>
568<PRE>
569public void <B>checkTaskClass</B>(java.lang.Class&nbsp;taskClass)
570 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
571<DL>
572<DD>Checks whether or not a class is suitable for serving as Ant task.
573 Ant task implementation classes must be public, concrete, and have
574 a no-arg constructor.
575<P>
576<DD><DL>
577<DT><B>Parameters:</B><DD><CODE>taskClass</CODE> - The class to be checked.
578 Must not be <code>null</code>.
579<DT><B>Throws:</B>
580<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the class is unsuitable for being an Ant
581 task. An error level message is logged before
582 this exception is thrown.</DL>
583</DD>
584</DL>
585<HR>
586
587<A NAME="getTaskDefinitions()"><!-- --></A><H3>
588getTaskDefinitions</H3>
589<PRE>
590public java.util.Hashtable <B>getTaskDefinitions</B>()</PRE>
591<DL>
592<DD>Returns the current task definition hashtable. The returned hashtable is
593 "live" and so should not be modified.
594<P>
595<DD><DL>
596
597<DT><B>Returns:</B><DD>a map of from task name to implementing class
598 (String to Class).</DL>
599</DD>
600</DL>
601<HR>
602
603<A NAME="getDataTypeDefinitions()"><!-- --></A><H3>
604getDataTypeDefinitions</H3>
605<PRE>
606public java.util.Hashtable <B>getDataTypeDefinitions</B>()</PRE>
607<DL>
608<DD>Returns the current type definition hashtable. The returned hashtable is
609 "live" and so should not be modified.
610<P>
611<DD><DL>
612
613<DT><B>Returns:</B><DD>a map of from type name to implementing class
614 (String to Class).</DL>
615</DD>
616</DL>
617<HR>
618
619<A NAME="addDataTypeDefinition(java.lang.String, java.lang.Class)"><!-- --></A><H3>
620addDataTypeDefinition</H3>
621<PRE>
622public void <B>addDataTypeDefinition</B>(java.lang.String&nbsp;typeName,
623 java.lang.Class&nbsp;typeClass)</PRE>
624<DL>
625<DD>Adds a new datatype definition.
626 Attempting to override an existing definition with an
627 equivalent one (i.e. with the same classname) results in
628 a verbose log message. Attempting to override an existing definition
629 with a different one results in a warning log message, but the
630 definition is changed.
631<P>
632<DD><DL>
633<DT><B>Parameters:</B><DD><CODE>typeName</CODE> - The name of the datatype.
634 Must not be <code>null</code>.<DD><CODE>typeClass</CODE> - The full name of the class implementing the datatype.
635 Must not be <code>null</code>.</DL>
636</DD>
637</DL>
638<HR>
639
640<A NAME="addDataTypeDefinition(org.apache.tools.ant.AntTypeDefinition)"><!-- --></A><H3>
641addDataTypeDefinition</H3>
642<PRE>
643public void <B>addDataTypeDefinition</B>(<A HREF="../../../../org/apache/tools/ant/AntTypeDefinition.html" title="class in org.apache.tools.ant">AntTypeDefinition</A>&nbsp;def)</PRE>
644<DL>
645<DD>Describe <code>addDataTypeDefinition</code> method here.
646<P>
647<DD><DL>
648<DT><B>Parameters:</B><DD><CODE>def</CODE> - an <code>AntTypeDefinition</code> value.</DL>
649</DD>
650</DL>
651<HR>
652
653<A NAME="getAntTypeTable()"><!-- --></A><H3>
654getAntTypeTable</H3>
655<PRE>
656public java.util.Hashtable <B>getAntTypeTable</B>()</PRE>
657<DL>
658<DD>Returns the current datatype definition hashtable. The returned
659 hashtable is "live" and so should not be modified.
660<P>
661<DD><DL>
662
663<DT><B>Returns:</B><DD>a map of from datatype name to implementing class
664 (String to Class).</DL>
665</DD>
666</DL>
667<HR>
668
669<A NAME="createTask(java.lang.String)"><!-- --></A><H3>
670createTask</H3>
671<PRE>
672public <A HREF="../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> <B>createTask</B>(java.lang.String&nbsp;taskType)
673 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
674<DL>
675<DD>Creates a new instance of a task, adding it to a list of
676 created tasks for later invalidation. This causes all tasks
677 to be remembered until the containing project is removed
678
679 Called from Project.createTask(), which can be called by tasks.
680 The method should be deprecated, as it doesn't support ns and libs.
681<P>
682<DD><DL>
683<DT><B>Parameters:</B><DD><CODE>taskType</CODE> - The name of the task to create an instance of.
684 Must not be <code>null</code>.
685<DT><B>Returns:</B><DD>an instance of the specified task, or <code>null</code> if
686 the task name is not recognised.
687<DT><B>Throws:</B>
688<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the task name is recognised but task
689 creation fails.</DL>
690</DD>
691</DL>
692<HR>
693
694<A NAME="createDataType(java.lang.String)"><!-- --></A><H3>
695createDataType</H3>
696<PRE>
697public java.lang.Object <B>createDataType</B>(java.lang.String&nbsp;typeName)
698 throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
699<DL>
700<DD>Creates a new instance of a data type.
701<P>
702<DD><DL>
703<DT><B>Parameters:</B><DD><CODE>typeName</CODE> - The name of the data type to create an instance of.
704 Must not be <code>null</code>.
705<DT><B>Returns:</B><DD>an instance of the specified data type, or <code>null</code> if
706 the data type name is not recognised.
707<DT><B>Throws:</B>
708<DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the data type name is recognised but
709 instance creation fails.</DL>
710</DD>
711</DL>
712<HR>
713
714<A NAME="getElementName(java.lang.Object)"><!-- --></A><H3>
715getElementName</H3>
716<PRE>
717public java.lang.String <B>getElementName</B>(java.lang.Object&nbsp;element)</PRE>
718<DL>
719<DD>Returns a description of the type of the given element.
720 <p>
721 This is useful for logging purposes.
722<P>
723<DD><DL>
724<DT><B>Parameters:</B><DD><CODE>element</CODE> - The element to describe.
725 Must not be <code>null</code>.
726<DT><B>Returns:</B><DD>a description of the element type.<DT><B>Since:</B></DT>
727 <DD>Ant 1.6</DD>
728</DL>
729</DD>
730</DL>
731<HR>
732
733<A NAME="enterAntLib(java.lang.String)"><!-- --></A><H3>
734enterAntLib</H3>
735<PRE>
736public void <B>enterAntLib</B>(java.lang.String&nbsp;uri)</PRE>
737<DL>
738<DD>Called at the start of processing an antlib.
739<P>
740<DD><DL>
741<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the uri that is associated with this antlib.</DL>
742</DD>
743</DL>
744<HR>
745
746<A NAME="getCurrentAntlibUri()"><!-- --></A><H3>
747getCurrentAntlibUri</H3>
748<PRE>
749public java.lang.String <B>getCurrentAntlibUri</B>()</PRE>
750<DL>
751<DD><DL>
752
753<DT><B>Returns:</B><DD>the current antlib uri.</DL>
754</DD>
755</DL>
756<HR>
757
758<A NAME="exitAntLib()"><!-- --></A><H3>
759exitAntLib</H3>
760<PRE>
761public void <B>exitAntLib</B>()</PRE>
762<DL>
763<DD>Called at the end of processing an antlib.
764<P>
765<DD><DL>
766</DL>
767</DD>
768</DL>
769<!-- ========= END OF CLASS DATA ========= -->
770<HR>
771
772
773<!-- ======= START OF BOTTOM NAVBAR ====== -->
774<A NAME="navbar_bottom"><!-- --></A>
775<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
776<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
777<TR>
778<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
779<A NAME="navbar_bottom_firstrow"><!-- --></A>
780<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
781 <TR ALIGN="center" VALIGN="top">
782 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
783 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
784 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
785 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
786 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
787 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
788 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
789 </TR>
790</TABLE>
791</TD>
792<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
793</EM>
794</TD>
795</TR>
796
797<TR>
798<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
799&nbsp;<A HREF="../../../../org/apache/tools/ant/BuildEvent.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>&nbsp;
800&nbsp;<A HREF="../../../../org/apache/tools/ant/DefaultLogger.html" title="class in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD>
801<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
802 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
803&nbsp;<A HREF="ComponentHelper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
804&nbsp;<SCRIPT type="text/javascript">
805 <!--
806 if(window==top) {
807 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
808 }
809 //-->
810</SCRIPT>
811<NOSCRIPT>
812 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
813</NOSCRIPT>
814
815</FONT></TD>
816</TR>
817<TR>
818<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
819 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
820<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
821DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
822</TR>
823</TABLE>
824<A NAME="skip-navbar_bottom"></A>
825<!-- ======== END OF BOTTOM NAVBAR ======= -->
826
827<HR>
828Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
829</BODY>
830</HTML>
Note: See TracBrowser for help on using the repository browser.