source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/EchoProperties.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: 27.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:23 NZST 2007 -->
6<TITLE>
7EchoProperties (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.EchoProperties 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="EchoProperties (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/Cab.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/EchoProperties.FormatAttribute.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="EchoProperties.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 EchoProperties</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.EchoProperties</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>EchoProperties</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Displays all the current properties in the build. The output can be sent to
99 a file if desired. <P>
100
101 Attribute "destfile" defines a file to send the properties to. This can be
102 processed as a standard property file later. <P>
103
104 Attribute "prefix" defines a prefix which is used to filter the properties
105 only those properties starting with this prefix will be echoed. <P>
106
107 By default, the "failonerror" attribute is enabled. If an error occurs while
108 writing the properties to a file, and this attribute is enabled, then a
109 BuildException will be thrown. If disabled, then IO errors will be reported
110 as a log statement, but no error will be thrown. <P>
111
112 Examples: <pre>
113 &lt;echoproperties /&gt;
114 </pre> Report the current properties to the log. <P>
115
116 <pre>
117 &lt;echoproperties destfile="my.properties" /&gt;
118 </pre> Report the current properties to the file "my.properties", and will
119 fail the build if the file could not be created or written to. <P>
120
121 <pre>
122 &lt;echoproperties destfile="my.properties" failonerror="false"
123 prefix="ant" /&gt;
124 </pre> Report all properties beginning with 'ant' to the file
125 "my.properties", and will log a message if the file could not be created or
126 written to, but will still allow the build to continue.
127<P>
128
129<P>
130<DL>
131<DT><B>Since:</B></DT>
132 <DD>Ant 1.5</DD>
133</DL>
134<HR>
135
136<P>
137<!-- ======== NESTED CLASS SUMMARY ======== -->
138
139<A NAME="nested_class_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TD COLSPAN=2><FONT SIZE="+2">
143<B>Nested Class Summary</B></FONT></TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>static&nbsp;class</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional">EchoProperties.FormatAttribute</A></B></CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153</TABLE>
154&nbsp;
155<!-- =========== FIELD SUMMARY =========== -->
156
157<A NAME="field_summary"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160<TD COLSPAN=2><FONT SIZE="+2">
161<B>Field Summary</B></FONT></TD>
162</TR>
163</TABLE>
164&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
167<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>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<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>
171</TR>
172</TABLE>
173&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
176<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>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
180</TR>
181</TABLE>
182&nbsp;
183<!-- ======== CONSTRUCTOR SUMMARY ======== -->
184
185<A NAME="constructor_summary"><!-- --></A>
186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
188<TD COLSPAN=2><FONT SIZE="+2">
189<B>Constructor Summary</B></FONT></TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#EchoProperties()">EchoProperties</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
196</TR>
197</TABLE>
198&nbsp;
199<!-- ========== METHOD SUMMARY =========== -->
200
201<A NAME="method_summary"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204<TD COLSPAN=2><FONT SIZE="+2">
205<B>Method Summary</B></FONT></TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;void</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.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;ps)</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A set of properties to write.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;void</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#execute()">execute</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Run the task.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>protected &nbsp;void</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#jdkSaveProperties(java.util.Properties, java.io.OutputStream, java.lang.String)">jdkSaveProperties</A></B>(java.util.Properties&nbsp;props,
227 java.io.OutputStream&nbsp;os,
228 java.lang.String&nbsp;header)</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;JDK 1.2 allows for the safer method
232 <tt>Properties.store(OutputStream, String)</tt>, which throws an
233 <tt>IOException</tt> on an output error.</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>protected &nbsp;void</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#saveProperties(java.util.Hashtable, java.io.OutputStream)">saveProperties</A></B>(java.util.Hashtable&nbsp;allProps,
239 java.io.OutputStream&nbsp;os)</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send the key/value pairs in the hashtable to the given output stream.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;void</CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#setDestfile(java.io.File)">setDestfile</A></B>(java.io.File&nbsp;destfile)</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a file to store the property output.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;void</CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#setFailOnError(boolean)">setFailOnError</A></B>(boolean&nbsp;failonerror)</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the task will fail if an error occurs writing the properties
259 file, otherwise errors are just logged.</TD>
260</TR>
261<TR BGCOLOR="white" CLASS="TableRowColor">
262<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263<CODE>&nbsp;void</CODE></FONT></TD>
264<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#setFormat(org.apache.tools.ant.taskdefs.optional.EchoProperties.FormatAttribute)">setFormat</A></B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional">EchoProperties.FormatAttribute</A>&nbsp;ea)</CODE>
265
266<BR>
267&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
271<CODE>&nbsp;void</CODE></FONT></TD>
272<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#setPrefix(java.lang.String)">setPrefix</A></B>(java.lang.String&nbsp;prefix)</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the prefix is set, then only properties which start with this
276 prefix string will be recorded.</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#setSrcfile(java.io.File)">setSrcfile</A></B>(java.io.File&nbsp;file)</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the input file.</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<CODE>protected &nbsp;void</CODE></FONT></TD>
289<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.html#xmlSaveProperties(java.util.Properties, java.io.OutputStream)">xmlSaveProperties</A></B>(java.util.Properties&nbsp;props,
290 java.io.OutputStream&nbsp;os)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
294</TR>
295</TABLE>
296&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
299<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>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<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>
303</TR>
304</TABLE>
305&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
306<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
307<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
308<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>
309</TR>
310<TR BGCOLOR="white" CLASS="TableRowColor">
311<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>
312</TR>
313</TABLE>
314&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
317<TD><B>Methods inherited from class java.lang.Object</B></TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
321</TR>
322</TABLE>
323&nbsp;
324<P>
325
326<!-- ============ FIELD DETAIL =========== -->
327
328
329<!-- ========= CONSTRUCTOR DETAIL ======== -->
330
331<A NAME="constructor_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>Constructor Detail</B></FONT></TD>
336</TR>
337</TABLE>
338
339<A NAME="EchoProperties()"><!-- --></A><H3>
340EchoProperties</H3>
341<PRE>
342public <B>EchoProperties</B>()</PRE>
343<DL>
344</DL>
345
346<!-- ============ METHOD DETAIL ========== -->
347
348<A NAME="method_detail"><!-- --></A>
349<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
350<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
351<TD COLSPAN=1><FONT SIZE="+2">
352<B>Method Detail</B></FONT></TD>
353</TR>
354</TABLE>
355
356<A NAME="setSrcfile(java.io.File)"><!-- --></A><H3>
357setSrcfile</H3>
358<PRE>
359public void <B>setSrcfile</B>(java.io.File&nbsp;file)</PRE>
360<DL>
361<DD>Sets the input file.
362<P>
363<DD><DL>
364<DT><B>Parameters:</B><DD><CODE>file</CODE> - the input file</DL>
365</DD>
366</DL>
367<HR>
368
369<A NAME="setDestfile(java.io.File)"><!-- --></A><H3>
370setDestfile</H3>
371<PRE>
372public void <B>setDestfile</B>(java.io.File&nbsp;destfile)</PRE>
373<DL>
374<DD>Set a file to store the property output. If this is never specified,
375 then the output will be sent to the Ant log.
376<P>
377<DD><DL>
378<DT><B>Parameters:</B><DD><CODE>destfile</CODE> - file to store the property output</DL>
379</DD>
380</DL>
381<HR>
382
383<A NAME="setFailOnError(boolean)"><!-- --></A><H3>
384setFailOnError</H3>
385<PRE>
386public void <B>setFailOnError</B>(boolean&nbsp;failonerror)</PRE>
387<DL>
388<DD>If true, the task will fail if an error occurs writing the properties
389 file, otherwise errors are just logged.
390<P>
391<DD><DL>
392<DT><B>Parameters:</B><DD><CODE>failonerror</CODE> - <tt>true</tt> if IO exceptions are reported as build
393 exceptions, or <tt>false</tt> if IO exceptions are ignored.</DL>
394</DD>
395</DL>
396<HR>
397
398<A NAME="setPrefix(java.lang.String)"><!-- --></A><H3>
399setPrefix</H3>
400<PRE>
401public void <B>setPrefix</B>(java.lang.String&nbsp;prefix)</PRE>
402<DL>
403<DD>If the prefix is set, then only properties which start with this
404 prefix string will be recorded. If this is never set, or it is set
405 to an empty string or <tt>null</tt>, then all properties will be
406 recorded. <P>
407
408 For example, if the property is set as:
409 <PRE>&lt;echoproperties prefix="ant." /&gt;</PRE>
410 then the property "ant.home" will be recorded, but "ant-example"
411 will not.
412<P>
413<DD><DL>
414<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The new prefix value</DL>
415</DD>
416</DL>
417<HR>
418
419<A NAME="addPropertyset(org.apache.tools.ant.types.PropertySet)"><!-- --></A><H3>
420addPropertyset</H3>
421<PRE>
422public void <B>addPropertyset</B>(<A HREF="../../../../../../org/apache/tools/ant/types/PropertySet.html" title="class in org.apache.tools.ant.types">PropertySet</A>&nbsp;ps)</PRE>
423<DL>
424<DD>A set of properties to write.
425<P>
426<DD><DL>
427<DT><B>Since:</B></DT>
428 <DD>Ant 1.6</DD>
429</DL>
430</DD>
431</DL>
432<HR>
433
434<A NAME="setFormat(org.apache.tools.ant.taskdefs.optional.EchoProperties.FormatAttribute)"><!-- --></A><H3>
435setFormat</H3>
436<PRE>
437public void <B>setFormat</B>(<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional">EchoProperties.FormatAttribute</A>&nbsp;ea)</PRE>
438<DL>
439<DD><DL>
440</DL>
441</DD>
442</DL>
443<HR>
444
445<A NAME="execute()"><!-- --></A><H3>
446execute</H3>
447<PRE>
448public void <B>execute</B>()
449 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
450<DL>
451<DD>Run the task.
452<P>
453<DD><DL>
454<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>
455</DD>
456<DD><DL>
457
458<DT><B>Throws:</B>
459<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - trouble, probably file IO</DL>
460</DD>
461</DL>
462<HR>
463
464<A NAME="saveProperties(java.util.Hashtable, java.io.OutputStream)"><!-- --></A><H3>
465saveProperties</H3>
466<PRE>
467protected void <B>saveProperties</B>(java.util.Hashtable&nbsp;allProps,
468 java.io.OutputStream&nbsp;os)
469 throws java.io.IOException,
470 <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
471<DL>
472<DD>Send the key/value pairs in the hashtable to the given output stream.
473 Only those properties matching the <tt>prefix</tt> constraint will be
474 sent to the output stream.
475 The output stream will be closed when this method returns.
476<P>
477<DD><DL>
478<DT><B>Parameters:</B><DD><CODE>allProps</CODE> - propfile to save<DD><CODE>os</CODE> - output stream
479<DT><B>Throws:</B>
480<DD><CODE>java.io.IOException</CODE> - trouble
481<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
482</DD>
483</DL>
484<HR>
485
486<A NAME="xmlSaveProperties(java.util.Properties, java.io.OutputStream)"><!-- --></A><H3>
487xmlSaveProperties</H3>
488<PRE>
489protected void <B>xmlSaveProperties</B>(java.util.Properties&nbsp;props,
490 java.io.OutputStream&nbsp;os)
491 throws java.io.IOException</PRE>
492<DL>
493<DD><DL>
494
495<DT><B>Throws:</B>
496<DD><CODE>java.io.IOException</CODE></DL>
497</DD>
498</DL>
499<HR>
500
501<A NAME="jdkSaveProperties(java.util.Properties, java.io.OutputStream, java.lang.String)"><!-- --></A><H3>
502jdkSaveProperties</H3>
503<PRE>
504protected void <B>jdkSaveProperties</B>(java.util.Properties&nbsp;props,
505 java.io.OutputStream&nbsp;os,
506 java.lang.String&nbsp;header)
507 throws java.io.IOException</PRE>
508<DL>
509<DD>JDK 1.2 allows for the safer method
510 <tt>Properties.store(OutputStream, String)</tt>, which throws an
511 <tt>IOException</tt> on an output error.
512<P>
513<DD><DL>
514<DT><B>Parameters:</B><DD><CODE>props</CODE> - the properties to record<DD><CODE>os</CODE> - record the properties to this output stream<DD><CODE>header</CODE> - prepend this header to the property output
515<DT><B>Throws:</B>
516<DD><CODE>java.io.IOException</CODE> - on an I/O error during a write.</DL>
517</DD>
518</DL>
519<!-- ========= END OF CLASS DATA ========= -->
520<HR>
521
522
523<!-- ======= START OF BOTTOM NAVBAR ====== -->
524<A NAME="navbar_bottom"><!-- --></A>
525<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
526<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
527<TR>
528<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
529<A NAME="navbar_bottom_firstrow"><!-- --></A>
530<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
531 <TR ALIGN="center" VALIGN="top">
532 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
533 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
534 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
535 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
536 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
537 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
538 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
539 </TR>
540</TABLE>
541</TD>
542<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
543</EM>
544</TD>
545</TR>
546
547<TR>
548<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
549&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Cab.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
550&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>NEXT CLASS</B></A></FONT></TD>
551<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
552 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
553&nbsp;<A HREF="EchoProperties.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
554&nbsp;<SCRIPT type="text/javascript">
555 <!--
556 if(window==top) {
557 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
558 }
559 //-->
560</SCRIPT>
561<NOSCRIPT>
562 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
563</NOSCRIPT>
564
565</FONT></TD>
566</TR>
567<TR>
568<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
569 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>
570<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
571DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
572</TR>
573</TABLE>
574<A NAME="skip-navbar_bottom"></A>
575<!-- ======== END OF BOTTOM NAVBAR ======= -->
576
577<HR>
578Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
579</BODY>
580</HTML>
Note: See TracBrowser for help on using the repository browser.