Load a text file into a single property. Unless an encoding is specified, - the encoding of the current locale is used. There is no explicit limit - upon the size of the file which can be loaded, but loading very large - files is not something anyone has yet explored. Because the file is - converted to text + the encoding of the current locale is used.
@@ -44,40 +41,21 @@-The makeOneLine parameter enables you to use a file as an -input to task parameters which expect single line input. It flattens -the file by removing all carriage return and line feed characters, -so that the file -
a -b -c -would become "abc": you need spaces or -commas at the end/start of line to stop alphanumeric characters -being merged together. +The LoadFile task supports nested +FilterChains.
<loadfile property="message" - srcFile="message.txt" / > + 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" / >
+ encoding="ISO-8859-1" />
Load a file using the latin-1 encoding
@@ -90,20 +68,22 @@ Load a file, don't fail if it is missing (a message is printed, though)
<loadfile
property="mail.recipients"
- srcFile="recipientlist.txt"
- makeOneLine="true" />
+ srcFile="recipientlist.txt">
+ <filterchain>
+ <striplinebreaks/>
+ </filterchaint>
+ </loadfile>
-
-load a property which can be used as a parameter for another task (in this case mail),
+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" />
+ srcFile="configuration.xml">
+ <expandproperties/>
+ </loadfile>
-
-load an XML file into a property, expanding all properties declared
+Load an XML file into a property, expanding all properties declared
in the file in the process.
diff --git a/docs/manual/CoreTasks/loadproperties.html b/docs/manual/CoreTasks/loadproperties.html
new file mode 100644
index 000000000..91d94ad26
--- /dev/null
+++ b/docs/manual/CoreTasks/loadproperties.html
@@ -0,0 +1,59 @@
+
+
++Load a file's contents as Ant properties. This is equivalent +to <property file="..."/> except that it +supports nested <filterchain> elements and it cannot be +specified outside a target. + +
+ +| Attribute | +Description | +Required | +
| srcFile | +source file | +Yes | +
+The LoadProperties task supports nested +FilterChains. + +
<loadproperties srcFile="file.properties" /> ++Load contents of file.properties as Ant properties. + +
<loadproperties srcFile="file.properties"> + <filterchain> + <linecontains> + <contains value="import."/> + <linecontains/> + </filterchaint> + </loadproperties> ++Read the lines that contain the string "import." +from the file "file.properties" and load them as +Ant properties. +
Copyright © 2002 Apache Software Foundation. All rights +Reserved.
+ + + + diff --git a/docs/manual/conceptstypeslist.html b/docs/manual/conceptstypeslist.html index 2e2997b38..a2cbc22b8 100644 --- a/docs/manual/conceptstypeslist.html +++ b/docs/manual/conceptstypeslist.html @@ -18,6 +18,7 @@ FileListn is negative.
+ * @exception IOException If an I/O error occurs
+ */
+ public final long skip(final long n) throws IOException {
+ if (n < 0L) {
+ throw new IllegalArgumentException("skip value is negative");
+ }
+
+ for (long i = 0; i < n; i++) {
+ if (read() == -1) {
+ return i;
+ }
+ }
+ return n;
+ }
+
+ /**
+ * Set the initialized status.
+ */
+ protected final void setInitialized(final boolean initialized) {
+ this.initialized = initialized;
+ }
+
+ /**
+ * Get the initialized status.
+ */
+ protected final boolean getInitialized() {
+ return initialized;
+ }
+
+ /**
+ * Set the project to work with
+ */
+ public final void setProject(final Project project) {
+ this.project = project;
+ }
+
+ /**
+ * Get the project
+ */
+ protected final Project getProject() {
+ return project;
+ }
+
+ /**
+ * Read till EOL
+ */
+ protected final String readLine() throws IOException {
+ int ch = in.read();
+ String line = (ch == -1) ? null : "";
+ while (ch != -1) {
+ line += (char) ch;
+ if (ch == '\n') {
+ break;
+ }
+ ch = in.read();
+ }
+ return line;
+ }
+
+ /**
+ * Read till EOF
+ */
+ protected final String readFully() throws IOException {
+ return FileUtils.readFully(in, 8192);
+ }
+}
diff --git a/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java b/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java
new file mode 100644
index 000000000..ff9109c48
--- /dev/null
+++ b/src/main/org/apache/tools/ant/filters/BaseParamFilterReader.java
@@ -0,0 +1,106 @@
+/*
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2002 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ * any, must include the following acknowlegement:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowlegement may appear in the software itself,
+ * if and wherever such third-party acknowlegements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Ant", and "Apache Software
+ * Foundation" must not be used to endorse or promote products derived
+ * from this software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ * nor may "Apache" appear in their names without prior written
+ * permission of the Apache Group.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * destFile file should be made equal
* to the last modified time of sourceFile.
*
- * @throws IOException
+ * @throws IOException
*/
public void copyFile(String sourceFile, String destFile, FilterSetCollection filters,
boolean overwrite, boolean preserveLastModified)
throws IOException {
- copyFile(new File(sourceFile), new File(destFile), filters,
+ copyFile(new File(sourceFile), new File(destFile), filters,
overwrite, preserveLastModified);
}
@@ -165,18 +169,40 @@ public class FileUtils {
* last modified time of destFile file should be made equal
* to the last modified time of sourceFile.
*
- * @throws IOException
+ * @throws IOException
*
* @since 1.14, Ant 1.5
*/
- public void copyFile(String sourceFile, String destFile,
- FilterSetCollection filters, boolean overwrite,
+ public void copyFile(String sourceFile, String destFile,
+ FilterSetCollection filters, boolean overwrite,
boolean preserveLastModified, String encoding)
throws IOException {
- copyFile(new File(sourceFile), new File(destFile), filters,
+ copyFile(new File(sourceFile), new File(destFile), filters,
overwrite, preserveLastModified, encoding);
}
+ /**
+ * Convienence method to copy a file from a source to a
+ * destination specifying if token filtering must be used, if
+ * filter chains must be used, if source files may overwrite
+ * newer destination files and the last modified time of
+ * destFile file should be made equal
+ * to the last modified time of sourceFile.
+ *
+ * @throws IOException
+ *
+ * @since 1.15, Ant 1.5
+ */
+ public void copyFile(String sourceFile, String destFile,
+ FilterSetCollection filters, Vector filterChains,
+ boolean overwrite, boolean preserveLastModified,
+ String encoding, Project project)
+ throws IOException {
+ copyFile(new File(sourceFile), new File(destFile), filters,
+ filterChains, overwrite, preserveLastModified,
+ encoding, project);
+ }
+
/**
* Convienence method to copy a file from a source to a destination.
* No filtering is performed.
@@ -203,7 +229,7 @@ public class FileUtils {
* destination specifying if token filtering must be used and if
* source files may overwrite newer destination files.
*
- * @throws IOException
+ * @throws IOException
*/
public void copyFile(File sourceFile, File destFile, FilterSetCollection filters,
boolean overwrite) throws IOException {
@@ -217,12 +243,12 @@ public class FileUtils {
* last modified time of destFile file should be made equal
* to the last modified time of sourceFile.
*
- * @throws IOException
+ * @throws IOException
*/
public void copyFile(File sourceFile, File destFile, FilterSetCollection filters,
boolean overwrite, boolean preserveLastModified)
throws IOException {
- copyFile(sourceFile, destFile, filters, overwrite,
+ copyFile(sourceFile, destFile, filters, overwrite,
preserveLastModified, null);
}
@@ -234,15 +260,36 @@ public class FileUtils {
* equal to the last modified time of sourceFile and
* which character encoding to assume.
*
- * @throws IOException
+ * @throws IOException
*
* @since 1.14, Ant 1.5
*/
- public void copyFile(File sourceFile, File destFile,
- FilterSetCollection filters, boolean overwrite,
+ public void copyFile(File sourceFile, File destFile,
+ FilterSetCollection filters, boolean overwrite,
boolean preserveLastModified, String encoding)
throws IOException {
-
+ copyFile(sourceFile, destFile, filters, null, overwrite,
+ preserveLastModified, encoding, null);
+ }
+
+ /**
+ * Convienence method to copy a file from a source to a
+ * destination specifying if token filtering must be used, if
+ * filter chains must be used, if source files may overwrite
+ * newer destination files and the last modified time of
+ * destFile file should be made equal
+ * to the last modified time of sourceFile.
+ *
+ * @throws IOException
+ *
+ * @since 1.15, Ant 1.5
+ */
+ public void copyFile(File sourceFile, File destFile,
+ FilterSetCollection filters, Vector filterChains,
+ boolean overwrite, boolean preserveLastModified,
+ String encoding, Project project)
+ throws IOException {
+
if (overwrite || !destFile.exists() ||
destFile.lastModified() < sourceFile.lastModified()) {
@@ -257,7 +304,12 @@ public class FileUtils {
parent.mkdirs();
}
- if (filters != null && filters.hasFilters()) {
+ final boolean filterSetsAvailable = (filters != null
+ && filters.hasFilters());
+ final boolean filterChainsAvailable = (filterChains != null
+ && filterChains.size() > 0);
+
+ if (filterSetsAvailable || filterChainsAvailable) {
BufferedReader in = null;
BufferedWriter out = null;
@@ -265,8 +317,20 @@ public class FileUtils {
in = new BufferedReader(new FileReader(sourceFile));
out = new BufferedWriter(new FileWriter(destFile));
} else {
- in = new BufferedReader(new InputStreamReader(new FileInputStream(sourceFile), encoding));
- out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(destFile), encoding));
+ in = new BufferedReader(new InputStreamReader(
+ new FileInputStream(sourceFile), encoding));
+ out = new BufferedWriter(new OutputStreamWriter(
+ new FileOutputStream(destFile), encoding));
+ }
+
+ if (filterChainsAvailable) {
+ ChainReaderHelper crh = new ChainReaderHelper();
+ crh.setBufferSize(8192);
+ crh.setPrimaryReader(in);
+ crh.setFilterChains(filterChains);
+ crh.setProject(project);
+ Reader rdr = crh.getAssembledReader();
+ in = new BufferedReader(rdr);
}
int length;
@@ -276,7 +340,11 @@ public class FileUtils {
if (line.length() == 0) {
out.newLine();
} else {
- newline = filters.replaceTokens(line);
+ if (filterSetsAvailable) {
+ newline = filters.replaceTokens(line);
+ } else {
+ newline = line;
+ }
out.write(newline);
out.newLine();
}
@@ -317,8 +385,8 @@ public class FileUtils {
synchronized (lockReflection) {
if (setLastModified == null) {
try {
- setLastModified =
- java.io.File.class.getMethod("setLastModified",
+ setLastModified =
+ java.io.File.class.getMethod("setLastModified",
new Class[] {Long.TYPE});
} catch (NoSuchMethodException nse) {
throw new BuildException("File.setlastModified not in JDK > 1.1?",
@@ -399,7 +467,7 @@ public class FileUtils {
helpFile = getParentFile(helpFile);
if (helpFile == null) {
String msg = "The file or path you specified ("
- + filename + ") is invalid relative to "
+ + filename + ") is invalid relative to "
+ file.getPath();
throw new BuildException(msg);
}
@@ -422,7 +490,7 @@ public class FileUtils {
*