source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/PatternSet.NameEntry.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: 13.9 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:32 NZST 2007 -->
6<TITLE>
7PatternSet.NameEntry (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.PatternSet.NameEntry 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="PatternSet.NameEntry (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/types/PatternSet.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Permissions.html" title="class in org.apache.tools.ant.types"><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="PatternSet.NameEntry.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.types</FONT>
85<BR>
86Class PatternSet.NameEntry</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.PatternSet.NameEntry</B>
90</PRE>
91<DL>
92<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.html" title="class in org.apache.tools.ant.types">PatternSet</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>PatternSet.NameEntry</B><DT>extends java.lang.Object</DL>
97
98<P>
99inner class to hold a name on list. "If" and "Unless" attributes
100 may be used to invalidate the entry based on the existence of a
101 property (typically set thru the use of the Available task).
102<P>
103
104<P>
105<HR>
106
107<P>
108<!-- ======== NESTED CLASS SUMMARY ======== -->
109
110
111<!-- =========== FIELD SUMMARY =========== -->
112
113
114<!-- ======== CONSTRUCTOR SUMMARY ======== -->
115
116<A NAME="constructor_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TD COLSPAN=2><FONT SIZE="+2">
120<B>Constructor Summary</B></FONT></TD>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#PatternSet.NameEntry()">PatternSet.NameEntry</A></B>()</CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
127</TR>
128</TABLE>
129&nbsp;
130<!-- ========== METHOD SUMMARY =========== -->
131
132<A NAME="method_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TD COLSPAN=2><FONT SIZE="+2">
136<B>Method Summary</B></FONT></TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#evalName(org.apache.tools.ant.Project)">evalName</A></B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;p)</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This validates the name - checks the if and unless
145 properties.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#getName()">getName</A></B>()</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;void</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#setIf(java.lang.String)">setIf</A></B>(java.lang.String&nbsp;cond)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the if attribute.</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;void</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the name pattern.</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>&nbsp;void</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#setUnless(java.lang.String)">setUnless</A></B>(java.lang.String&nbsp;cond)</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the unless attribute.</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PatternSet.NameEntry.html#toString()">toString</A></B>()</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
186</TR>
187</TABLE>
188&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
189<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
190<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
191<TD><B>Methods inherited from class java.lang.Object</B></TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
195</TR>
196</TABLE>
197&nbsp;
198<P>
199
200<!-- ============ FIELD DETAIL =========== -->
201
202
203<!-- ========= CONSTRUCTOR DETAIL ======== -->
204
205<A NAME="constructor_detail"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
208<TD COLSPAN=1><FONT SIZE="+2">
209<B>Constructor Detail</B></FONT></TD>
210</TR>
211</TABLE>
212
213<A NAME="PatternSet.NameEntry()"><!-- --></A><H3>
214PatternSet.NameEntry</H3>
215<PRE>
216public <B>PatternSet.NameEntry</B>()</PRE>
217<DL>
218</DL>
219
220<!-- ============ METHOD DETAIL ========== -->
221
222<A NAME="method_detail"><!-- --></A>
223<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
224<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
225<TD COLSPAN=1><FONT SIZE="+2">
226<B>Method Detail</B></FONT></TD>
227</TR>
228</TABLE>
229
230<A NAME="setName(java.lang.String)"><!-- --></A><H3>
231setName</H3>
232<PRE>
233public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
234<DL>
235<DD>Sets the name pattern.
236<P>
237<DD><DL>
238<DT><B>Parameters:</B><DD><CODE>name</CODE> - The pattern string.</DL>
239</DD>
240</DL>
241<HR>
242
243<A NAME="setIf(java.lang.String)"><!-- --></A><H3>
244setIf</H3>
245<PRE>
246public void <B>setIf</B>(java.lang.String&nbsp;cond)</PRE>
247<DL>
248<DD>Sets the if attribute. This attribute and the "unless"
249 attribute are used to validate the name, based in the
250 existence of the property.
251<P>
252<DD><DL>
253<DT><B>Parameters:</B><DD><CODE>cond</CODE> - A property name. If this property is not
254 present, the name is invalid.</DL>
255</DD>
256</DL>
257<HR>
258
259<A NAME="setUnless(java.lang.String)"><!-- --></A><H3>
260setUnless</H3>
261<PRE>
262public void <B>setUnless</B>(java.lang.String&nbsp;cond)</PRE>
263<DL>
264<DD>Sets the unless attribute. This attribute and the "if"
265 attribute are used to validate the name, based in the
266 existence of the property.
267<P>
268<DD><DL>
269<DT><B>Parameters:</B><DD><CODE>cond</CODE> - A property name. If this property is
270 present, the name is invalid.</DL>
271</DD>
272</DL>
273<HR>
274
275<A NAME="getName()"><!-- --></A><H3>
276getName</H3>
277<PRE>
278public java.lang.String <B>getName</B>()</PRE>
279<DL>
280<DD><DL>
281
282<DT><B>Returns:</B><DD>the name attribute.</DL>
283</DD>
284</DL>
285<HR>
286
287<A NAME="evalName(org.apache.tools.ant.Project)"><!-- --></A><H3>
288evalName</H3>
289<PRE>
290public java.lang.String <B>evalName</B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;p)</PRE>
291<DL>
292<DD>This validates the name - checks the if and unless
293 properties.
294<P>
295<DD><DL>
296<DT><B>Parameters:</B><DD><CODE>p</CODE> - the current project, used to check the presence or
297 absence of a property.
298<DT><B>Returns:</B><DD>the name attribute or null if the "if" or "unless"
299 properties are not/are set.</DL>
300</DD>
301</DL>
302<HR>
303
304<A NAME="toString()"><!-- --></A><H3>
305toString</H3>
306<PRE>
307public java.lang.String <B>toString</B>()</PRE>
308<DL>
309<DD><DL>
310
311<DT><B>Returns:</B><DD>a printable form of this object.</DL>
312</DD>
313</DL>
314<!-- ========= END OF CLASS DATA ========= -->
315<HR>
316
317
318<!-- ======= START OF BOTTOM NAVBAR ====== -->
319<A NAME="navbar_bottom"><!-- --></A>
320<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
321<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
322<TR>
323<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
324<A NAME="navbar_bottom_firstrow"><!-- --></A>
325<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
326 <TR ALIGN="center" VALIGN="top">
327 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
329 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
330 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
331 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
332 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
334 </TR>
335</TABLE>
336</TD>
337<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
338</EM>
339</TD>
340</TR>
341
342<TR>
343<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
344&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/PatternSet.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
345&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Permissions.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
346<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
347 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
348&nbsp;<A HREF="PatternSet.NameEntry.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
349&nbsp;<SCRIPT type="text/javascript">
350 <!--
351 if(window==top) {
352 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
353 }
354 //-->
355</SCRIPT>
356<NOSCRIPT>
357 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
358</NOSCRIPT>
359
360</FONT></TD>
361</TR>
362<TR>
363<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
364 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
365<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
366DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
367</TR>
368</TABLE>
369<A NAME="skip-navbar_bottom"></A>
370<!-- ======== END OF BOTTOM NAVBAR ======= -->
371
372<HR>
373Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
374</BODY>
375</HTML>
Note: See TracBrowser for help on using the repository browser.