<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Echo Task</title>
</head>
<body>
<h2><a name="echo">Echo</a></h2>
<h3>Description</h3>
<p>Echoes a message to the current loggers and listeners which
means <tt>System.out</tt> unless overridden. A <tt>level</tt>
can be specified, which controls at what logging level the message is
filtered at.
<p>
The task can also echo to a file, in which case the option to append rather
than overwrite the file is available, and the <tt>level</tt> option is
ignored</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">message</td>
<td valign="top">the message to echo.</td>
<td valign="top" align="center">Yes, unless data is included in a
character section within this element.</td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">the file to write the message to.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">append</td>
<td valign="top">Append to an existing file (or
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/FileWriter.html#FileWriter(java.lang.String, boolean)" target="_blank">
open a new file / overwrite an existing file</a>)?
</td>
<td valign="top" align="center">No - default is false.</td>
</tr>
<tr>
<td valign="top">level</td>
<td valign="top">Control the level at which this message is reported.
One of "error", "warning", "info", "verbose", "debug" (decreasing order)</td>
<td valign="top" align="center">No - default is "warning".</td>
</tr>
<tr>
<td valign="top">encoding</td>
<td valign="top">encoding to use, default is ""; the local system encoding.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3>Examples</h3>
<pre>
<echo message="Hello, world"/>
</pre>
<pre>
<echo message="Embed a line break:${line.separator}"/>
</pre>
<pre>
<echo>Embed another:${line.separator}</echo>
</pre>
<pre>
<echo>This is a longer message stretching over
two lines.
</echo>
</pre>
<pre>
<echo>
This is a longer message stretching over
three lines; the first line is a blank
</echo>
</pre>
The newline immediately following the <echo> tag will be part of the output.<br>
Newlines in character data within the content of an element are not discarded by XML parsers.<br>
See <a href="http://www.w3.org/TR/2004/REC-xml-20040204/#sec-line-ends">
W3C Recommendation 04 February 2004 / End of Line handling
</a> for more details.
<pre><echo message="Deleting drive C:" level="debug"/></pre>
A message which only appears in <tt>-debug</tt> mode.
<pre><echo level="error">
Imminent failure in the antimatter containment facility.
Please withdraw to safe location at least 50km away.
</echo>
</pre>
A message which appears even in <tt>-quiet</tt> mode.
<pre><echo file="runner.csh" append="false">#\!/bin/tcsh
java-1.3.1 -mx1024m ${project.entrypoint} $$*
</echo></pre>
Generate a shell script by echoing to a file.
Note the use of a double $ symbol to stop Ant
filtering out the single $ during variable expansion
<p>Depending on the loglevel Ant runs, messages are print out or silently
ignored:
<table>
<tr>
<th>Ant-Statement</th>
<th>-quiet, -q</th>
<th><i>no statement</th>
<th>-verbose, -v</th>
<th>-debug, -d</th>
</tr>
<tr>
<td><pre><echo message="This is error message." level="error" /></pre></td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
</tr>
<tr>
<td><pre><echo message="This is warning message." /></pre></td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
</tr>
<tr>
<td><pre><echo message="This is warning message." level="warning" /></pre></td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
</tr>
<tr>
<td><pre><echo message="This is info message." level="info" /></pre></td>
<td align="center">not logged</td>
<td align="center">ok</td>
<td align="center">ok</td>
<td align="center">ok</td>
</tr>
<tr>
<td><pre><echo message="This is verbose message." level="verbose" /></pre></td>
<td align="center">not logged</td>
<td align="center">not logged</td>
<td align="center">ok</td>
<td align="center">ok</td>
</tr>
<tr>
<td><pre><echo message="This is debug message." level="debug" /></pre></td>
<td align="center">not logged</td>
<td align="center">not logged</td>
<td align="center">not logged</td>
<td align="center">ok</td>
</tr>
</table>
<hr>
<p align="center">Copyright © 2000-2002,2004-2005 The Apache Software Foundation. All rights
Reserved.</p>
</body>
</html>