source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/Property.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: 46.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:21 NZST 2007 -->
6<TITLE>
7Property (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Property 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="Property (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/PreSetDef.PreSetDefinition.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/PumpStreamHandler.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="Property.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;<A HREF="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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 Property</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/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Property</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>Property</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Sets a property by name, or set of properties (from file or
99 resource) in the project. </p>
100 Properties are immutable: whoever sets a property first freezes it for the
101 rest of the build; they are most definitely not variable.
102 <p>There are five ways to set properties:</p>
103 <ul>
104 <li>By supplying both the <i>name</i> and <i>value</i> attribute.</li>
105 <li>By supplying both the <i>name</i> and <i>refid</i> attribute.</li>
106 <li>By setting the <i>file</i> attribute with the filename of the property
107 file to load. This property file has the format as defined by the file used
108 in the class java.util.Properties.</li>
109 <li>By setting the <i>resource</i> attribute with the resource name of the
110 property file to load. This property file has the format as defined by the
111 file used in the class java.util.Properties.</li>
112 <li>By setting the <i>environment</i> attribute with a prefix to use.
113 Properties will be defined for every environment variable by
114 prefixing the supplied name and a period to the name of the variable.</li>
115 </ul>
116 <p>Although combinations of these ways are possible, only one should be used
117 at a time. Problems might occur with the order in which properties are set, for
118 instance.</p>
119 <p>The value part of the properties being set, might contain references to other
120 properties. These references are resolved at the time these properties are set.
121 This also holds for properties loaded from a property file.</p>
122 Properties are case sensitive.
123<P>
124
125<P>
126<DL>
127<DT><B>Since:</B></DT>
128 <DD>Ant 1.1</DD>
129</DL>
130<HR>
131
132<P>
133<!-- ======== NESTED CLASS SUMMARY ======== -->
134
135
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<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#classpath">classpath</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>protected &nbsp;java.lang.String</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#env">env</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>protected &nbsp;java.io.File</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#file">file</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>protected &nbsp;java.lang.String</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#name">name</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>protected &nbsp;java.lang.String</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#prefix">prefix</A></B></CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A></CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#ref">ref</A></B></CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#resource">resource</A></B></CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>protected &nbsp;java.net.URL</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#url">url</A></B></CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210<CODE>protected &nbsp;boolean</CODE></FONT></TD>
211<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#userProperty">userProperty</A></B></CODE>
212
213<BR>
214&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
215</TR>
216<TR BGCOLOR="white" CLASS="TableRowColor">
217<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
219<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#value">value</A></B></CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
223</TR>
224</TABLE>
225&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
226<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
227<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
228<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
232</TR>
233</TABLE>
234&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
235<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
236<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
237<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>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
241</TR>
242</TABLE>
243&nbsp;
244<!-- ======== CONSTRUCTOR SUMMARY ======== -->
245
246<A NAME="constructor_summary"><!-- --></A>
247<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
248<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249<TD COLSPAN=2><FONT SIZE="+2">
250<B>Constructor Summary</B></FONT></TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#Property()">Property</A></B>()</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
259</TR>
260<TR BGCOLOR="white" CLASS="TableRowColor">
261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262<CODE>protected </CODE></FONT></TD>
263<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#Property(boolean)">Property</A></B>(boolean&nbsp;userProperty)</CODE>
264
265<BR>
266&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
267</TR>
268<TR BGCOLOR="white" CLASS="TableRowColor">
269<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270<CODE>protected </CODE></FONT></TD>
271<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#Property(boolean, org.apache.tools.ant.Project)">Property</A></B>(boolean&nbsp;userProperty,
272 <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;fallback)</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
276</TR>
277</TABLE>
278&nbsp;
279<!-- ========== METHOD SUMMARY =========== -->
280
281<A NAME="method_summary"><!-- --></A>
282<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
283<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
284<TD COLSPAN=2><FONT SIZE="+2">
285<B>Method Summary</B></FONT></TD>
286</TR>
287<TR BGCOLOR="white" CLASS="TableRowColor">
288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289<CODE>protected &nbsp;void</CODE></FONT></TD>
290<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#addProperties(java.util.Properties)">addProperties</A></B>(java.util.Properties&nbsp;props)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;iterate through a set of properties,
294 resolve them then assign them</TD>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
298<CODE>protected &nbsp;void</CODE></FONT></TD>
299<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#addProperty(java.lang.String, java.lang.String)">addProperty</A></B>(java.lang.String&nbsp;n,
300 java.lang.String&nbsp;v)</CODE>
301
302<BR>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;add a name value pair to the project property set</TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
308<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#createClasspath()">createClasspath</A></B>()</CODE>
309
310<BR>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The classpath to use when looking up a resource.</TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315<CODE>&nbsp;void</CODE></FONT></TD>
316<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#execute()">execute</A></B>()</CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the property in the project to the value.</TD>
320</TR>
321<TR BGCOLOR="white" CLASS="TableRowColor">
322<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
324<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getClasspath()">getClasspath</A></B>()</CODE>
325
326<BR>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getEnvironment()">getEnvironment</A></B>()</CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>&nbsp;java.io.File</CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getFile()">getFile</A></B>()</CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
348<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getName()">getName</A></B>()</CODE>
349
350<BR>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
352</TR>
353<TR BGCOLOR="white" CLASS="TableRowColor">
354<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
356<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getPrefix()">getPrefix</A></B>()</CODE>
357
358<BR>
359&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
360</TR>
361<TR BGCOLOR="white" CLASS="TableRowColor">
362<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
363<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A></CODE></FONT></TD>
364<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getRefid()">getRefid</A></B>()</CODE>
365
366<BR>
367&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
368</TR>
369<TR BGCOLOR="white" CLASS="TableRowColor">
370<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
371<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
372<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getResource()">getResource</A></B>()</CODE>
373
374<BR>
375&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
376</TR>
377<TR BGCOLOR="white" CLASS="TableRowColor">
378<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
379<CODE>&nbsp;java.net.URL</CODE></FONT></TD>
380<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getUrl()">getUrl</A></B>()</CODE>
381
382<BR>
383&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
384</TR>
385<TR BGCOLOR="white" CLASS="TableRowColor">
386<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
387<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
388<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#getValue()">getValue</A></B>()</CODE>
389
390<BR>
391&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
392</TR>
393<TR BGCOLOR="white" CLASS="TableRowColor">
394<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
395<CODE>protected &nbsp;void</CODE></FONT></TD>
396<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#loadEnvironment(java.lang.String)">loadEnvironment</A></B>(java.lang.String&nbsp;prefix)</CODE>
397
398<BR>
399&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;load the environment values</TD>
400</TR>
401<TR BGCOLOR="white" CLASS="TableRowColor">
402<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403<CODE>protected &nbsp;void</CODE></FONT></TD>
404<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#loadFile(java.io.File)">loadFile</A></B>(java.io.File&nbsp;file)</CODE>
405
406<BR>
407&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;load properties from a file</TD>
408</TR>
409<TR BGCOLOR="white" CLASS="TableRowColor">
410<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
411<CODE>protected &nbsp;void</CODE></FONT></TD>
412<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#loadResource(java.lang.String)">loadResource</A></B>(java.lang.String&nbsp;name)</CODE>
413
414<BR>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;load properties from a resource in the current classpath</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>protected &nbsp;void</CODE></FONT></TD>
420<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#loadUrl(java.net.URL)">loadUrl</A></B>(java.net.URL&nbsp;url)</CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;load properties from a url</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>&nbsp;void</CODE></FONT></TD>
428<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The classpath to use when looking up a resource.</TD>
432</TR>
433<TR BGCOLOR="white" CLASS="TableRowColor">
434<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435<CODE>&nbsp;void</CODE></FONT></TD>
436<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
437
438<BR>
439&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the classpath to use when looking up a resource,
440 given as reference to a &lt;path&gt; defined elsewhere</TD>
441</TR>
442<TR BGCOLOR="white" CLASS="TableRowColor">
443<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
444<CODE>&nbsp;void</CODE></FONT></TD>
445<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setEnvironment(java.lang.String)">setEnvironment</A></B>(java.lang.String&nbsp;env)</CODE>
446
447<BR>
448&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prefix to use when retrieving environment variables.</TD>
449</TR>
450<TR BGCOLOR="white" CLASS="TableRowColor">
451<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
452<CODE>&nbsp;void</CODE></FONT></TD>
453<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setFile(java.io.File)">setFile</A></B>(java.io.File&nbsp;file)</CODE>
454
455<BR>
456&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Filename of a property file to load.</TD>
457</TR>
458<TR BGCOLOR="white" CLASS="TableRowColor">
459<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
460<CODE>&nbsp;void</CODE></FONT></TD>
461<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setLocation(java.io.File)">setLocation</A></B>(java.io.File&nbsp;location)</CODE>
462
463<BR>
464&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the property to the absolute filename of the
465 given file.</TD>
466</TR>
467<TR BGCOLOR="white" CLASS="TableRowColor">
468<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
469<CODE>&nbsp;void</CODE></FONT></TD>
470<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
471
472<BR>
473&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the property to set.</TD>
474</TR>
475<TR BGCOLOR="white" CLASS="TableRowColor">
476<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
477<CODE>&nbsp;void</CODE></FONT></TD>
478<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setPrefix(java.lang.String)">setPrefix</A></B>(java.lang.String&nbsp;prefix)</CODE>
479
480<BR>
481&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prefix to apply to properties loaded using <code>file</code>
482 or <code>resource</code>.</TD>
483</TR>
484<TR BGCOLOR="white" CLASS="TableRowColor">
485<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
486<CODE>&nbsp;void</CODE></FONT></TD>
487<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.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;ref)</CODE>
488
489<BR>
490&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a reference to an Ant datatype
491 declared elsewhere.</TD>
492</TR>
493<TR BGCOLOR="white" CLASS="TableRowColor">
494<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
495<CODE>&nbsp;void</CODE></FONT></TD>
496<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setResource(java.lang.String)">setResource</A></B>(java.lang.String&nbsp;resource)</CODE>
497
498<BR>
499&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The resource name of a property file to load</TD>
500</TR>
501<TR BGCOLOR="white" CLASS="TableRowColor">
502<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
503<CODE>&nbsp;void</CODE></FONT></TD>
504<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setUrl(java.net.URL)">setUrl</A></B>(java.net.URL&nbsp;url)</CODE>
505
506<BR>
507&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The url from which to load properties.</TD>
508</TR>
509<TR BGCOLOR="white" CLASS="TableRowColor">
510<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
511<CODE>&nbsp;void</CODE></FONT></TD>
512<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setUserProperty(boolean)">setUserProperty</A></B>(boolean&nbsp;userProperty)</CODE>
513
514<BR>
515&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>This was never a supported feature and has been
516 deprecated without replacement</I></TD>
517</TR>
518<TR BGCOLOR="white" CLASS="TableRowColor">
519<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
520<CODE>&nbsp;void</CODE></FONT></TD>
521<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#setValue(java.lang.String)">setValue</A></B>(java.lang.String&nbsp;value)</CODE>
522
523<BR>
524&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The value of the property.</TD>
525</TR>
526<TR BGCOLOR="white" CLASS="TableRowColor">
527<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
528<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
529<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Property.html#toString()">toString</A></B>()</CODE>
530
531<BR>
532&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the value of this property</TD>
533</TR>
534</TABLE>
535&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
536<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
537<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
538<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
539</TR>
540<TR BGCOLOR="white" CLASS="TableRowColor">
541<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
542</TR>
543</TABLE>
544&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
545<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
546<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
547<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>
548</TR>
549<TR BGCOLOR="white" CLASS="TableRowColor">
550<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
551</TR>
552</TABLE>
553&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
554<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
555<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
556<TD><B>Methods inherited from class java.lang.Object</B></TD>
557</TR>
558<TR BGCOLOR="white" CLASS="TableRowColor">
559<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
560</TR>
561</TABLE>
562&nbsp;
563<P>
564
565<!-- ============ FIELD DETAIL =========== -->
566
567<A NAME="field_detail"><!-- --></A>
568<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
569<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
570<TD COLSPAN=1><FONT SIZE="+2">
571<B>Field Detail</B></FONT></TD>
572</TR>
573</TABLE>
574
575<A NAME="name"><!-- --></A><H3>
576name</H3>
577<PRE>
578protected java.lang.String <B>name</B></PRE>
579<DL>
580<DL>
581</DL>
582</DL>
583<HR>
584
585<A NAME="value"><!-- --></A><H3>
586value</H3>
587<PRE>
588protected java.lang.String <B>value</B></PRE>
589<DL>
590<DL>
591</DL>
592</DL>
593<HR>
594
595<A NAME="file"><!-- --></A><H3>
596file</H3>
597<PRE>
598protected java.io.File <B>file</B></PRE>
599<DL>
600<DL>
601</DL>
602</DL>
603<HR>
604
605<A NAME="url"><!-- --></A><H3>
606url</H3>
607<PRE>
608protected java.net.URL <B>url</B></PRE>
609<DL>
610<DL>
611</DL>
612</DL>
613<HR>
614
615<A NAME="resource"><!-- --></A><H3>
616resource</H3>
617<PRE>
618protected java.lang.String <B>resource</B></PRE>
619<DL>
620<DL>
621</DL>
622</DL>
623<HR>
624
625<A NAME="classpath"><!-- --></A><H3>
626classpath</H3>
627<PRE>
628protected <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>classpath</B></PRE>
629<DL>
630<DL>
631</DL>
632</DL>
633<HR>
634
635<A NAME="env"><!-- --></A><H3>
636env</H3>
637<PRE>
638protected java.lang.String <B>env</B></PRE>
639<DL>
640<DL>
641</DL>
642</DL>
643<HR>
644
645<A NAME="ref"><!-- --></A><H3>
646ref</H3>
647<PRE>
648protected <A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> <B>ref</B></PRE>
649<DL>
650<DL>
651</DL>
652</DL>
653<HR>
654
655<A NAME="prefix"><!-- --></A><H3>
656prefix</H3>
657<PRE>
658protected java.lang.String <B>prefix</B></PRE>
659<DL>
660<DL>
661</DL>
662</DL>
663<HR>
664
665<A NAME="userProperty"><!-- --></A><H3>
666userProperty</H3>
667<PRE>
668protected boolean <B>userProperty</B></PRE>
669<DL>
670<DL>
671</DL>
672</DL>
673
674<!-- ========= CONSTRUCTOR DETAIL ======== -->
675
676<A NAME="constructor_detail"><!-- --></A>
677<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
678<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
679<TD COLSPAN=1><FONT SIZE="+2">
680<B>Constructor Detail</B></FONT></TD>
681</TR>
682</TABLE>
683
684<A NAME="Property()"><!-- --></A><H3>
685Property</H3>
686<PRE>
687public <B>Property</B>()</PRE>
688<DL>
689</DL>
690<HR>
691
692<A NAME="Property(boolean)"><!-- --></A><H3>
693Property</H3>
694<PRE>
695protected <B>Property</B>(boolean&nbsp;userProperty)</PRE>
696<DL>
697<DT><B>Since:</B></DT>
698 <DD>Ant 1.5</DD>
699</DL>
700<HR>
701
702<A NAME="Property(boolean, org.apache.tools.ant.Project)"><!-- --></A><H3>
703Property</H3>
704<PRE>
705protected <B>Property</B>(boolean&nbsp;userProperty,
706 <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;fallback)</PRE>
707<DL>
708<DT><B>Since:</B></DT>
709 <DD>Ant 1.5</DD>
710</DL>
711
712<!-- ============ METHOD DETAIL ========== -->
713
714<A NAME="method_detail"><!-- --></A>
715<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
716<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
717<TD COLSPAN=1><FONT SIZE="+2">
718<B>Method Detail</B></FONT></TD>
719</TR>
720</TABLE>
721
722<A NAME="setName(java.lang.String)"><!-- --></A><H3>
723setName</H3>
724<PRE>
725public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
726<DL>
727<DD>The name of the property to set.
728<P>
729<DD><DL>
730<DT><B>Parameters:</B><DD><CODE>name</CODE> - property name</DL>
731</DD>
732</DL>
733<HR>
734
735<A NAME="getName()"><!-- --></A><H3>
736getName</H3>
737<PRE>
738public java.lang.String <B>getName</B>()</PRE>
739<DL>
740<DD><DL>
741</DL>
742</DD>
743</DL>
744<HR>
745
746<A NAME="setLocation(java.io.File)"><!-- --></A><H3>
747setLocation</H3>
748<PRE>
749public void <B>setLocation</B>(java.io.File&nbsp;location)</PRE>
750<DL>
751<DD>Sets the property to the absolute filename of the
752 given file. If the value of this attribute is an absolute path, it
753 is left unchanged (with / and \ characters converted to the
754 current platforms conventions). Otherwise it is taken as a path
755 relative to the project's basedir and expanded.
756<P>
757<DD><DL>
758<DT><B>Parameters:</B><DD><CODE>location</CODE> - path to set</DL>
759</DD>
760</DL>
761<HR>
762
763<A NAME="setValue(java.lang.String)"><!-- --></A><H3>
764setValue</H3>
765<PRE>
766public void <B>setValue</B>(java.lang.String&nbsp;value)</PRE>
767<DL>
768<DD>The value of the property.
769<P>
770<DD><DL>
771<DT><B>Parameters:</B><DD><CODE>value</CODE> - value to assign</DL>
772</DD>
773</DL>
774<HR>
775
776<A NAME="getValue()"><!-- --></A><H3>
777getValue</H3>
778<PRE>
779public java.lang.String <B>getValue</B>()</PRE>
780<DL>
781<DD><DL>
782</DL>
783</DD>
784</DL>
785<HR>
786
787<A NAME="setFile(java.io.File)"><!-- --></A><H3>
788setFile</H3>
789<PRE>
790public void <B>setFile</B>(java.io.File&nbsp;file)</PRE>
791<DL>
792<DD>Filename of a property file to load.
793<P>
794<DD><DL>
795<DT><B>Parameters:</B><DD><CODE>file</CODE> - filename</DL>
796</DD>
797</DL>
798<HR>
799
800<A NAME="getFile()"><!-- --></A><H3>
801getFile</H3>
802<PRE>
803public java.io.File <B>getFile</B>()</PRE>
804<DL>
805<DD><DL>
806</DL>
807</DD>
808</DL>
809<HR>
810
811<A NAME="setUrl(java.net.URL)"><!-- --></A><H3>
812setUrl</H3>
813<PRE>
814public void <B>setUrl</B>(java.net.URL&nbsp;url)</PRE>
815<DL>
816<DD>The url from which to load properties.
817<P>
818<DD><DL>
819<DT><B>Parameters:</B><DD><CODE>url</CODE> - url string</DL>
820</DD>
821</DL>
822<HR>
823
824<A NAME="getUrl()"><!-- --></A><H3>
825getUrl</H3>
826<PRE>
827public java.net.URL <B>getUrl</B>()</PRE>
828<DL>
829<DD><DL>
830</DL>
831</DD>
832</DL>
833<HR>
834
835<A NAME="setPrefix(java.lang.String)"><!-- --></A><H3>
836setPrefix</H3>
837<PRE>
838public void <B>setPrefix</B>(java.lang.String&nbsp;prefix)</PRE>
839<DL>
840<DD>Prefix to apply to properties loaded using <code>file</code>
841 or <code>resource</code>.
842 A "." is appended to the prefix if not specified.
843<P>
844<DD><DL>
845<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - prefix string<DT><B>Since:</B></DT>
846 <DD>Ant 1.5</DD>
847</DL>
848</DD>
849</DL>
850<HR>
851
852<A NAME="getPrefix()"><!-- --></A><H3>
853getPrefix</H3>
854<PRE>
855public java.lang.String <B>getPrefix</B>()</PRE>
856<DL>
857<DD><DL>
858<DT><B>Since:</B></DT>
859 <DD>Ant 1.5</DD>
860</DL>
861</DD>
862</DL>
863<HR>
864
865<A NAME="setRefid(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
866setRefid</H3>
867<PRE>
868public void <B>setRefid</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;ref)</PRE>
869<DL>
870<DD>Sets a reference to an Ant datatype
871 declared elsewhere.
872 Only yields reasonable results for references
873 PATH like structures or properties.
874<P>
875<DD><DL>
876<DT><B>Parameters:</B><DD><CODE>ref</CODE> - reference</DL>
877</DD>
878</DL>
879<HR>
880
881<A NAME="getRefid()"><!-- --></A><H3>
882getRefid</H3>
883<PRE>
884public <A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> <B>getRefid</B>()</PRE>
885<DL>
886<DD><DL>
887</DL>
888</DD>
889</DL>
890<HR>
891
892<A NAME="setResource(java.lang.String)"><!-- --></A><H3>
893setResource</H3>
894<PRE>
895public void <B>setResource</B>(java.lang.String&nbsp;resource)</PRE>
896<DL>
897<DD>The resource name of a property file to load
898<P>
899<DD><DL>
900<DT><B>Parameters:</B><DD><CODE>resource</CODE> - resource on classpath</DL>
901</DD>
902</DL>
903<HR>
904
905<A NAME="getResource()"><!-- --></A><H3>
906getResource</H3>
907<PRE>
908public java.lang.String <B>getResource</B>()</PRE>
909<DL>
910<DD><DL>
911</DL>
912</DD>
913</DL>
914<HR>
915
916<A NAME="setEnvironment(java.lang.String)"><!-- --></A><H3>
917setEnvironment</H3>
918<PRE>
919public void <B>setEnvironment</B>(java.lang.String&nbsp;env)</PRE>
920<DL>
921<DD>Prefix to use when retrieving environment variables.
922 Thus if you specify environment=&quot;myenv&quot;
923 you will be able to access OS-specific
924 environment variables via property names &quot;myenv.PATH&quot; or
925 &quot;myenv.TERM&quot;.
926 <p>
927 Note that if you supply a property name with a final
928 &quot;.&quot; it will not be doubled. ie environment=&quot;myenv.&quot; will still
929 allow access of environment variables through &quot;myenv.PATH&quot; and
930 &quot;myenv.TERM&quot;. This functionality is currently only implemented
931 on select platforms. Feel free to send patches to increase the number of platforms
932 this functionality is supported on ;).<br>
933 Note also that properties are case sensitive, even if the
934 environment variables on your operating system are not, e.g. it
935 will be ${env.Path} not ${env.PATH} on Windows 2000.
936<P>
937<DD><DL>
938<DT><B>Parameters:</B><DD><CODE>env</CODE> - prefix</DL>
939</DD>
940</DL>
941<HR>
942
943<A NAME="getEnvironment()"><!-- --></A><H3>
944getEnvironment</H3>
945<PRE>
946public java.lang.String <B>getEnvironment</B>()</PRE>
947<DL>
948<DD><DL>
949<DT><B>Since:</B></DT>
950 <DD>Ant 1.5</DD>
951</DL>
952</DD>
953</DL>
954<HR>
955
956<A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
957setClasspath</H3>
958<PRE>
959public void <B>setClasspath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</PRE>
960<DL>
961<DD>The classpath to use when looking up a resource.
962<P>
963<DD><DL>
964<DT><B>Parameters:</B><DD><CODE>classpath</CODE> - to add to any existing classpath</DL>
965</DD>
966</DL>
967<HR>
968
969<A NAME="createClasspath()"><!-- --></A><H3>
970createClasspath</H3>
971<PRE>
972public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
973<DL>
974<DD>The classpath to use when looking up a resource.
975<P>
976<DD><DL>
977</DL>
978</DD>
979</DL>
980<HR>
981
982<A NAME="setClasspathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
983setClasspathRef</H3>
984<PRE>
985public void <B>setClasspathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
986<DL>
987<DD>the classpath to use when looking up a resource,
988 given as reference to a &lt;path&gt; defined elsewhere
989<P>
990<DD><DL>
991</DL>
992</DD>
993</DL>
994<HR>
995
996<A NAME="getClasspath()"><!-- --></A><H3>
997getClasspath</H3>
998<PRE>
999public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>getClasspath</B>()</PRE>
1000<DL>
1001<DD><DL>
1002<DT><B>Since:</B></DT>
1003 <DD>Ant 1.5</DD>
1004</DL>
1005</DD>
1006</DL>
1007<HR>
1008
1009<A NAME="setUserProperty(boolean)"><!-- --></A><H3>
1010setUserProperty</H3>
1011<PRE>
1012public void <B>setUserProperty</B>(boolean&nbsp;userProperty)</PRE>
1013<DL>
1014<DD><B>Deprecated.</B>&nbsp;<I>This was never a supported feature and has been
1015 deprecated without replacement</I>
1016<P>
1017<DD><DL>
1018</DL>
1019</DD>
1020</DL>
1021<HR>
1022
1023<A NAME="toString()"><!-- --></A><H3>
1024toString</H3>
1025<PRE>
1026public java.lang.String <B>toString</B>()</PRE>
1027<DL>
1028<DD>get the value of this property
1029<P>
1030<DD><DL>
1031
1032<DT><B>Returns:</B><DD>the current value or the empty string</DL>
1033</DD>
1034</DL>
1035<HR>
1036
1037<A NAME="execute()"><!-- --></A><H3>
1038execute</H3>
1039<PRE>
1040public void <B>execute</B>()
1041 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1042<DL>
1043<DD>set the property in the project to the value.
1044 if the task was give a file, resource or env attribute
1045 here is where it is loaded
1046<P>
1047<DD><DL>
1048<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
1049</DD>
1050<DD><DL>
1051
1052<DT><B>Throws:</B>
1053<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something goes wrong with the build</DL>
1054</DD>
1055</DL>
1056<HR>
1057
1058<A NAME="loadUrl(java.net.URL)"><!-- --></A><H3>
1059loadUrl</H3>
1060<PRE>
1061protected void <B>loadUrl</B>(java.net.URL&nbsp;url)
1062 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1063<DL>
1064<DD>load properties from a url
1065<P>
1066<DD><DL>
1067<DT><B>Parameters:</B><DD><CODE>url</CODE> - url to load from
1068<DT><B>Throws:</B>
1069<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
1070</DD>
1071</DL>
1072<HR>
1073
1074<A NAME="loadFile(java.io.File)"><!-- --></A><H3>
1075loadFile</H3>
1076<PRE>
1077protected void <B>loadFile</B>(java.io.File&nbsp;file)
1078 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1079<DL>
1080<DD>load properties from a file
1081<P>
1082<DD><DL>
1083<DT><B>Parameters:</B><DD><CODE>file</CODE> - file to load
1084<DT><B>Throws:</B>
1085<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
1086</DD>
1087</DL>
1088<HR>
1089
1090<A NAME="loadResource(java.lang.String)"><!-- --></A><H3>
1091loadResource</H3>
1092<PRE>
1093protected void <B>loadResource</B>(java.lang.String&nbsp;name)</PRE>
1094<DL>
1095<DD>load properties from a resource in the current classpath
1096<P>
1097<DD><DL>
1098<DT><B>Parameters:</B><DD><CODE>name</CODE> - name of resource to load</DL>
1099</DD>
1100</DL>
1101<HR>
1102
1103<A NAME="loadEnvironment(java.lang.String)"><!-- --></A><H3>
1104loadEnvironment</H3>
1105<PRE>
1106protected void <B>loadEnvironment</B>(java.lang.String&nbsp;prefix)</PRE>
1107<DL>
1108<DD>load the environment values
1109<P>
1110<DD><DL>
1111<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - prefix to place before them</DL>
1112</DD>
1113</DL>
1114<HR>
1115
1116<A NAME="addProperties(java.util.Properties)"><!-- --></A><H3>
1117addProperties</H3>
1118<PRE>
1119protected void <B>addProperties</B>(java.util.Properties&nbsp;props)</PRE>
1120<DL>
1121<DD>iterate through a set of properties,
1122 resolve them then assign them
1123<P>
1124<DD><DL>
1125</DL>
1126</DD>
1127</DL>
1128<HR>
1129
1130<A NAME="addProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
1131addProperty</H3>
1132<PRE>
1133protected void <B>addProperty</B>(java.lang.String&nbsp;n,
1134 java.lang.String&nbsp;v)</PRE>
1135<DL>
1136<DD>add a name value pair to the project property set
1137<P>
1138<DD><DL>
1139<DT><B>Parameters:</B><DD><CODE>n</CODE> - name of property<DD><CODE>v</CODE> - value to set</DL>
1140</DD>
1141</DL>
1142<!-- ========= END OF CLASS DATA ========= -->
1143<HR>
1144
1145
1146<!-- ======= START OF BOTTOM NAVBAR ====== -->
1147<A NAME="navbar_bottom"><!-- --></A>
1148<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1149<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1150<TR>
1151<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1152<A NAME="navbar_bottom_firstrow"><!-- --></A>
1153<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1154 <TR ALIGN="center" VALIGN="top">
1155 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1156 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1157 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1158 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1159 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1160 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1161 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1162 </TR>
1163</TABLE>
1164</TD>
1165<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1166</EM>
1167</TD>
1168</TR>
1169
1170<TR>
1171<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1172&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/PreSetDef.PreSetDefinition.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
1173&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/PumpStreamHandler.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
1174<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1175 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
1176&nbsp;<A HREF="Property.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1177&nbsp;<SCRIPT type="text/javascript">
1178 <!--
1179 if(window==top) {
1180 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1181 }
1182 //-->
1183</SCRIPT>
1184<NOSCRIPT>
1185 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1186</NOSCRIPT>
1187
1188</FONT></TD>
1189</TR>
1190<TR>
1191<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1192 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1193<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1194DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1195</TR>
1196</TABLE>
1197<A NAME="skip-navbar_bottom"></A>
1198<!-- ======== END OF BOTTOM NAVBAR ======= -->
1199
1200<HR>
1201Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
1202</BODY>
1203</HTML>
Note: See TracBrowser for help on using the repository browser.