2018-12-21 11:20:43 +01:00
|
|
|
<!DOCTYPE html>
|
2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
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
|
|
|
|
|
|
2019-05-25 13:41:47 +02:00
|
|
|
https://www.apache.org/licenses/LICENSE-2.0
|
2006-09-11 04:19:00 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
-->
|
2018-12-21 11:20:43 +01:00
|
|
|
<html lang="en">
|
2002-04-22 00:05:09 +00:00
|
|
|
<head>
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-04-22 00:05:09 +00:00
|
|
|
<title>XmlProperty Task</title>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="xmlproperty">XmlProperty</h2>
|
2002-04-22 00:05:09 +00:00
|
|
|
<h3>Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Loads property values from a well-formed xml file. There are no other restrictions than
|
|
|
|
|
"well-formed". You can choose the layout you want. For example this XML property file:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
|
|
|
|
<root>
|
|
|
|
|
<properties>
|
|
|
|
|
<foo>bar</foo>
|
|
|
|
|
</properties>
|
2018-02-28 07:58:59 +01:00
|
|
|
</root></pre>
|
|
|
|
|
<p>is roughly equivalent to this Java property file:</p>
|
|
|
|
|
<pre>root.properties.foo = bar</pre>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>By default, this load does <em>no</em> processing of the input. In particular, unlike
|
|
|
|
|
the <a href="property.html">Property task</a>, property references (i.e., <samp>${foo}</samp>) are
|
|
|
|
|
not resolved.</p>
|
2018-03-05 21:01:42 +01:00
|
|
|
<h3 id="semanticAttributes">Semantic attributes</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Input processing can be enabled by using the <var>semanticAttributes</var> attribute. If this
|
|
|
|
|
attribute is set to <q>true</q> (its default is <q>false</q>), the following processing occurs as
|
|
|
|
|
the input XML file is loaded:/p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<ul>
|
|
|
|
|
<li>Property references are resolved.</li>
|
2007-01-22 16:34:45 +00:00
|
|
|
<li>The following attributes are treated differently:
|
2002-11-06 08:43:46 +00:00
|
|
|
<ul>
|
2018-02-28 07:58:59 +01:00
|
|
|
<li><var>id</var>: The property is associated with the given id value.</li>
|
|
|
|
|
<li><var>location</var>: The property is treated as a file location</li>
|
|
|
|
|
<li><var>refid</var>: The property is set to the value of the referenced property.</li>
|
|
|
|
|
<li><var>value</var>: The property is set to the value indicated.</li>
|
2002-11-06 08:43:46 +00:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
2018-02-28 07:58:59 +01:00
|
|
|
<li><a href="../using.html#path">path-like structures</a> can be defined by use of the following
|
|
|
|
|
attributes:
|
2002-11-06 08:43:46 +00:00
|
|
|
<ul>
|
2018-02-28 07:58:59 +01:00
|
|
|
<li><var>pathid</var>: The given <var>id</var> is used to identify a path. The nested XML tag
|
|
|
|
|
name is ignored. Child elements can be used (XML tag names are ignored) to identify
|
|
|
|
|
elements of the path.</li>
|
2002-11-06 08:43:46 +00:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>For example, with semantic attribute processing enabled, this XML property file:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<root>
|
|
|
|
|
<properties>
|
|
|
|
|
<foo location="bar"/>
|
|
|
|
|
<quux>${root.properties.foo}</quux>
|
|
|
|
|
</properties>
|
|
|
|
|
</root></pre>
|
|
|
|
|
<p>is roughly equivalent to the following fragments in a <samp>build.xml</samp> file:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<property name="root.properties.foo" location="bar"/>
|
|
|
|
|
<property name="root.properties.quux" value="${root.properties.foo}"/></pre>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2002-04-22 00:05:09 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2002-04-22 00:05:09 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
|
<th scope="col">Required</th>
|
2002-04-22 00:05:09 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>file</td>
|
|
|
|
|
<td>The XML file to parse.</td>
|
|
|
|
|
<td>Yes, or a nested resource collection</td>
|
2002-04-22 00:05:09 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>prefix</td>
|
|
|
|
|
<td>The prefix to prepend to each property.</td>
|
|
|
|
|
<td>No</td>
|
2002-04-22 00:05:09 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>keepRoot</td>
|
|
|
|
|
<td>Keep the XML root tag as the first value in the property name.</td>
|
|
|
|
|
<td>No; default is <q>true</q></td>
|
2003-11-25 11:29:13 +00:00
|
|
|
</tr>
|
2002-04-22 00:05:09 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>validate</td>
|
|
|
|
|
<td>Validate the input file (e.g. by a DTD). Otherwise the XML must only be well-formed.</td>
|
|
|
|
|
<td>No; default is <q>false</q></td>
|
2002-04-22 00:05:09 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>collapseAttributes</td>
|
|
|
|
|
<td>Treat attributes as nested elements.</td>
|
|
|
|
|
<td>No; default is <q>false</q></td>
|
2002-11-06 08:43:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>semanticAttributes</td>
|
|
|
|
|
<td>Enable special handling of certain attribute names. See
|
|
|
|
|
the <a href="#semanticAttributes">Semantic Attributes</a> section for more information.</td>
|
|
|
|
|
<td>No; default is <q>false</q></td>
|
2003-11-25 11:29:13 +00:00
|
|
|
</tr>
|
2002-11-06 08:43:46 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>includeSemanticAttribute</td>
|
|
|
|
|
<td>Include the semantic attribute name as part of the property name. Ignored
|
|
|
|
|
if <var>semanticAttributes</var> is not set to <q>true</q>. See
|
|
|
|
|
the <a href="#semanticAttributes">Semantic Attributes</a> section for more information.</td>
|
|
|
|
|
<td>No; default is <q>false</q></td>
|
2002-11-06 08:43:46 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>rootDirectory</td>
|
|
|
|
|
<td>The directory to use for resolving file references. Ignored if <var>semanticAttributes</var>
|
|
|
|
|
is not set to <q>true</q>.</td>
|
|
|
|
|
<td>No; default is <var>basedir</var></td>
|
2002-11-06 08:43:46 +00:00
|
|
|
</tr>
|
2007-10-24 11:26:02 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>delimiter</td>
|
2018-03-02 08:23:45 +01:00
|
|
|
<td>Delimiter for splitting multiple values.<br/><em>since Apache Ant 1.7.1</em></td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No; defaults to <q>,</q> (comma)</td>
|
2007-10-24 11:26:02 +00:00
|
|
|
</tr>
|
2002-04-22 00:05:09 +00:00
|
|
|
</table>
|
|
|
|
|
|
2018-03-05 17:35:30 +01:00
|
|
|
<h3 id="nested">Parameters specified as nested elements</h3>
|
2004-09-10 08:50:25 +00:00
|
|
|
<h4>xmlcatalog</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The <a href="../Types/xmlcatalog.html"><code><xmlcatalog></code></a> element is used to
|
|
|
|
|
perform entity resolution.</p>
|
2004-09-10 08:50:25 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<h4>any <a href="../Types/resources.html">resource</a> or single element resource collection</h4>
|
2005-11-15 08:30:40 +00:00
|
|
|
|
|
|
|
|
<p>The specified resource will be used as input.</p>
|
|
|
|
|
|
2018-01-22 23:52:21 +01:00
|
|
|
<h3 id="examples">Examples</h3>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h4>Non-semantic attributes</h4>
|
2002-04-22 00:05:09 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<p>Here is an example XML file that does not have any semantic attributes.</p>
|
2002-04-22 00:05:09 +00:00
|
|
|
|
2003-11-25 11:29:13 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<root-tag myattr="true">
|
|
|
|
|
<inner-tag someattr="val">Text</inner-tag>
|
|
|
|
|
<a2><a3><a4>false</a4></a3></a2>
|
|
|
|
|
</root-tag></pre>
|
2002-04-22 00:05:09 +00:00
|
|
|
|
2002-11-06 08:43:46 +00:00
|
|
|
<h5>default loading</h5>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>This entry in a build file:</p>
|
|
|
|
|
<pre><xmlproperty file="somefile.xml"/></pre>
|
|
|
|
|
<p>is equivalent to the following properties:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
root-tag(myattr)=true
|
|
|
|
|
root-tag.inner-tag=Text
|
|
|
|
|
root-tag.inner-tag(someattr)=val
|
|
|
|
|
root-tag.a2.a3.a4=false</pre>
|
2002-04-22 00:05:09 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h5><var>collapseAttributes</var>=<q>false</q></h5>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>This entry in a build file:</p>
|
|
|
|
|
<pre><xmlproperty file="somefile.xml" collapseAttributes="true"/></pre>
|
|
|
|
|
<p>is equivalent to the following properties:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
root-tag.myattr=true
|
|
|
|
|
root-tag.inner-tag=Text
|
|
|
|
|
root-tag.inner-tag.someatt=val
|
|
|
|
|
root-tag.a2.a3.a4=false</pre>
|
2002-04-22 00:05:09 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h5><var>keepRoot</var>=<q>false</q></h5>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>This entry in a build file:</p>
|
|
|
|
|
<pre><xmlproperty file="somefile.xml" keepRoot="false"/></pre>
|
|
|
|
|
<p>is equivalent to the following properties:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
inner-tag=Text
|
|
|
|
|
inner-tag(someattr)=val
|
|
|
|
|
a2.a3.a4=false</pre>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h4>Semantic attributes</h4>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<p>Here is an example XML file that has semantic attributes.</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<root-tag>
|
|
|
|
|
<version value="0.0.1"/>
|
|
|
|
|
<build folder="build">
|
|
|
|
|
<classes id="build.classes" location="${build.folder}/classes"/>
|
|
|
|
|
<reference refid="build.classes"/>
|
|
|
|
|
</build>
|
|
|
|
|
<compile>
|
|
|
|
|
<classpath pathid="compile.classpath">
|
|
|
|
|
<pathelement location="${build.classes}"/>
|
|
|
|
|
</classpath>
|
|
|
|
|
</compile>
|
|
|
|
|
<run-time>
|
|
|
|
|
<jars>*.jar</jars>
|
|
|
|
|
<classpath pathid="run-time.classpath">
|
|
|
|
|
<path refid="compile.classpath"/>
|
|
|
|
|
<pathelement path="${run-time.jars}"/>
|
|
|
|
|
</classpath>
|
|
|
|
|
</run-time>
|
|
|
|
|
</root-tag></pre>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h5>default loading (<var>semanticAttributes</var>=<q>true</q>)</h5>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>This entry in a build file:</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<xmlproperty file="somefile.xml" keepRoot="false"
|
|
|
|
|
semanticAttributes="true"/></pre>
|
|
|
|
|
<p>is equivalent to the following entries in a build file:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<property name="version" value="0.0.1"/>
|
|
|
|
|
<property name="build.folder" value="build"/>
|
|
|
|
|
<property name="build.classes" location="${build.folder}/classes" id="build.classes"/>
|
|
|
|
|
<property name="build.reference" refid="build.classes"/>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<property name="run-time.jars" value="*.jar"/>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<path id="compile.classpath">
|
|
|
|
|
<pathelement location="${build.classes}"/>
|
|
|
|
|
</path>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<path id="run-time.classpath">
|
|
|
|
|
<path refid="compile.classpath"/>
|
|
|
|
|
<pathelement path="${run-time.jars}"/>
|
|
|
|
|
</path></pre>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-03-05 21:01:42 +01:00
|
|
|
<h5><var>includeSemanticAttribute</var>=<q>true</q></h5>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>This entry in a build file:</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<xmlproperty file="somefile.xml"
|
|
|
|
|
semanticAttributes="true" keepRoot="false"
|
|
|
|
|
includeSemanticAttribute="true"/></pre>
|
|
|
|
|
<p>is equivalent to the following entries in a build file:</p>
|
2002-11-06 08:43:46 +00:00
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<property name="version.value" value="0.0.1"/>
|
|
|
|
|
<property name="build.folder" value="build"/>
|
|
|
|
|
<property name="build.classes.location" location="${build.folder}/classes"/>
|
|
|
|
|
<property name="build.reference.refid" refid="build.classes"/>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<property name="run-time.jars" value="*.jar"/>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<path id="compile.classpath">
|
|
|
|
|
<pathelement location="${build.classes}"/>
|
|
|
|
|
</path>
|
2002-11-06 08:43:46 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<path id="run-time.classpath">
|
|
|
|
|
<path refid="compile.classpath"/>
|
|
|
|
|
<pathelement path="${run-time.jars}"/>
|
|
|
|
|
</path></pre>
|
2002-04-22 00:05:09 +00:00
|
|
|
|
|
|
|
|
</body>
|
2004-09-10 08:50:25 +00:00
|
|
|
</html>
|
