source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/PropertyFile.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: 22.3 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:24 NZST 2007 -->
6<TITLE>
7PropertyFile (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.PropertyFile 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="PropertyFile (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/optional/NetRexxC.VerboseAttr.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html" title="class in org.apache.tools.ant.taskdefs.optional"><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="PropertyFile.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.Task">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.taskdefs.optional</FONT>
85<BR>
86Class PropertyFile</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.optional.PropertyFile</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>PropertyFile</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Modifies settings in a property file.
99
100 <p>
101The following is an example of its usage:
102 <ul>&lt;target name="setState"&gt;<br>
103 <ul>&lt;property<br>
104 <ul>name="header"<br>
105 value="##Generated file - do not modify!"/&gt;<br>
106 &lt;propertyfile file="apropfile.properties" comment="${header}"&gt;<br>
107 &lt;entry key="product.version.major" type="int" value="5"/&gt;<br>
108 &lt;entry key="product.version.minor" type="int" value="0"/&gt;<br>
109 &lt;entry key="product.build.major" type="int" value="0" /&gt;<br>
110 &lt;entry key="product.build.minor" type="int" operation="+" /&gt;<br>
111 &lt;entry key="product.build.date" type="date" value="now" /&gt;<br>
112 &lt;entry key="intSet" type="int" operation="=" value="681"/&gt;<br>
113 &lt;entry key="intDec" type="int" operation="-"/&gt;<br>
114 &lt;entry key="StringEquals" type="string" value="testValue"/&gt;<br>
115 &lt;/propertyfile&gt;<br></ul>
116 &lt;/target&gt;</ul><p>
117
118The &lt;propertyfile&gt; task must have:<br>
119 <ul><li>file</li></ul>
120Other parameters are:<br>
121 <ul><li>comment, key, operation, type and value (the final four being
122 eliminated shortly)</li></ul>
123
124The &lt;entry&gt; task must have:<br>
125 <ul><li>key</li></ul>
126Other parameters are:<br>
127 <ul><li>operation</li>
128 <li>type</li>
129 <li>value</li>
130 <li>default</li>
131 <li>unit</li>
132 </ul>
133
134If type is unspecified, it defaults to string
135
136Parameter values:<br>
137 <ul><li>operation:</li>
138 <ul><li>"=" (set -- default)</li>
139 <li>"-" (dec)</li>
140 <li>"+" (inc)</li>
141
142 <li>type:</li>
143 <ul><li>"int"</li>
144 <li>"date"</li>
145 <li>"string"</li></ul></ul>
146
147 <li>value:</li>
148 <ul><li>holds the default value, if the property
149 was not found in property file</li>
150 <li>"now" In case of type "date", the
151 value "now" will be replaced by the current
152 date/time and used even if a valid date was
153 found in the property file.</li></ul>
154
155
156String property types can only use the "=" operation.
157Int property types can only use the "=", "-" or "+" operations.<p>
158
159The message property is used for the property file header, with "\\" being
160a newline delimiter character.
161<P>
162
163<P>
164<HR>
165
166<P>
167<!-- ======== NESTED CLASS SUMMARY ======== -->
168
169<A NAME="nested_class_summary"><!-- --></A>
170<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
171<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
172<TD COLSPAN=2><FONT SIZE="+2">
173<B>Nested Class Summary</B></FONT></TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177<CODE>static&nbsp;class</CODE></FONT></TD>
178<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Entry</A></B></CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instance of this class represents nested elements of
182 a task propertyfile.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>static&nbsp;class</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Unit.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Unit</A></B></CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Borrowed from Tstamp</TD>
191</TR>
192</TABLE>
193&nbsp;
194<!-- =========== FIELD SUMMARY =========== -->
195
196<A NAME="field_summary"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TD COLSPAN=2><FONT SIZE="+2">
200<B>Field Summary</B></FONT></TD>
201</TR>
202</TABLE>
203&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
206<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>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<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>
210</TR>
211</TABLE>
212&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
214<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
215<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>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
219</TR>
220</TABLE>
221&nbsp;
222<!-- ======== CONSTRUCTOR SUMMARY ======== -->
223
224<A NAME="constructor_summary"><!-- --></A>
225<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
226<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
227<TD COLSPAN=2><FONT SIZE="+2">
228<B>Constructor Summary</B></FONT></TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.html#PropertyFile()">PropertyFile</A></B>()</CODE>
232
233<BR>
234&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
235</TR>
236</TABLE>
237&nbsp;
238<!-- ========== METHOD SUMMARY =========== -->
239
240<A NAME="method_summary"><!-- --></A>
241<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
242<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
243<TD COLSPAN=2><FONT SIZE="+2">
244<B>Method Summary</B></FONT></TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Entry</A></CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.html#createEntry()">createEntry</A></B>()</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.html#execute()">execute</A></B>()</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the project to let the task do its work.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.html#setComment(java.lang.String)">setComment</A></B>(java.lang.String&nbsp;hdr)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;optional header comment for the file</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.html#setFile(java.io.File)">setFile</A></B>(java.io.File&nbsp;file)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Location of the property file to be edited; required.</TD>
277</TR>
278</TABLE>
279&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
280<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
281<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
282<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>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<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>
286</TR>
287</TABLE>
288&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
289<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
290<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
291<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>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<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>
295</TR>
296</TABLE>
297&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
298<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
299<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
300<TD><B>Methods inherited from class java.lang.Object</B></TD>
301</TR>
302<TR BGCOLOR="white" CLASS="TableRowColor">
303<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
304</TR>
305</TABLE>
306&nbsp;
307<P>
308
309<!-- ============ FIELD DETAIL =========== -->
310
311
312<!-- ========= CONSTRUCTOR DETAIL ======== -->
313
314<A NAME="constructor_detail"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
317<TD COLSPAN=1><FONT SIZE="+2">
318<B>Constructor Detail</B></FONT></TD>
319</TR>
320</TABLE>
321
322<A NAME="PropertyFile()"><!-- --></A><H3>
323PropertyFile</H3>
324<PRE>
325public <B>PropertyFile</B>()</PRE>
326<DL>
327</DL>
328
329<!-- ============ METHOD DETAIL ========== -->
330
331<A NAME="method_detail"><!-- --></A>
332<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
333<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
334<TD COLSPAN=1><FONT SIZE="+2">
335<B>Method Detail</B></FONT></TD>
336</TR>
337</TABLE>
338
339<A NAME="execute()"><!-- --></A><H3>
340execute</H3>
341<PRE>
342public void <B>execute</B>()
343 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
344<DL>
345<DD><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></B></DD>
346<DD>Called by the project to let the task do its work. This method may be
347 called more than once, if the task is invoked more than once.
348 For example,
349 if target1 and target2 both depend on target3, then running
350 "ant target1 target2" will run all tasks in target3 twice.
351<P>
352<DD><DL>
353<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>
354</DD>
355<DD><DL>
356
357<DT><B>Throws:</B>
358<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>
359</DD>
360</DL>
361<HR>
362
363<A NAME="createEntry()"><!-- --></A><H3>
364createEntry</H3>
365<PRE>
366public <A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html" title="class in org.apache.tools.ant.taskdefs.optional">PropertyFile.Entry</A> <B>createEntry</B>()</PRE>
367<DL>
368<DD><DL>
369</DL>
370</DD>
371</DL>
372<HR>
373
374<A NAME="setFile(java.io.File)"><!-- --></A><H3>
375setFile</H3>
376<PRE>
377public void <B>setFile</B>(java.io.File&nbsp;file)</PRE>
378<DL>
379<DD>Location of the property file to be edited; required.
380<P>
381<DD><DL>
382</DL>
383</DD>
384</DL>
385<HR>
386
387<A NAME="setComment(java.lang.String)"><!-- --></A><H3>
388setComment</H3>
389<PRE>
390public void <B>setComment</B>(java.lang.String&nbsp;hdr)</PRE>
391<DL>
392<DD>optional header comment for the file
393<P>
394<DD><DL>
395</DL>
396</DD>
397</DL>
398<!-- ========= END OF CLASS DATA ========= -->
399<HR>
400
401
402<!-- ======= START OF BOTTOM NAVBAR ====== -->
403<A NAME="navbar_bottom"><!-- --></A>
404<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
405<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
406<TR>
407<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
408<A NAME="navbar_bottom_firstrow"><!-- --></A>
409<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
410 <TR ALIGN="center" VALIGN="top">
411 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
412 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
413 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
414 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
415 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
416 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
417 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
418 </TR>
419</TABLE>
420</TD>
421<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
422</EM>
423</TD>
424</TR>
425
426<TR>
427<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
428&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/NetRexxC.VerboseAttr.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
429&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>NEXT CLASS</B></A></FONT></TD>
430<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
431 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
432&nbsp;<A HREF="PropertyFile.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
433&nbsp;<SCRIPT type="text/javascript">
434 <!--
435 if(window==top) {
436 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
437 }
438 //-->
439</SCRIPT>
440<NOSCRIPT>
441 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
442</NOSCRIPT>
443
444</FONT></TD>
445</TR>
446<TR>
447<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
448 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
449<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
450DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
451</TR>
452</TABLE>
453<A NAME="skip-navbar_bottom"></A>
454<!-- ======== END OF BOTTOM NAVBAR ======= -->
455
456<HR>
457Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
458</BODY>
459</HTML>
Note: See TracBrowser for help on using the repository browser.