diff options
Diffstat (limited to 'framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html')
| -rw-r--r-- | framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html new file mode 100644 index 00000000..69fa23a6 --- /dev/null +++ b/framework/src/ant/apache-ant-1.9.6/manual/Tasks/loadproperties.html @@ -0,0 +1,140 @@ +<!-- + 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> +<link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> +<title>LoadProperties Task</title> +</head> + +<body> + + +<h2><a name="loadproperties">LoadProperties</a></h2> +<h3>Description</h3> +<p> +Load a file's contents as Apache Ant properties. This is equivalent +to <code><property file|resource="..."/></code> except that it +supports nested <code><filterchain></code> elements. +Also if the file is missing, the build is halted with an error, rather +than a warning being printed. +</p> + +<p><strong>Note:</strong> the default value of this +task's <code>prefixValues</code> attribute is different from the +default value of the same attribute in +the <a href="property.html"><code><property></code></a> +task.</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">srcFile</td> + <td valign="top">source file</td> + <td valign="top" rowspan="2" align="center">One of these or a + nested resource</td> + </tr> + <tr> + <td valign="top">resource</td> + <td valign="top">the resource name of the property file</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">classpath</td> + <td valign="top">the classpath to use when looking up a resource.</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">classpathref</td> + <td valign="top">the classpath to use when looking up a resource, + given as <a href="../using.html#references">reference</a> + to a <code><path></code> defined elsewhere..</td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">prefix</td> + <td valign="top">Prefix to apply to loaded properties; + a "." is appended to the prefix if not specified. <em>Since Ant 1.8.1</em></td> + <td align="center" valign="top">No</td> + </tr> + <tr> + <td valign="top">prefixValues</td> + <td valign="top">Whether to apply the prefix when expanding the + right hand side of the properties. + <em>Since Ant 1.8.2</em></td> + <td align="center" valign="top">No (default=<tt>true</tt>)</td> + </tr> +</table> + +<h3>Parameters specified as nested elements</h3> + +<h4>any <a href="../Types/resources.html">resource</a> or single element +resource collection</h4> + +<p>The specified resource will be used as src. <em>Since Ant 1.7</em></p> + +<h4><a href="../Types/filterchain.html">FilterChain</a></h4> + +<h4>classpath</h4> + +<p>for use with the <i>resource</i> attribute.</p> + +<h3>Examples</h3> +<pre> <loadproperties srcFile="file.properties"/> +</pre> +or +<pre> + <loadproperties> + <file file="file.properties"/> + </loadproperties> +</pre> +Load contents of file.properties as Ant properties. + +<pre> <loadproperties srcFile="file.properties"> + <filterchain> + <<a href="../Types/filterchain.html#linecontains">linecontains</a>> + <contains value="import."/> + </linecontains> + </filterchain> + </loadproperties> +</pre> +Read the lines that contain the string "import." +from the file "file.properties" and load them as +Ant properties. + +<pre> + <loadproperties> + <<a href="../Types/resources.html#gzipresource">gzipresource</a>> + <<a href="../Types/resources.html#url">url</a> url="http://example.org/url.properties.gz"/> + </gzipresource> + </loadproperties> +</pre> +Load contents of http://example.org/url.properties.gz, uncompress it +on the fly and load the contents as Ant properties. + + + +</body> +</html> |