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>
|
---|
7 | RuntimeConfigurable (Apache Ant API)
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.RuntimeConfigurable class">
|
---|
11 |
|
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
---|
13 |
|
---|
14 | <SCRIPT type="text/javascript">
|
---|
15 | function windowTitle()
|
---|
16 | {
|
---|
17 | parent.document.title="RuntimeConfigurable (Apache Ant API)";
|
---|
18 | }
|
---|
19 | </SCRIPT>
|
---|
20 |
|
---|
21 | </HEAD>
|
---|
22 |
|
---|
23 | <BODY BGCOLOR="white" onload="windowTitle();">
|
---|
24 |
|
---|
25 |
|
---|
26 | <!-- ========= START OF TOP NAVBAR ======= -->
|
---|
27 | <A NAME="navbar_top"><!-- --></A>
|
---|
28 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
---|
29 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
30 | <TR>
|
---|
31 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
32 | <A NAME="navbar_top_firstrow"><!-- --></A>
|
---|
33 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
34 | <TR ALIGN="center" VALIGN="top">
|
---|
35 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
42 | </TR>
|
---|
43 | </TABLE>
|
---|
44 | </TD>
|
---|
45 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
46 | </EM>
|
---|
47 | </TD>
|
---|
48 | </TR>
|
---|
49 |
|
---|
50 | <TR>
|
---|
51 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
52 | <A HREF="../../../../org/apache/tools/ant/PropertyHelper.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>
|
---|
53 | <A HREF="../../../../org/apache/tools/ant/Target.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>
|
---|
56 | <A HREF="RuntimeConfigurable.html" target="_top"><B>NO FRAMES</B></A>
|
---|
57 | <SCRIPT type="text/javascript">
|
---|
58 | <!--
|
---|
59 | if(window==top) {
|
---|
60 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
61 | }
|
---|
62 | //-->
|
---|
63 | </SCRIPT>
|
---|
64 | <NOSCRIPT>
|
---|
65 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
66 | </NOSCRIPT>
|
---|
67 |
|
---|
68 | </FONT></TD>
|
---|
69 | </TR>
|
---|
70 | <TR>
|
---|
71 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
72 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
74 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
75 | </TR>
|
---|
76 | </TABLE>
|
---|
77 | <A NAME="skip-navbar_top"></A>
|
---|
78 | <!-- ========= END OF TOP NAVBAR ========= -->
|
---|
79 |
|
---|
80 | <HR>
|
---|
81 | <!-- ======== START OF CLASS DATA ======== -->
|
---|
82 | <H2>
|
---|
83 | <FONT SIZE="-1">
|
---|
84 | org.apache.tools.ant</FONT>
|
---|
85 | <BR>
|
---|
86 | Class RuntimeConfigurable</H2>
|
---|
87 | <PRE>
|
---|
88 | java.lang.Object
|
---|
89 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.RuntimeConfigurable</B>
|
---|
90 | </PRE>
|
---|
91 | <DL>
|
---|
92 | <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
|
---|
93 | </DL>
|
---|
94 | <HR>
|
---|
95 | <DL>
|
---|
96 | <DT>public class <B>RuntimeConfigurable</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
|
---|
97 |
|
---|
98 | <P>
|
---|
99 | Wrapper class that holds the attributes of an element, its children, and
|
---|
100 | any text within it. It then takes care of configuring that element at
|
---|
101 | runtime.
|
---|
102 | <P>
|
---|
103 |
|
---|
104 | <P>
|
---|
105 | <DL>
|
---|
106 | <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.tools.ant.RuntimeConfigurable">Serialized Form</A></DL>
|
---|
107 | <HR>
|
---|
108 |
|
---|
109 | <P>
|
---|
110 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
111 |
|
---|
112 |
|
---|
113 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
114 |
|
---|
115 |
|
---|
116 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
117 |
|
---|
118 | <A NAME="constructor_summary"><!-- --></A>
|
---|
119 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
120 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
121 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
122 | <B>Constructor Summary</B></FONT></TD>
|
---|
123 | </TR>
|
---|
124 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
125 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#RuntimeConfigurable(java.lang.Object, java.lang.String)">RuntimeConfigurable</A></B>(java.lang.Object proxy,
|
---|
126 | java.lang.String elementTag)</CODE>
|
---|
127 |
|
---|
128 | <BR>
|
---|
129 | Sole constructor creating a wrapper for the specified object.</TD>
|
---|
130 | </TR>
|
---|
131 | </TABLE>
|
---|
132 |
|
---|
133 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
134 |
|
---|
135 | <A NAME="method_summary"><!-- --></A>
|
---|
136 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
137 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
138 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
139 | <B>Method Summary</B></FONT></TD>
|
---|
140 | </TR>
|
---|
141 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
142 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
143 | <CODE> void</CODE></FONT></TD>
|
---|
144 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#addChild(org.apache.tools.ant.RuntimeConfigurable)">addChild</A></B>(<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant">RuntimeConfigurable</A> child)</CODE>
|
---|
145 |
|
---|
146 | <BR>
|
---|
147 | Adds a child element to the wrapped element.</TD>
|
---|
148 | </TR>
|
---|
149 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
150 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
151 | <CODE> void</CODE></FONT></TD>
|
---|
152 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#addText(char[], int, int)">addText</A></B>(char[] buf,
|
---|
153 | int start,
|
---|
154 | int count)</CODE>
|
---|
155 |
|
---|
156 | <BR>
|
---|
157 | Adds characters from #PCDATA areas to the wrapped element.</TD>
|
---|
158 | </TR>
|
---|
159 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
160 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
161 | <CODE> void</CODE></FONT></TD>
|
---|
162 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#addText(java.lang.String)">addText</A></B>(java.lang.String data)</CODE>
|
---|
163 |
|
---|
164 | <BR>
|
---|
165 | Adds characters from #PCDATA areas to the wrapped element.</TD>
|
---|
166 | </TR>
|
---|
167 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
168 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
169 | <CODE> void</CODE></FONT></TD>
|
---|
170 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#applyPreSet(org.apache.tools.ant.RuntimeConfigurable)">applyPreSet</A></B>(<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant">RuntimeConfigurable</A> r)</CODE>
|
---|
171 |
|
---|
172 | <BR>
|
---|
173 | Apply presets, attributes and text are set if not currently set.</TD>
|
---|
174 | </TR>
|
---|
175 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
176 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
177 | <CODE> java.util.Hashtable</CODE></FONT></TD>
|
---|
178 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getAttributeMap()">getAttributeMap</A></B>()</CODE>
|
---|
179 |
|
---|
180 | <BR>
|
---|
181 | Return the attribute map.</TD>
|
---|
182 | </TR>
|
---|
183 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
184 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
185 | <CODE> org.xml.sax.AttributeList</CODE></FONT></TD>
|
---|
186 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getAttributes()">getAttributes</A></B>()</CODE>
|
---|
187 |
|
---|
188 | <BR>
|
---|
189 | <B>Deprecated.</B> <I>Deprecated since Ant 1.6 in favor of <A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getAttributeMap()"><CODE>getAttributeMap()</CODE></A>.</I></TD>
|
---|
190 | </TR>
|
---|
191 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
192 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
193 | <CODE> java.util.Enumeration</CODE></FONT></TD>
|
---|
194 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getChildren()">getChildren</A></B>()</CODE>
|
---|
195 |
|
---|
196 | <BR>
|
---|
197 | Returns an enumeration of all child wrappers.</TD>
|
---|
198 | </TR>
|
---|
199 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
200 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
201 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
202 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getElementTag()">getElementTag</A></B>()</CODE>
|
---|
203 |
|
---|
204 | <BR>
|
---|
205 | Returns the tag name of the wrapped element.</TD>
|
---|
206 | </TR>
|
---|
207 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
208 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
209 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
210 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getPolyType()">getPolyType</A></B>()</CODE>
|
---|
211 |
|
---|
212 | <BR>
|
---|
213 | get the polymorphic type for this element</TD>
|
---|
214 | </TR>
|
---|
215 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
216 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
217 | <CODE> java.lang.Object</CODE></FONT></TD>
|
---|
218 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getProxy()">getProxy</A></B>()</CODE>
|
---|
219 |
|
---|
220 | <BR>
|
---|
221 | Get the object for which this RuntimeConfigurable holds the configuration
|
---|
222 | information</TD>
|
---|
223 | </TR>
|
---|
224 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
225 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
226 | <CODE> java.lang.StringBuffer</CODE></FONT></TD>
|
---|
227 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getText()">getText</A></B>()</CODE>
|
---|
228 |
|
---|
229 | <BR>
|
---|
230 | Get the text content of this element.</TD>
|
---|
231 | </TR>
|
---|
232 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
233 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
234 | <CODE> void</CODE></FONT></TD>
|
---|
235 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#maybeConfigure(org.apache.tools.ant.Project)">maybeConfigure</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> p)</CODE>
|
---|
236 |
|
---|
237 | <BR>
|
---|
238 | Configures the wrapped element and all its children.</TD>
|
---|
239 | </TR>
|
---|
240 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
241 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
242 | <CODE> void</CODE></FONT></TD>
|
---|
243 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#maybeConfigure(org.apache.tools.ant.Project, boolean)">maybeConfigure</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> p,
|
---|
244 | boolean configureChildren)</CODE>
|
---|
245 |
|
---|
246 | <BR>
|
---|
247 | Configures the wrapped element.</TD>
|
---|
248 | </TR>
|
---|
249 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
250 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
251 | <CODE> void</CODE></FONT></TD>
|
---|
252 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#reconfigure(org.apache.tools.ant.Project)">reconfigure</A></B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> p)</CODE>
|
---|
253 |
|
---|
254 | <BR>
|
---|
255 | Reconfigure the element, even if it has already been configured.</TD>
|
---|
256 | </TR>
|
---|
257 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
258 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
259 | <CODE> void</CODE></FONT></TD>
|
---|
260 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#setAttribute(java.lang.String, java.lang.String)">setAttribute</A></B>(java.lang.String name,
|
---|
261 | java.lang.String value)</CODE>
|
---|
262 |
|
---|
263 | <BR>
|
---|
264 | Set an attribute to a given value</TD>
|
---|
265 | </TR>
|
---|
266 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
267 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
268 | <CODE> void</CODE></FONT></TD>
|
---|
269 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#setAttributes(org.xml.sax.AttributeList)">setAttributes</A></B>(org.xml.sax.AttributeList attributes)</CODE>
|
---|
270 |
|
---|
271 | <BR>
|
---|
272 | <B>Deprecated.</B> <I></I> </TD>
|
---|
273 | </TR>
|
---|
274 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
275 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
276 | <CODE> void</CODE></FONT></TD>
|
---|
277 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#setPolyType(java.lang.String)">setPolyType</A></B>(java.lang.String polyType)</CODE>
|
---|
278 |
|
---|
279 | <BR>
|
---|
280 | set the polymorphic type for this element</TD>
|
---|
281 | </TR>
|
---|
282 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
283 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
284 | <CODE> void</CODE></FONT></TD>
|
---|
285 | <TD><CODE><B><A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#setProxy(java.lang.Object)">setProxy</A></B>(java.lang.Object proxy)</CODE>
|
---|
286 |
|
---|
287 | <BR>
|
---|
288 | Sets the element to configure.</TD>
|
---|
289 | </TR>
|
---|
290 | </TABLE>
|
---|
291 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
292 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
293 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
294 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
295 | </TR>
|
---|
296 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
297 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
298 | </TR>
|
---|
299 | </TABLE>
|
---|
300 |
|
---|
301 | <P>
|
---|
302 |
|
---|
303 | <!-- ============ FIELD DETAIL =========== -->
|
---|
304 |
|
---|
305 |
|
---|
306 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
307 |
|
---|
308 | <A NAME="constructor_detail"><!-- --></A>
|
---|
309 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
310 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
311 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
312 | <B>Constructor Detail</B></FONT></TD>
|
---|
313 | </TR>
|
---|
314 | </TABLE>
|
---|
315 |
|
---|
316 | <A NAME="RuntimeConfigurable(java.lang.Object, java.lang.String)"><!-- --></A><H3>
|
---|
317 | RuntimeConfigurable</H3>
|
---|
318 | <PRE>
|
---|
319 | public <B>RuntimeConfigurable</B>(java.lang.Object proxy,
|
---|
320 | java.lang.String elementTag)</PRE>
|
---|
321 | <DL>
|
---|
322 | <DD>Sole constructor creating a wrapper for the specified object.
|
---|
323 | <P>
|
---|
324 | <DT><B>Parameters:</B><DD><CODE>proxy</CODE> - The element to configure. Must not be <code>null</code>.<DD><CODE>elementTag</CODE> - The tag name generating this element.
|
---|
325 | Should not be <code>null</code>.</DL>
|
---|
326 |
|
---|
327 | <!-- ============ METHOD DETAIL ========== -->
|
---|
328 |
|
---|
329 | <A NAME="method_detail"><!-- --></A>
|
---|
330 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
331 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
332 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
333 | <B>Method Detail</B></FONT></TD>
|
---|
334 | </TR>
|
---|
335 | </TABLE>
|
---|
336 |
|
---|
337 | <A NAME="setProxy(java.lang.Object)"><!-- --></A><H3>
|
---|
338 | setProxy</H3>
|
---|
339 | <PRE>
|
---|
340 | public void <B>setProxy</B>(java.lang.Object proxy)</PRE>
|
---|
341 | <DL>
|
---|
342 | <DD>Sets the element to configure.
|
---|
343 | <P>
|
---|
344 | <DD><DL>
|
---|
345 | </DL>
|
---|
346 | </DD>
|
---|
347 | <DD><DL>
|
---|
348 | <DT><B>Parameters:</B><DD><CODE>proxy</CODE> - The element to configure. Must not be <code>null</code>.</DL>
|
---|
349 | </DD>
|
---|
350 | </DL>
|
---|
351 | <HR>
|
---|
352 |
|
---|
353 | <A NAME="getProxy()"><!-- --></A><H3>
|
---|
354 | getProxy</H3>
|
---|
355 | <PRE>
|
---|
356 | public java.lang.Object <B>getProxy</B>()</PRE>
|
---|
357 | <DL>
|
---|
358 | <DD>Get the object for which this RuntimeConfigurable holds the configuration
|
---|
359 | information
|
---|
360 | <P>
|
---|
361 | <DD><DL>
|
---|
362 | </DL>
|
---|
363 | </DD>
|
---|
364 | <DD><DL>
|
---|
365 |
|
---|
366 | <DT><B>Returns:</B><DD>the object whose configure is held by this instance.</DL>
|
---|
367 | </DD>
|
---|
368 | </DL>
|
---|
369 | <HR>
|
---|
370 |
|
---|
371 | <A NAME="getPolyType()"><!-- --></A><H3>
|
---|
372 | getPolyType</H3>
|
---|
373 | <PRE>
|
---|
374 | public java.lang.String <B>getPolyType</B>()</PRE>
|
---|
375 | <DL>
|
---|
376 | <DD>get the polymorphic type for this element
|
---|
377 | <P>
|
---|
378 | <DD><DL>
|
---|
379 | </DL>
|
---|
380 | </DD>
|
---|
381 | <DD><DL>
|
---|
382 |
|
---|
383 | <DT><B>Returns:</B><DD>the ant component type name, null if not set</DL>
|
---|
384 | </DD>
|
---|
385 | </DL>
|
---|
386 | <HR>
|
---|
387 |
|
---|
388 | <A NAME="setPolyType(java.lang.String)"><!-- --></A><H3>
|
---|
389 | setPolyType</H3>
|
---|
390 | <PRE>
|
---|
391 | public void <B>setPolyType</B>(java.lang.String polyType)</PRE>
|
---|
392 | <DL>
|
---|
393 | <DD>set the polymorphic type for this element
|
---|
394 | <P>
|
---|
395 | <DD><DL>
|
---|
396 | </DL>
|
---|
397 | </DD>
|
---|
398 | <DD><DL>
|
---|
399 | <DT><B>Parameters:</B><DD><CODE>polyType</CODE> - the ant component type name, null if not set</DL>
|
---|
400 | </DD>
|
---|
401 | </DL>
|
---|
402 | <HR>
|
---|
403 |
|
---|
404 | <A NAME="setAttributes(org.xml.sax.AttributeList)"><!-- --></A><H3>
|
---|
405 | setAttributes</H3>
|
---|
406 | <PRE>
|
---|
407 | public void <B>setAttributes</B>(org.xml.sax.AttributeList attributes)</PRE>
|
---|
408 | <DL>
|
---|
409 | <DD><B>Deprecated.</B> <I></I>
|
---|
410 | <P>
|
---|
411 | <DD>Sets the attributes for the wrapped element.
|
---|
412 | <P>
|
---|
413 | <DD><DL>
|
---|
414 | </DL>
|
---|
415 | </DD>
|
---|
416 | <DD><DL>
|
---|
417 | <DT><B>Parameters:</B><DD><CODE>attributes</CODE> - List of attributes defined in the XML for this
|
---|
418 | element. May be <code>null</code>.</DL>
|
---|
419 | </DD>
|
---|
420 | </DL>
|
---|
421 | <HR>
|
---|
422 |
|
---|
423 | <A NAME="setAttribute(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
424 | setAttribute</H3>
|
---|
425 | <PRE>
|
---|
426 | public void <B>setAttribute</B>(java.lang.String name,
|
---|
427 | java.lang.String value)</PRE>
|
---|
428 | <DL>
|
---|
429 | <DD>Set an attribute to a given value
|
---|
430 | <P>
|
---|
431 | <DD><DL>
|
---|
432 | </DL>
|
---|
433 | </DD>
|
---|
434 | <DD><DL>
|
---|
435 | <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the attribute.<DD><CODE>value</CODE> - the attribute's value.</DL>
|
---|
436 | </DD>
|
---|
437 | </DL>
|
---|
438 | <HR>
|
---|
439 |
|
---|
440 | <A NAME="getAttributeMap()"><!-- --></A><H3>
|
---|
441 | getAttributeMap</H3>
|
---|
442 | <PRE>
|
---|
443 | public java.util.Hashtable <B>getAttributeMap</B>()</PRE>
|
---|
444 | <DL>
|
---|
445 | <DD>Return the attribute map.
|
---|
446 | <P>
|
---|
447 | <DD><DL>
|
---|
448 | </DL>
|
---|
449 | </DD>
|
---|
450 | <DD><DL>
|
---|
451 |
|
---|
452 | <DT><B>Returns:</B><DD>Attribute name to attribute value map<DT><B>Since:</B></DT>
|
---|
453 | <DD>Ant 1.6</DD>
|
---|
454 | </DL>
|
---|
455 | </DD>
|
---|
456 | </DL>
|
---|
457 | <HR>
|
---|
458 |
|
---|
459 | <A NAME="getAttributes()"><!-- --></A><H3>
|
---|
460 | getAttributes</H3>
|
---|
461 | <PRE>
|
---|
462 | public org.xml.sax.AttributeList <B>getAttributes</B>()</PRE>
|
---|
463 | <DL>
|
---|
464 | <DD><B>Deprecated.</B> <I>Deprecated since Ant 1.6 in favor of <A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html#getAttributeMap()"><CODE>getAttributeMap()</CODE></A>.</I>
|
---|
465 | <P>
|
---|
466 | <DD>Returns the list of attributes for the wrapped element.
|
---|
467 | <P>
|
---|
468 | <DD><DL>
|
---|
469 | </DL>
|
---|
470 | </DD>
|
---|
471 | <DD><DL>
|
---|
472 |
|
---|
473 | <DT><B>Returns:</B><DD>An AttributeList representing the attributes defined in the
|
---|
474 | XML for this element. May be <code>null</code>.</DL>
|
---|
475 | </DD>
|
---|
476 | </DL>
|
---|
477 | <HR>
|
---|
478 |
|
---|
479 | <A NAME="addChild(org.apache.tools.ant.RuntimeConfigurable)"><!-- --></A><H3>
|
---|
480 | addChild</H3>
|
---|
481 | <PRE>
|
---|
482 | public void <B>addChild</B>(<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant">RuntimeConfigurable</A> child)</PRE>
|
---|
483 | <DL>
|
---|
484 | <DD>Adds a child element to the wrapped element.
|
---|
485 | <P>
|
---|
486 | <DD><DL>
|
---|
487 | </DL>
|
---|
488 | </DD>
|
---|
489 | <DD><DL>
|
---|
490 | <DT><B>Parameters:</B><DD><CODE>child</CODE> - The child element wrapper to add to this one.
|
---|
491 | Must not be <code>null</code>.</DL>
|
---|
492 | </DD>
|
---|
493 | </DL>
|
---|
494 | <HR>
|
---|
495 |
|
---|
496 | <A NAME="getChildren()"><!-- --></A><H3>
|
---|
497 | getChildren</H3>
|
---|
498 | <PRE>
|
---|
499 | public java.util.Enumeration <B>getChildren</B>()</PRE>
|
---|
500 | <DL>
|
---|
501 | <DD>Returns an enumeration of all child wrappers.
|
---|
502 | <P>
|
---|
503 | <DD><DL>
|
---|
504 | </DL>
|
---|
505 | </DD>
|
---|
506 | <DD><DL>
|
---|
507 |
|
---|
508 | <DT><B>Returns:</B><DD>an enumeration of the child wrappers.<DT><B>Since:</B></DT>
|
---|
509 | <DD>Ant 1.6</DD>
|
---|
510 | </DL>
|
---|
511 | </DD>
|
---|
512 | </DL>
|
---|
513 | <HR>
|
---|
514 |
|
---|
515 | <A NAME="addText(java.lang.String)"><!-- --></A><H3>
|
---|
516 | addText</H3>
|
---|
517 | <PRE>
|
---|
518 | public void <B>addText</B>(java.lang.String data)</PRE>
|
---|
519 | <DL>
|
---|
520 | <DD>Adds characters from #PCDATA areas to the wrapped element.
|
---|
521 | <P>
|
---|
522 | <DD><DL>
|
---|
523 | </DL>
|
---|
524 | </DD>
|
---|
525 | <DD><DL>
|
---|
526 | <DT><B>Parameters:</B><DD><CODE>data</CODE> - Text to add to the wrapped element.
|
---|
527 | Should not be <code>null</code>.</DL>
|
---|
528 | </DD>
|
---|
529 | </DL>
|
---|
530 | <HR>
|
---|
531 |
|
---|
532 | <A NAME="addText(char[], int, int)"><!-- --></A><H3>
|
---|
533 | addText</H3>
|
---|
534 | <PRE>
|
---|
535 | public void <B>addText</B>(char[] buf,
|
---|
536 | int start,
|
---|
537 | int count)</PRE>
|
---|
538 | <DL>
|
---|
539 | <DD>Adds characters from #PCDATA areas to the wrapped element.
|
---|
540 | <P>
|
---|
541 | <DD><DL>
|
---|
542 | </DL>
|
---|
543 | </DD>
|
---|
544 | <DD><DL>
|
---|
545 | <DT><B>Parameters:</B><DD><CODE>buf</CODE> - A character array of the text within the element.
|
---|
546 | Must 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.</DL>
|
---|
547 | </DD>
|
---|
548 | </DL>
|
---|
549 | <HR>
|
---|
550 |
|
---|
551 | <A NAME="getText()"><!-- --></A><H3>
|
---|
552 | getText</H3>
|
---|
553 | <PRE>
|
---|
554 | public java.lang.StringBuffer <B>getText</B>()</PRE>
|
---|
555 | <DL>
|
---|
556 | <DD>Get the text content of this element. Various text chunks are
|
---|
557 | concatenated, there is no way ( currently ) of keeping track of
|
---|
558 | multiple fragments.
|
---|
559 | <P>
|
---|
560 | <DD><DL>
|
---|
561 | </DL>
|
---|
562 | </DD>
|
---|
563 | <DD><DL>
|
---|
564 |
|
---|
565 | <DT><B>Returns:</B><DD>the text content of this element.<DT><B>Since:</B></DT>
|
---|
566 | <DD>Ant 1.6</DD>
|
---|
567 | </DL>
|
---|
568 | </DD>
|
---|
569 | </DL>
|
---|
570 | <HR>
|
---|
571 |
|
---|
572 | <A NAME="getElementTag()"><!-- --></A><H3>
|
---|
573 | getElementTag</H3>
|
---|
574 | <PRE>
|
---|
575 | public java.lang.String <B>getElementTag</B>()</PRE>
|
---|
576 | <DL>
|
---|
577 | <DD>Returns the tag name of the wrapped element.
|
---|
578 | <P>
|
---|
579 | <DD><DL>
|
---|
580 | </DL>
|
---|
581 | </DD>
|
---|
582 | <DD><DL>
|
---|
583 |
|
---|
584 | <DT><B>Returns:</B><DD>The tag name of the wrapped element. This is unlikely
|
---|
585 | to be <code>null</code>, but may be.</DL>
|
---|
586 | </DD>
|
---|
587 | </DL>
|
---|
588 | <HR>
|
---|
589 |
|
---|
590 | <A NAME="maybeConfigure(org.apache.tools.ant.Project)"><!-- --></A><H3>
|
---|
591 | maybeConfigure</H3>
|
---|
592 | <PRE>
|
---|
593 | public void <B>maybeConfigure</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> p)
|
---|
594 | throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
595 | <DL>
|
---|
596 | <DD>Configures the wrapped element and all its children.
|
---|
597 | The attributes and text for the wrapped element are configured,
|
---|
598 | and then each child is configured and added. Each time the
|
---|
599 | wrapper is configured, the attributes and text for it are
|
---|
600 | reset.
|
---|
601 |
|
---|
602 | If the element has an <code>id</code> attribute, a reference
|
---|
603 | is added to the project as well.
|
---|
604 | <P>
|
---|
605 | <DD><DL>
|
---|
606 | </DL>
|
---|
607 | </DD>
|
---|
608 | <DD><DL>
|
---|
609 | <DT><B>Parameters:</B><DD><CODE>p</CODE> - The project containing the wrapped element.
|
---|
610 | Must not be <code>null</code>.
|
---|
611 | <DT><B>Throws:</B>
|
---|
612 | <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the configuration fails, for instance due
|
---|
613 | to invalid attributes or children, or text being added to
|
---|
614 | an element which doesn't accept it.</DL>
|
---|
615 | </DD>
|
---|
616 | </DL>
|
---|
617 | <HR>
|
---|
618 |
|
---|
619 | <A NAME="maybeConfigure(org.apache.tools.ant.Project, boolean)"><!-- --></A><H3>
|
---|
620 | maybeConfigure</H3>
|
---|
621 | <PRE>
|
---|
622 | public void <B>maybeConfigure</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> p,
|
---|
623 | boolean configureChildren)
|
---|
624 | throws <A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
625 | <DL>
|
---|
626 | <DD>Configures the wrapped element. The attributes and text for
|
---|
627 | the wrapped element are configured. Each time the wrapper is
|
---|
628 | configured, the attributes and text for it are reset.
|
---|
629 |
|
---|
630 | If the element has an <code>id</code> attribute, a reference
|
---|
631 | is added to the project as well.
|
---|
632 | <P>
|
---|
633 | <DD><DL>
|
---|
634 | </DL>
|
---|
635 | </DD>
|
---|
636 | <DD><DL>
|
---|
637 | <DT><B>Parameters:</B><DD><CODE>p</CODE> - The project containing the wrapped element.
|
---|
638 | Must not be <code>null</code>.<DD><CODE>configureChildren</CODE> - Whether to configure child elements as
|
---|
639 | well. if true, child elements will be configured after the
|
---|
640 | wrapped element.
|
---|
641 | <DT><B>Throws:</B>
|
---|
642 | <DD><CODE><A HREF="../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the configuration fails, for instance due
|
---|
643 | to invalid attributes or children, or text being added to
|
---|
644 | an element which doesn't accept it.</DL>
|
---|
645 | </DD>
|
---|
646 | </DL>
|
---|
647 | <HR>
|
---|
648 |
|
---|
649 | <A NAME="reconfigure(org.apache.tools.ant.Project)"><!-- --></A><H3>
|
---|
650 | reconfigure</H3>
|
---|
651 | <PRE>
|
---|
652 | public void <B>reconfigure</B>(<A HREF="../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> p)</PRE>
|
---|
653 | <DL>
|
---|
654 | <DD>Reconfigure the element, even if it has already been configured.
|
---|
655 | <P>
|
---|
656 | <DD><DL>
|
---|
657 | </DL>
|
---|
658 | </DD>
|
---|
659 | <DD><DL>
|
---|
660 | <DT><B>Parameters:</B><DD><CODE>p</CODE> - the project instance for this configuration.</DL>
|
---|
661 | </DD>
|
---|
662 | </DL>
|
---|
663 | <HR>
|
---|
664 |
|
---|
665 | <A NAME="applyPreSet(org.apache.tools.ant.RuntimeConfigurable)"><!-- --></A><H3>
|
---|
666 | applyPreSet</H3>
|
---|
667 | <PRE>
|
---|
668 | public void <B>applyPreSet</B>(<A HREF="../../../../org/apache/tools/ant/RuntimeConfigurable.html" title="class in org.apache.tools.ant">RuntimeConfigurable</A> r)</PRE>
|
---|
669 | <DL>
|
---|
670 | <DD>Apply presets, attributes and text are set if not currently set.
|
---|
671 | nested elements are prepended.
|
---|
672 | <P>
|
---|
673 | <DD><DL>
|
---|
674 | </DL>
|
---|
675 | </DD>
|
---|
676 | <DD><DL>
|
---|
677 | <DT><B>Parameters:</B><DD><CODE>r</CODE> - a <code>RuntimeConfigurable</code> value</DL>
|
---|
678 | </DD>
|
---|
679 | </DL>
|
---|
680 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
681 | <HR>
|
---|
682 |
|
---|
683 |
|
---|
684 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
685 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
686 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
687 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
688 | <TR>
|
---|
689 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
690 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
691 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
692 | <TR ALIGN="center" VALIGN="top">
|
---|
693 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
694 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
695 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
696 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
697 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
698 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
699 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
700 | </TR>
|
---|
701 | </TABLE>
|
---|
702 | </TD>
|
---|
703 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
704 | </EM>
|
---|
705 | </TD>
|
---|
706 | </TR>
|
---|
707 |
|
---|
708 | <TR>
|
---|
709 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
710 | <A HREF="../../../../org/apache/tools/ant/PropertyHelper.html" title="class in org.apache.tools.ant"><B>PREV CLASS</B></A>
|
---|
711 | <A HREF="../../../../org/apache/tools/ant/Target.html" title="class in org.apache.tools.ant"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
712 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
713 | <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
714 | <A HREF="RuntimeConfigurable.html" target="_top"><B>NO FRAMES</B></A>
|
---|
715 | <SCRIPT type="text/javascript">
|
---|
716 | <!--
|
---|
717 | if(window==top) {
|
---|
718 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
719 | }
|
---|
720 | //-->
|
---|
721 | </SCRIPT>
|
---|
722 | <NOSCRIPT>
|
---|
723 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
724 | </NOSCRIPT>
|
---|
725 |
|
---|
726 | </FONT></TD>
|
---|
727 | </TR>
|
---|
728 | <TR>
|
---|
729 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
730 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
731 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
732 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
733 | </TR>
|
---|
734 | </TABLE>
|
---|
735 | <A NAME="skip-navbar_bottom"></A>
|
---|
736 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
737 |
|
---|
738 | <HR>
|
---|
739 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
740 | </BODY>
|
---|
741 | </HTML>
|
---|