1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<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">No. Text may also be included in a
character section within this element. If neither is included a
blank line will be emitted in the output.</td>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">the file to write the message to.</td>
<td valign="top" align="center" rowspan="2">Optionally one of these may be specified.</td>
</tr>
<tr>
<td valign="top">output</td>
<td valign="top">the <a href="../Types/resources.html">Resource</a>
to write the message to (see <a href="../develop.html#set-magic">note</a>).
<b>Since Apache Ant 1.8</b></td>
</tr>
<tr>
<td valign="top">append</td>
<td valign="top">Append to an existing file (or
<a href="http://docs.oracle.com/javase/7/docs/api//java/io/FileWriter.html#FileWriter%28java.lang.String,%20boolean%29" target="_blank">
open a new file / overwrite an existing file</a>)? Default <i>false</i>.
</td>
<td valign="top" align="center">No; ignored unless <i>output</i> indicates a
filesystem destination.</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. <em>since Ant 1.7</em></td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">force</td>
<td valign="top">Overwrite read-only destination
files. <em>since Ant 1.8.2</em></td>
<td valign="top" align="center">No; defaults to false.</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>
</body>
</html>
|
