ant/docs/manual/CoreTasks/loadfile.html

65 lines
2.7 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>LoadFile Task</title>
</head>
<body>
<h2><a name="loadfile">LoadFile</a></h2>
<h3>Description</h3>
<p> Load a text file into a single property. Unless an encoding is specified,
the encoding of the current locale is used. </p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tbody>
<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">srcFile</td>
<td valign="top">source file</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">property</td>
<td valign="top">property to save to</td>
<td valign="top" align="center">Yes</td>
</tr>
<tr>
<td valign="top">encoding</td>
<td valign="top">encoding to use when loading the file</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td valign="top">Whether to halt the build on failure</td>
<td align="center" valign="top">No, default "true"</td>
</tr>
</tbody>
</table>
<p>The LoadFile task supports nested <a
href="../CoreTypes/filterchain.html">FilterChain</a>s. </p>
<h3>Examples</h3>
<pre> &lt;loadfile property="message"<br> srcFile="message.txt"/&gt;<br></pre>
Load file message.txt into property "message"; an <tt>&lt;echo&gt;</tt>can
print this.
<pre> &lt;loadfile property="encoded-file"<br> srcFile="loadfile.xml"<br> encoding="ISO-8859-1"/&gt;<br></pre>
Load a file using the latin-1 encoding
<pre> &lt;loadfile<br> property="optional.value"<br> srcFile="optional.txt"<br> failonerror="false"/&gt;<br></pre>
Load a file, don't fail if it is missing (a message is printed, though)
<pre> &lt;loadfile<br> property="mail.recipients"<br> srcFile="recipientlist.txt"&gt;<br> &lt;filterchain&gt;<br> &lt;<a
href="../CoreTypes/filterchain.html#striplinebreaks">striplinebreaks</a>/&gt;<br> &lt;/filterchain&gt;<br> &lt;/loadfile&gt;<br></pre>
Load a property which can be used as a parameter for another task (in this
case mail), merging lines to ensure this happens.
<pre> &lt;loadfile<br> property="system.configuration.xml"<br> srcFile="configuration.xml"&gt;<br> &lt;filterchain&gt;<br> &lt;<a
href="../CoreTypes/filterchain.html#expandproperties">expandproperties</a>/&gt;<br> &lt;/filterchain&gt;<br> &lt;/loadfile&gt;<br></pre>
Load an XML file into a property, expanding all properties declared in the
file in the process.
<hr>
<p align="center">Copyright &copy; 2001-2002 Apache Software Foundation.
All rights Reserved.</p>
<br>
</body>
</html>