source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/PropertySet.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: 31.6 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>
7PropertySet (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.PropertySet 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="PropertySet (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/Permissions.Permission.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.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="PropertySet.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.types.DataType">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;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 PropertySet</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">org.apache.tools.ant.types.DataType</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.PropertySet</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>PropertySet</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></DL>
96
97<P>
98A set of properties.
99<P>
100
101<P>
102<DL>
103<DT><B>Since:</B></DT>
104 <DD>Ant 1.6</DD>
105</DL>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111<A NAME="nested_class_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TD COLSPAN=2><FONT SIZE="+2">
115<B>Nested Class Summary</B></FONT></TD>
116</TR>
117<TR BGCOLOR="white" CLASS="TableRowColor">
118<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119<CODE>static&nbsp;class</CODE></FONT></TD>
120<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html" title="class in org.apache.tools.ant.types">PropertySet.BuiltinPropertySetName</A></B></CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for propertyref's builtin attribute.</TD>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>static&nbsp;class</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.PropertyRef.html" title="class in org.apache.tools.ant.types">PropertySet.PropertyRef</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is a nested class containing a reference to some properties
132 and optionally a source of properties.</TD>
133</TR>
134</TABLE>
135&nbsp;
136<!-- =========== FIELD SUMMARY =========== -->
137
138<A NAME="field_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TD COLSPAN=2><FONT SIZE="+2">
142<B>Field Summary</B></FONT></TD>
143</TR>
144</TABLE>
145&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
148<TD><B>Fields inherited from class org.apache.tools.ant.types.<A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checked">checked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#ref">ref</A></CODE></TD>
152</TR>
153</TABLE>
154&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
157<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ======== CONSTRUCTOR SUMMARY ======== -->
165
166<A NAME="constructor_summary"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TD COLSPAN=2><FONT SIZE="+2">
170<B>Constructor Summary</B></FONT></TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#PropertySet()">PropertySet</A></B>()</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ========== METHOD SUMMARY =========== -->
181
182<A NAME="method_summary"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TD COLSPAN=2><FONT SIZE="+2">
186<B>Method Summary</B></FONT></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;void</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#add(org.apache.tools.ant.util.FileNameMapper)">add</A></B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a nested FileNameMapper.</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;void</CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#addPropertyref(org.apache.tools.ant.types.PropertySet.PropertyRef)">addPropertyref</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.PropertyRef.html" title="class in org.apache.tools.ant.types">PropertySet.PropertyRef</A>&nbsp;ref)</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a property reference (nested element) to the references to be used.</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;void</CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#addPropertyset(org.apache.tools.ant.types.PropertySet)">addPropertyset</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</A>&nbsp;ref)</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add another property set to this set.</TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;void</CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#appendBuiltin(org.apache.tools.ant.types.PropertySet.BuiltinPropertySetName)">appendBuiltin</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html" title="class in org.apache.tools.ant.types">PropertySet.BuiltinPropertySetName</A>&nbsp;b)</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allow builtin (all, system or commandline) properties in the set.</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>&nbsp;void</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#appendName(java.lang.String)">appendName</A></B>(java.lang.String&nbsp;name)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allow properties of a particular name in the set.</TD>
227</TR>
228<TR BGCOLOR="white" CLASS="TableRowColor">
229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230<CODE>&nbsp;void</CODE></FONT></TD>
231<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#appendPrefix(java.lang.String)">appendPrefix</A></B>(java.lang.String&nbsp;prefix)</CODE>
232
233<BR>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allow properties whose names start with a prefix in the set.</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;void</CODE></FONT></TD>
239<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#appendRegex(java.lang.String)">appendRegex</A></B>(java.lang.String&nbsp;regex)</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allow properties whose names match a regex in the set.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>protected &nbsp;void</CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#assertNotReference()">assertNotReference</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ensures this data type is not a reference.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A></CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#createMapper()">createMapper</A></B>()</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a mapper to map the property names.</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>&nbsp;boolean</CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#getDynamic()">getDynamic</A></B>()</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the dynamic attribute.</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A></CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#getMapper()">getMapper</A></B>()</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the mapper attribute.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;java.util.Properties</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#getProperties()">getProperties</A></B>()</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This is the operation to get the existing or recalculated properties.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</A></CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#getRef()">getRef</A></B>()</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs the check for circular references and returns the
291 referenced PropertySet.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;void</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#setDynamic(boolean)">setDynamic</A></B>(boolean&nbsp;dynamic)</CODE>
297
298<BR>
299&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether to reevaluate the set everytime the set is used.</TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
303<CODE>&nbsp;void</CODE></FONT></TD>
304<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#setMapper(java.lang.String, java.lang.String, java.lang.String)">setMapper</A></B>(java.lang.String&nbsp;type,
305 java.lang.String&nbsp;from,
306 java.lang.String&nbsp;to)</CODE>
307
308<BR>
309&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a mapper to change property names.</TD>
310</TR>
311<TR BGCOLOR="white" CLASS="TableRowColor">
312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313<CODE>&nbsp;void</CODE></FONT></TD>
314<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#setNegate(boolean)">setNegate</A></B>(boolean&nbsp;negate)</CODE>
315
316<BR>
317&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether to negate results.</TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321<CODE>&nbsp;void</CODE></FONT></TD>
322<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
323
324<BR>
325&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the value of the refid attribute.</TD>
326</TR>
327<TR BGCOLOR="white" CLASS="TableRowColor">
328<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
330<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html#toString()">toString</A></B>()</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A debug toString.</TD>
334</TR>
335</TABLE>
336&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
337<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
338<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
339<TD><B>Methods inherited from class org.apache.tools.ant.types.<A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
340</TR>
341<TR BGCOLOR="white" CLASS="TableRowColor">
342<TD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkAttributesAllowed()">checkAttributesAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkChildrenAllowed()">checkChildrenAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#circularReference()">circularReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)">dieOnCircularReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getCheckedRef(java.lang.Class, java.lang.String)">getCheckedRef</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getRefid()">getRefid</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isChecked()">isChecked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isReference()">isReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#noChildrenAllowed()">noChildrenAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)">setChecked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#tooManyAttributes()">tooManyAttributes</A></CODE></TD>
343</TR>
344</TABLE>
345&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
346<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
347<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
348<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
349</TR>
350<TR BGCOLOR="white" CLASS="TableRowColor">
351<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
352</TR>
353</TABLE>
354&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
355<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
356<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
357<TD><B>Methods inherited from class java.lang.Object</B></TD>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
361</TR>
362</TABLE>
363&nbsp;
364<P>
365
366<!-- ============ FIELD DETAIL =========== -->
367
368
369<!-- ========= CONSTRUCTOR DETAIL ======== -->
370
371<A NAME="constructor_detail"><!-- --></A>
372<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
373<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
374<TD COLSPAN=1><FONT SIZE="+2">
375<B>Constructor Detail</B></FONT></TD>
376</TR>
377</TABLE>
378
379<A NAME="PropertySet()"><!-- --></A><H3>
380PropertySet</H3>
381<PRE>
382public <B>PropertySet</B>()</PRE>
383<DL>
384</DL>
385
386<!-- ============ METHOD DETAIL ========== -->
387
388<A NAME="method_detail"><!-- --></A>
389<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
390<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
391<TD COLSPAN=1><FONT SIZE="+2">
392<B>Method Detail</B></FONT></TD>
393</TR>
394</TABLE>
395
396<A NAME="appendName(java.lang.String)"><!-- --></A><H3>
397appendName</H3>
398<PRE>
399public void <B>appendName</B>(java.lang.String&nbsp;name)</PRE>
400<DL>
401<DD>Allow properties of a particular name in the set.
402<P>
403<DD><DL>
404<DT><B>Parameters:</B><DD><CODE>name</CODE> - the property name to allow.</DL>
405</DD>
406</DL>
407<HR>
408
409<A NAME="appendRegex(java.lang.String)"><!-- --></A><H3>
410appendRegex</H3>
411<PRE>
412public void <B>appendRegex</B>(java.lang.String&nbsp;regex)</PRE>
413<DL>
414<DD>Allow properties whose names match a regex in the set.
415<P>
416<DD><DL>
417<DT><B>Parameters:</B><DD><CODE>regex</CODE> - the regular expression to use.</DL>
418</DD>
419</DL>
420<HR>
421
422<A NAME="appendPrefix(java.lang.String)"><!-- --></A><H3>
423appendPrefix</H3>
424<PRE>
425public void <B>appendPrefix</B>(java.lang.String&nbsp;prefix)</PRE>
426<DL>
427<DD>Allow properties whose names start with a prefix in the set.
428<P>
429<DD><DL>
430<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix to use.</DL>
431</DD>
432</DL>
433<HR>
434
435<A NAME="appendBuiltin(org.apache.tools.ant.types.PropertySet.BuiltinPropertySetName)"><!-- --></A><H3>
436appendBuiltin</H3>
437<PRE>
438public void <B>appendBuiltin</B>(<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html" title="class in org.apache.tools.ant.types">PropertySet.BuiltinPropertySetName</A>&nbsp;b)</PRE>
439<DL>
440<DD>Allow builtin (all, system or commandline) properties in the set.
441<P>
442<DD><DL>
443<DT><B>Parameters:</B><DD><CODE>b</CODE> - the type of builtin properties.</DL>
444</DD>
445</DL>
446<HR>
447
448<A NAME="setMapper(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
449setMapper</H3>
450<PRE>
451public void <B>setMapper</B>(java.lang.String&nbsp;type,
452 java.lang.String&nbsp;from,
453 java.lang.String&nbsp;to)</PRE>
454<DL>
455<DD>Set a mapper to change property names.
456<P>
457<DD><DL>
458<DT><B>Parameters:</B><DD><CODE>type</CODE> - mapper type.<DD><CODE>from</CODE> - source pattern.<DD><CODE>to</CODE> - output pattern.</DL>
459</DD>
460</DL>
461<HR>
462
463<A NAME="addPropertyref(org.apache.tools.ant.types.PropertySet.PropertyRef)"><!-- --></A><H3>
464addPropertyref</H3>
465<PRE>
466public void <B>addPropertyref</B>(<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.PropertyRef.html" title="class in org.apache.tools.ant.types">PropertySet.PropertyRef</A>&nbsp;ref)</PRE>
467<DL>
468<DD>Add a property reference (nested element) to the references to be used.
469<P>
470<DD><DL>
471<DT><B>Parameters:</B><DD><CODE>ref</CODE> - a property reference.</DL>
472</DD>
473</DL>
474<HR>
475
476<A NAME="addPropertyset(org.apache.tools.ant.types.PropertySet)"><!-- --></A><H3>
477addPropertyset</H3>
478<PRE>
479public void <B>addPropertyset</B>(<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</A>&nbsp;ref)</PRE>
480<DL>
481<DD>Add another property set to this set.
482<P>
483<DD><DL>
484<DT><B>Parameters:</B><DD><CODE>ref</CODE> - another property set.</DL>
485</DD>
486</DL>
487<HR>
488
489<A NAME="createMapper()"><!-- --></A><H3>
490createMapper</H3>
491<PRE>
492public <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A> <B>createMapper</B>()</PRE>
493<DL>
494<DD>Create a mapper to map the property names.
495<P>
496<DD><DL>
497
498<DT><B>Returns:</B><DD>a mapper to be configured.</DL>
499</DD>
500</DL>
501<HR>
502
503<A NAME="add(org.apache.tools.ant.util.FileNameMapper)"><!-- --></A><H3>
504add</H3>
505<PRE>
506public void <B>add</B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</PRE>
507<DL>
508<DD>Add a nested FileNameMapper.
509<P>
510<DD><DL>
511<DT><B>Parameters:</B><DD><CODE>fileNameMapper</CODE> - the mapper to add.<DT><B>Since:</B></DT>
512 <DD>Ant 1.6.3</DD>
513</DL>
514</DD>
515</DL>
516<HR>
517
518<A NAME="setDynamic(boolean)"><!-- --></A><H3>
519setDynamic</H3>
520<PRE>
521public void <B>setDynamic</B>(boolean&nbsp;dynamic)</PRE>
522<DL>
523<DD>Set whether to reevaluate the set everytime the set is used.
524 Default is true.
525<P>
526<DD><DL>
527<DT><B>Parameters:</B><DD><CODE>dynamic</CODE> - if true, reevaluate the property set each time
528 the set is used. if false cache the property set
529 the first time and use the cached set on subsequent
530 occasions.</DL>
531</DD>
532</DL>
533<HR>
534
535<A NAME="setNegate(boolean)"><!-- --></A><H3>
536setNegate</H3>
537<PRE>
538public void <B>setNegate</B>(boolean&nbsp;negate)</PRE>
539<DL>
540<DD>Set whether to negate results.
541 If "true", all properties not selected by nested elements will be returned.
542 Default is "false".
543<P>
544<DD><DL>
545<DT><B>Parameters:</B><DD><CODE>negate</CODE> - if true, negate the selection criteria.</DL>
546</DD>
547</DL>
548<HR>
549
550<A NAME="getDynamic()"><!-- --></A><H3>
551getDynamic</H3>
552<PRE>
553public boolean <B>getDynamic</B>()</PRE>
554<DL>
555<DD>Get the dynamic attribute.
556<P>
557<DD><DL>
558
559<DT><B>Returns:</B><DD>true if the property set is to be evalulated each time it is used.</DL>
560</DD>
561</DL>
562<HR>
563
564<A NAME="getMapper()"><!-- --></A><H3>
565getMapper</H3>
566<PRE>
567public <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A> <B>getMapper</B>()</PRE>
568<DL>
569<DD>Get the mapper attribute.
570<P>
571<DD><DL>
572
573<DT><B>Returns:</B><DD>the mapper attribute.</DL>
574</DD>
575</DL>
576<HR>
577
578<A NAME="getProperties()"><!-- --></A><H3>
579getProperties</H3>
580<PRE>
581public java.util.Properties <B>getProperties</B>()</PRE>
582<DL>
583<DD>This is the operation to get the existing or recalculated properties.
584<P>
585<DD><DL>
586
587<DT><B>Returns:</B><DD>the properties for this propertyset.</DL>
588</DD>
589</DL>
590<HR>
591
592<A NAME="getRef()"><!-- --></A><H3>
593getRef</H3>
594<PRE>
595protected <A HREF="../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</A> <B>getRef</B>()</PRE>
596<DL>
597<DD>Performs the check for circular references and returns the
598 referenced PropertySet.
599<P>
600<DD><DL>
601
602<DT><B>Returns:</B><DD>the referenced PropertySet.</DL>
603</DD>
604</DL>
605<HR>
606
607<A NAME="setRefid(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
608setRefid</H3>
609<PRE>
610public final void <B>setRefid</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
611<DL>
612<DD>Sets the value of the refid attribute.
613<P>
614<DD><DL>
615<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></CODE></DL>
616</DD>
617<DD><DL>
618<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference this datatype should point to.
619<DT><B>Throws:</B>
620<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if another attribute was set, since
621 refid and all other attributes are mutually exclusive.</DL>
622</DD>
623</DL>
624<HR>
625
626<A NAME="assertNotReference()"><!-- --></A><H3>
627assertNotReference</H3>
628<PRE>
629protected final void <B>assertNotReference</B>()</PRE>
630<DL>
631<DD>Ensures this data type is not a reference.
632
633 <p>Calling this method as the first line of every bean method of
634 this data type (setXyz, addXyz, createXyz) ensure proper handling
635 of the refid attribute.</p>
636<P>
637<DD><DL>
638
639<DT><B>Throws:</B>
640<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the refid attribute was already set, since
641 refid and all other attributes are mutually exclusive.</DL>
642</DD>
643</DL>
644<HR>
645
646<A NAME="toString()"><!-- --></A><H3>
647toString</H3>
648<PRE>
649public java.lang.String <B>toString</B>()</PRE>
650<DL>
651<DD>A debug toString.
652 This gets a comma separated list of key=value pairs for
653 the properties in the set.
654 The output order is sorted according to the keys' <i>natural order</i>.
655<P>
656<DD><DL>
657
658<DT><B>Returns:</B><DD>a string rep of this object.</DL>
659</DD>
660</DL>
661<!-- ========= END OF CLASS DATA ========= -->
662<HR>
663
664
665<!-- ======= START OF BOTTOM NAVBAR ====== -->
666<A NAME="navbar_bottom"><!-- --></A>
667<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
668<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
669<TR>
670<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
671<A NAME="navbar_bottom_firstrow"><!-- --></A>
672<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
673 <TR ALIGN="center" VALIGN="top">
674 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
675 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
676 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
677 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
678 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
679 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
680 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
681 </TR>
682</TABLE>
683</TD>
684<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
685</EM>
686</TD>
687</TR>
688
689<TR>
690<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
691&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Permissions.Permission.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
692&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
693<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
694 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
695&nbsp;<A HREF="PropertySet.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
696&nbsp;<SCRIPT type="text/javascript">
697 <!--
698 if(window==top) {
699 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
700 }
701 //-->
702</SCRIPT>
703<NOSCRIPT>
704 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
705</NOSCRIPT>
706
707</FONT></TD>
708</TR>
709<TR>
710<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
711 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.types.DataType">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
712<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
713DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
714</TR>
715</TABLE>
716<A NAME="skip-navbar_bottom"></A>
717<!-- ======== END OF BOTTOM NAVBAR ======= -->
718
719<HR>
720Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
721</BODY>
722</HTML>
Note: See TracBrowser for help on using the repository browser.