+ Load a text file into a single property. Unless an encoding is specified, + the encoding of the current locale is used. + +
+ +| Attribute | +Description | +Required | +
| srcFile | +source file | +Yes | +
| property | +property to save to | +Yes | +
| encoding | +encoding to use when loading the file | +No | +
| failonerror | +Whether to halt the build on failure | +No, default "true" | +
| evaluateProperties | +flag to enable property evalation in the file | +No, default "false" | +
+The LoadFile task supports nested +FilterReaderSets. + +
<loadfile property="message" + srcFile="message.txt" /> ++Load file message.txt into property "message"; an <echo> +can print this. + +
<loadfile property="encoded-file" + srcFile="loadfile.xml" + encoding="ISO-8859-1" /> ++Load a file using the latin-1 encoding + +
<loadfile + property="optional.value" + srcFile="optional.txt" + failonerror="false" /> ++Load a file, don't fail if it is missing (a message is printed, though) + +
<loadfile + property="mail.recipients" + srcFile="recipientlist.txt"> + <filterreaderset> + <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks" /> + </filterreaderset> + </loadfile> ++Load a property which can be used as a parameter for another task (in this case mail), +merging lines to ensure this happens. + +
<loadfile + property="system.configuration.xml" + srcFile="configuration.xml" + evaluateProperties="true" /> ++Load an XML file into a property, expanding all properties declared +in the file in the process. + + +
Copyright © 2001-2002 Apache Software Foundation. All rights +Reserved.
+ + + + diff --git a/proposal/sandbox/filterreaders/docs/manual/CoreTypes/filterreaderset.html b/proposal/sandbox/filterreaders/docs/manual/CoreTypes/filterreaderset.html new file mode 100644 index 000000000..dd43f40dc --- /dev/null +++ b/proposal/sandbox/filterreaders/docs/manual/CoreTypes/filterreaderset.html @@ -0,0 +1,231 @@ + + + + +FilterReaderSets are groups of FilterReaders. FilterReaderSets can appear
+inside tasks that support this feature.
FilterReaderSets are used for
+filtering file contents read in by tasks like LoadFile, etc.
+
+Each FilterReaderSet is composed of nested FilterReader elements.
+
+
| Attribute | +Description | +Required | +
| classname | +The class name of the filter reader. | +Yes | +
+The following FilterReaders are supplied with the default +distribution. + +
| Parameter Name | +Parameter Value | +Required | +
| linebreaks | +Characters that are to + be stripped out. Defaults to "\r\n" | +No | +
+
+<loadfile srcfile="${src.file}" property="${src.file.contents}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks"/>
+ </filterreaderset>
+</loadfile>
+
+<loadfile srcfile="${src.file}" property="${src.file.contents}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks">
+ <param name="linebreaks" value="()"/>
+ </filterreader>
+ </filterreaderset>
+</loadfile>
++
+<loadfile srcfile="${java.src.file}" property="${java.src.file.nocomments}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.StripJavaComments"/>
+ </filterreaderset>
+</loadfile>
+| Parameter Type | +Parameter Name | +Parameter Value | +Required | +
| tokenchar | +begintoken | +Character marking the + beginning of a token. Defaults to @ | +No | +
| tokenchar | +endtoken | +Character marking the + end of a token. Defaults to @ | +No | +
| token | +User defined String. | +User defined search String | +Yes | +
+ +
+<tstamp/>
+<loadfile srcfile="${src.file}" property="${src.file.replaced}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens">
+ <param type="token" name="DATE" value="${TODAY}"/>
+ <filterreader/>
+ </filterreaderset>
+</loadfile>
+| Parameter Name | +Parameter Value | +Required | +
| lines | +Number of lines to be read. + Defaults to "10" | +No | +
+
+<loadfile srcfile="${src.file}" property="${src.file.head}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.HeadFilter">
+ <param name="lines" value="15"/>
+ </filterreader>
+ </filterreaderset>
+</loadfile>
+| Parameter Name | +Parameter Value | +Required | +
| lines | +Number of lines to be read. + Defaults to "10" | +No | +
+
+<loadfile srcfile="${src.file}" property="${src.file.tail}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.TailFilter">
+ <param name="lines" value="15"/>
+ </filterreader>
+ </filterreaderset>
+</loadfile>
+
+<loadfile srcfile="${src.file}" property="${src.file.mid}">
+ <filterreaderset>
+ <filterreader classname="org.apache.tools.ant.filters.HeadFilter">
+ <param name="lines" value="15"/>
+ </filterreader>
+ <filterreader classname="org.apache.tools.ant.filters.TailFilter">
+ <param name="lines" value="5"/>
+ </filterreader>
+ </filterreaderset>
+</loadfile>
+Copyright © 2001 Apache Software Foundation. All rights +Reserved.