source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/MacroDef.Attribute.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: 14.4 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:20 NZST 2007 -->
6<TITLE>
7MacroDef.Attribute (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.MacroDef.Attribute 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="MacroDef.Attribute (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.NestedSequential.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="MacroDef.Attribute.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.taskdefs</FONT>
85<BR>
86Class MacroDef.Attribute</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.MacroDef.Attribute</B>
90</PRE>
91<DL>
92<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.html" title="class in org.apache.tools.ant.taskdefs">MacroDef</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public static class <B>MacroDef.Attribute</B><DT>extends java.lang.Object</DL>
97
98<P>
99A nested element for the MacroDef task.
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108
109<!-- =========== FIELD SUMMARY =========== -->
110
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TD COLSPAN=2><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TD>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#MacroDef.Attribute()">MacroDef.Attribute</A></B>()</CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
125</TR>
126</TABLE>
127&nbsp;
128<!-- ========== METHOD SUMMARY =========== -->
129
130<A NAME="method_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TD COLSPAN=2><FONT SIZE="+2">
134<B>Method Summary</B></FONT></TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>&nbsp;boolean</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;equality method</TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#getDefault()">getDefault</A></B>()</CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#getDescription()">getDescription</A></B>()</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#getName()">getName</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;int</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#hashCode()">hashCode</A></B>()</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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/taskdefs/MacroDef.Attribute.html#setDefault(java.lang.String)">setDefault</A></B>(java.lang.String&nbsp;defaultValue)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default value to use if the parameter is not
183 used in the templated instance.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;void</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String&nbsp;desc)</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>&nbsp;void</CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.Attribute.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the attribute.</TD>
200</TR>
201</TABLE>
202&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
205<TD><B>Methods inherited from class java.lang.Object</B></TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD><CODE>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
209</TR>
210</TABLE>
211&nbsp;
212<P>
213
214<!-- ============ FIELD DETAIL =========== -->
215
216
217<!-- ========= CONSTRUCTOR DETAIL ======== -->
218
219<A NAME="constructor_detail"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222<TD COLSPAN=1><FONT SIZE="+2">
223<B>Constructor Detail</B></FONT></TD>
224</TR>
225</TABLE>
226
227<A NAME="MacroDef.Attribute()"><!-- --></A><H3>
228MacroDef.Attribute</H3>
229<PRE>
230public <B>MacroDef.Attribute</B>()</PRE>
231<DL>
232</DL>
233
234<!-- ============ METHOD DETAIL ========== -->
235
236<A NAME="method_detail"><!-- --></A>
237<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
238<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
239<TD COLSPAN=1><FONT SIZE="+2">
240<B>Method Detail</B></FONT></TD>
241</TR>
242</TABLE>
243
244<A NAME="setName(java.lang.String)"><!-- --></A><H3>
245setName</H3>
246<PRE>
247public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
248<DL>
249<DD>The name of the attribute.
250<P>
251<DD><DL>
252<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the attribute</DL>
253</DD>
254</DL>
255<HR>
256
257<A NAME="getName()"><!-- --></A><H3>
258getName</H3>
259<PRE>
260public java.lang.String <B>getName</B>()</PRE>
261<DL>
262<DD><DL>
263
264<DT><B>Returns:</B><DD>the name of the attribute</DL>
265</DD>
266</DL>
267<HR>
268
269<A NAME="setDefault(java.lang.String)"><!-- --></A><H3>
270setDefault</H3>
271<PRE>
272public void <B>setDefault</B>(java.lang.String&nbsp;defaultValue)</PRE>
273<DL>
274<DD>The default value to use if the parameter is not
275 used in the templated instance.
276<P>
277<DD><DL>
278<DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - the default value</DL>
279</DD>
280</DL>
281<HR>
282
283<A NAME="getDefault()"><!-- --></A><H3>
284getDefault</H3>
285<PRE>
286public java.lang.String <B>getDefault</B>()</PRE>
287<DL>
288<DD><DL>
289
290<DT><B>Returns:</B><DD>the default value, null if not set</DL>
291</DD>
292</DL>
293<HR>
294
295<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
296setDescription</H3>
297<PRE>
298public void <B>setDescription</B>(java.lang.String&nbsp;desc)</PRE>
299<DL>
300<DD><DL>
301<DT><B>Parameters:</B><DD><CODE>desc</CODE> - Description of the element.<DT><B>Since:</B></DT>
302 <DD>ant 1.6.1</DD>
303</DL>
304</DD>
305</DL>
306<HR>
307
308<A NAME="getDescription()"><!-- --></A><H3>
309getDescription</H3>
310<PRE>
311public java.lang.String <B>getDescription</B>()</PRE>
312<DL>
313<DD><DL>
314
315<DT><B>Returns:</B><DD>the description of the element, or <code>null</code> if
316 no description is available.<DT><B>Since:</B></DT>
317 <DD>ant 1.6.1</DD>
318</DL>
319</DD>
320</DL>
321<HR>
322
323<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
324equals</H3>
325<PRE>
326public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>
327<DL>
328<DD>equality method
329<P>
330<DD><DL>
331<DT><B>Parameters:</B><DD><CODE>obj</CODE> - an <code>Object</code> value
332<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
333</DD>
334</DL>
335<HR>
336
337<A NAME="hashCode()"><!-- --></A><H3>
338hashCode</H3>
339<PRE>
340public int <B>hashCode</B>()</PRE>
341<DL>
342<DD><DL>
343
344<DT><B>Returns:</B><DD>a hash code value for this object.</DL>
345</DD>
346</DL>
347<!-- ========= END OF CLASS DATA ========= -->
348<HR>
349
350
351<!-- ======= START OF BOTTOM NAVBAR ====== -->
352<A NAME="navbar_bottom"><!-- --></A>
353<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
354<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
355<TR>
356<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
357<A NAME="navbar_bottom_firstrow"><!-- --></A>
358<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
359 <TR ALIGN="center" VALIGN="top">
360 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
361 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
362 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
363 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
364 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
365 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
366 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
367 </TR>
368</TABLE>
369</TD>
370<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
371</EM>
372</TD>
373</TR>
374
375<TR>
376<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
377&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
378&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/MacroDef.NestedSequential.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
379<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
380 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
381&nbsp;<A HREF="MacroDef.Attribute.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
382&nbsp;<SCRIPT type="text/javascript">
383 <!--
384 if(window==top) {
385 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
386 }
387 //-->
388</SCRIPT>
389<NOSCRIPT>
390 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
391</NOSCRIPT>
392
393</FONT></TD>
394</TR>
395<TR>
396<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
397 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
398<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
399DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
400</TR>
401</TABLE>
402<A NAME="skip-navbar_bottom"></A>
403<!-- ======== END OF BOTTOM NAVBAR ======= -->
404
405<HR>
406Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
407</BODY>
408</HTML>
Note: See TracBrowser for help on using the repository browser.