1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<!DOCTYPE html>
<!--
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
https://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 lang="en">
<head>
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>XmlProperty Task</title>
</head>
<body>
<h2 id="xmlproperty">XmlProperty</h2>
<h3>Description</h3>
<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>
<pre>
<root>
<properties>
<foo>bar</foo>
</properties>
</root></pre>
<p>is roughly equivalent to this Java property file:</p>
<pre>root.properties.foo = bar</pre>
<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>
<h3 id="semanticAttributes">Semantic attributes</h3>
<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>
<ul>
<li>Property references are resolved.</li>
<li>The following attributes are treated differently:
<ul>
<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>
</ul>
</li>
<li><a href="../using.html#path">path-like structures</a> can be defined by use of the following
attributes:
<ul>
<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>
</ul>
</li>
</ul>
<p>For example, with semantic attribute processing enabled, this XML property file:</p>
<pre>
<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>
<pre>
<property name="root.properties.foo" location="bar"/>
<property name="root.properties.quux" value="${root.properties.foo}"/></pre>
<h3>Parameters</h3>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>file</td>
<td>The XML file to parse.</td>
<td>Yes, or a nested resource collection</td>
</tr>
<tr>
<td>prefix</td>
<td>The prefix to prepend to each property.</td>
<td>No</td>
</tr>
<tr>
<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>
</tr>
<tr>
<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>
</tr>
<tr>
<td>collapseAttributes</td>
<td>Treat attributes as nested elements.</td>
<td>No; default is <q>false</q></td>
</tr>
<tr>
<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>
</tr>
<tr>
<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>
</tr>
<tr>
<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>
</tr>
<tr>
<td>delimiter</td>
<td>Delimiter for splitting multiple values.<br/><em>since Apache Ant 1.7.1</em></td>
<td>No; defaults to <q>,</q> (comma)</td>
</tr>
</table>
<h3 id="nested">Parameters specified as nested elements</h3>
<h4>xmlcatalog</h4>
<p>The <a href="../Types/xmlcatalog.html"><code><xmlcatalog></code></a> element is used to
perform entity resolution.</p>
<h4>any <a href="../Types/resources.html">resource</a> or single element resource collection</h4>
<p>The specified resource will be used as input.</p>
<h3 id="examples">Examples</h3>
<h4>Non-semantic attributes</h4>
<p>Here is an example XML file that does not have any semantic attributes.</p>
<pre>
<root-tag myattr="true">
<inner-tag someattr="val">Text</inner-tag>
<a2><a3><a4>false</a4></a3></a2>
</root-tag></pre>
<h5>default loading</h5>
<p>This entry in a build file:</p>
<pre><xmlproperty file="somefile.xml"/></pre>
<p>is equivalent to the following properties:</p>
<pre>
root-tag(myattr)=true
root-tag.inner-tag=Text
root-tag.inner-tag(someattr)=val
root-tag.a2.a3.a4=false</pre>
<h5><var>collapseAttributes</var>=<q>false</q></h5>
<p>This entry in a build file:</p>
<pre><xmlproperty file="somefile.xml" collapseAttributes="true"/></pre>
<p>is equivalent to the following properties:</p>
<pre>
root-tag.myattr=true
root-tag.inner-tag=Text
root-tag.inner-tag.someatt=val
root-tag.a2.a3.a4=false</pre>
<h5><var>keepRoot</var>=<q>false</q></h5>
<p>This entry in a build file:</p>
<pre><xmlproperty file="somefile.xml" keepRoot="false"/></pre>
<p>is equivalent to the following properties:</p>
<pre>
inner-tag=Text
inner-tag(someattr)=val
a2.a3.a4=false</pre>
<h4>Semantic attributes</h4>
<p>Here is an example XML file that has semantic attributes.</p>
<pre>
<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>
<h5>default loading (<var>semanticAttributes</var>=<q>true</q>)</h5>
<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>
<pre>
<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"/>
<property name="run-time.jars" value="*.jar"/>
<path id="compile.classpath">
<pathelement location="${build.classes}"/>
</path>
<path id="run-time.classpath">
<path refid="compile.classpath"/>
<pathelement path="${run-time.jars}"/>
</path></pre>
<h5><var>includeSemanticAttribute</var>=<q>true</q></h5>
<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>
<pre>
<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"/>
<property name="run-time.jars" value="*.jar"/>
<path id="compile.classpath">
<pathelement location="${build.classes}"/>
</path>
<path id="run-time.classpath">
<path refid="compile.classpath"/>
<pathelement path="${run-time.jars}"/>
</path></pre>
</body>
</html>
|
