Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/XmlProperty.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago
initial import of LiRK3
File size: 35.4 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:23 NZST 2007 -->
6	<TITLE>
7	XmlProperty (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.XmlProperty class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="XmlProperty (Apache Ant API)";
18	}
19	</SCRIPT>
20
21	</HEAD>
22
23	<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26	<!-- ========= START OF TOP NAVBAR ======= -->
27	<A NAME="navbar_top"><!-- --></A>
28	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30	<TR>
31	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32	<A NAME="navbar_top_firstrow"><!-- --></A>
33	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34	<TR ALIGN="center" VALIGN="top">
35	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
42	</TR>
43	</TABLE>
44	</TD>
45	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46	</EM>
47	</TD>
48	</TR>
49
50	<TR>
51	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52	<A HREF="../../../../../org/apache/tools/ant/taskdefs/WhichResource.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
53	<A HREF="../../../../../org/apache/tools/ant/taskdefs/XSLTProcess.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
54	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
56	<A HREF="XmlProperty.html" target="_top"><B>NO FRAMES</B></A>
57	<SCRIPT type="text/javascript">
58	<!--
59	if(window==top) {
60	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61	}
62	//-->
63	</SCRIPT>
64	<NOSCRIPT>
65	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66	</NOSCRIPT>
67
68	</FONT></TD>
69	</TR>
70	<TR>
71	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72	SUMMARY: NESTED \| <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
75	</TR>
76	</TABLE>
77	<A NAME="skip-navbar_top"></A>
78	<!-- ========= END OF TOP NAVBAR ========= -->
79
80	<HR>
81	<!-- ======== START OF CLASS DATA ======== -->
82	<H2>
83	<FONT SIZE="-1">
84	org.apache.tools.ant.taskdefs</FONT>
85	<BR>
86	Class XmlProperty</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.XmlProperty</B>
92	</PRE>
93	<HR>
94	<DL>
95	<DT>public class <B>XmlProperty</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97	<P>
98	Loads property values from a valid XML file, generating the
99	property names from the file's element and attribute names.
100
101	<p>Example:</p>
102	<pre>
103	<root-tag myattr="true">
104	<inner-tag someattr="val">Text</inner-tag>
105	<a2><a3><a4>false</a4></a3></a2>
106	<x>x1</x>
107	<x>x2</x>
108	</root-tag>
109	</pre>
110
111	<p>this generates the following properties:</p>
112
113	<pre>
114	root-tag(myattr)=true
115	root-tag.inner-tag=Text
116	root-tag.inner-tag(someattr)=val
117	root-tag.a2.a3.a4=false
118	root-tag.x=x1,x2
119	</pre>
120
121	<p>The <i>collapseAttributes</i> property of this task can be set
122	to true (the default is false) which will instead result in the
123	following properties (note the difference in names of properties
124	corresponding to XML attributes):</p>
125
126	<pre>
127	root-tag.myattr=true
128	root-tag.inner-tag=Text
129	root-tag.inner-tag.someattr=val
130	root-tag.a2.a3.a4=false
131	root-tag.x=x1,x2
132	</pre>
133
134	<p>Optionally, to more closely mirror the abilities of the Property
135	task, a selected set of attributes can be treated specially. To
136	enable this behavior, the "semanticAttributes" property of this task
137	must be set to true (it defaults to false). If this attribute is
138	specified, the following attributes take on special meaning
139	(setting this to true implicitly sets collapseAttributes to true as
140	well):</p>
141
142	<ul>
143	<li><b>value</b>: Identifies a text value for a property.</li>
144	<li><b>location</b>: Identifies a file location for a property.</li>
145	<li><b>id</b>: Sets an id for a property</li>
146	<li><b>refid</b>: Sets a property to the value of another property
147	based upon the provided id</li>
148	<li><b>pathid</b>: Defines a path rather than a property with
149	the given id.</li>
150	</ul>
151
152	<p>For example, with keepRoot = false, the following properties file:</p>
153
154	<pre>
155	<root-tag>
156	<build>
157	<build folder="build">
158	<classes id="build.classes" location="${build.folder}/classes"/>
159	<reference refid="build.classes"/>
160	</build>
161	<compile>
162	<classpath pathid="compile.classpath">
163	<pathelement location="${build.classes}"/>
164	</classpath>
165	</compile>
166	<run-time>
167	<jars>*.jar</jars>
168	<classpath pathid="run-time.classpath">
169	<path refid="compile.classpath"/>
170	<pathelement path="${run-time.jars}"/>
171	</classpath>
172	</run-time>
173	</root-tag>
174	</pre>
175
176	<p>is equivalent to the following entries in a build file:</p>
177
178	<pre>
179	<property name="build" location="build"/>
180	<property name="build.classes" location="${build.location}/classes"/>
181	<property name="build.reference" refid="build.classes"/>
182
183	<property name="run-time.jars" value="*.jar/>
184
185	<classpath id="compile.classpath">
186	<pathelement location="${build.classes}"/>
187	</classpath>
188
189	<classpath id="run-time.classpath">
190	<path refid="compile.classpath"/>
191	<pathelement path="${run-time.jars}"/>
192	</classpath>
193	</pre>
194
195	<p> This task <i>requires</i> the following attributes:</p>
196
197	<ul>
198	<li><b>file</b>: The name of the file to load.</li>
199	</ul>
200
201	<p>This task supports the following attributes:</p>
202
203	<ul>
204	<li><b>prefix</b>: Optionally specify a prefix applied to
205	all properties loaded. Defaults to an empty string.</li>
206	<li><b>keepRoot</b>: Indicate whether the root xml element
207	is kept as part of property name. Defaults to true.</li>
208	<li><b>validate</b>: Indicate whether the xml file is validated.
209	Defaults to false.</li>
210	<li><b>collapseAttributes</b>: Indicate whether attributes are
211	stored in property names with parens or with period
212	delimiters. Defaults to false, meaning properties
213	are stored with parens (i.e., foo(attr)).</li>
214	<li><b>semanticAttributes</b>: Indicate whether attributes
215	named "location", "value", "refid" and "path"
216	are interpreted as ant properties. Defaults
217	to false.</li>
218	<li><b>rootDirectory</b>: Indicate the directory to use
219	as the root directory for resolving location
220	properties. Defaults to the directory
221	of the project using the task.</li>
222	<li><b>includeSemanticAttribute</b>: Indicate whether to include
223	the semantic attribute ("location" or "value") as
224	part of the property name. Defaults to false.</li>
225	</ul>
226	<P>
227
228	<P>
229	<HR>
230
231	<P>
232	<!-- ======== NESTED CLASS SUMMARY ======== -->
233
234
235	<!-- =========== FIELD SUMMARY =========== -->
236
237	<A NAME="field_summary"><!-- --></A>
238	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
240	<TD COLSPAN=2><FONT SIZE="+2">
241	<B>Field Summary</B></FONT></TD>
242	</TR>
243	</TABLE>
244	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
245	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
246	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
247	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
248	</TR>
249	<TR BGCOLOR="white" CLASS="TableRowColor">
250	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
251	</TR>
252	</TABLE>
253	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
254	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
256	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
257	</TR>
258	<TR BGCOLOR="white" CLASS="TableRowColor">
259	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
260	</TR>
261	</TABLE>
262
263	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
264
265	<A NAME="constructor_summary"><!-- --></A>
266	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
268	<TD COLSPAN=2><FONT SIZE="+2">
269	<B>Constructor Summary</B></FONT></TD>
270	</TR>
271	<TR BGCOLOR="white" CLASS="TableRowColor">
272	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#XmlProperty()">XmlProperty</A></B>()</CODE>
273
274	<BR>
275	Constructor.</TD>
276	</TR>
277	</TABLE>
278
279	<!-- ========== METHOD SUMMARY =========== -->
280
281	<A NAME="method_summary"><!-- --></A>
282	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
283	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
284	<TD COLSPAN=2><FONT SIZE="+2">
285	<B>Method Summary</B></FONT></TD>
286	</TR>
287	<TR BGCOLOR="white" CLASS="TableRowColor">
288	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289	<CODE> void</CODE></FONT></TD>
290	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#addConfiguredXMLCatalog(org.apache.tools.ant.types.XMLCatalog)">addConfiguredXMLCatalog</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A> catalog)</CODE>
291
292	<BR>
293	add an XMLCatalog as a nested element; optional.</TD>
294	</TR>
295	<TR BGCOLOR="white" CLASS="TableRowColor">
296	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297	<CODE> void</CODE></FONT></TD>
298	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#execute()">execute</A></B>()</CODE>
299
300	<BR>
301	Run the task.</TD>
302	</TR>
303	<TR BGCOLOR="white" CLASS="TableRowColor">
304	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305	<CODE>protected  boolean</CODE></FONT></TD>
306	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getCollapseAttributes()">getCollapseAttributes</A></B>()</CODE>
307
308	<BR>
309	</TD>
310	</TR>
311	<TR BGCOLOR="white" CLASS="TableRowColor">
312	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313	<CODE>protected  org.xml.sax.EntityResolver</CODE></FONT></TD>
314	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getEntityResolver()">getEntityResolver</A></B>()</CODE>
315
316	<BR>
317	</TD>
318	</TR>
319	<TR BGCOLOR="white" CLASS="TableRowColor">
320	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321	<CODE>protected  java.io.File</CODE></FONT></TD>
322	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getFile()">getFile</A></B>()</CODE>
323
324	<BR>
325	</TD>
326	</TR>
327	<TR BGCOLOR="white" CLASS="TableRowColor">
328	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329	<CODE>protected  boolean</CODE></FONT></TD>
330	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getIncludeSementicAttribute()">getIncludeSementicAttribute</A></B>()</CODE>
331
332	<BR>
333	</TD>
334	</TR>
335	<TR BGCOLOR="white" CLASS="TableRowColor">
336	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337	<CODE>protected  boolean</CODE></FONT></TD>
338	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getKeeproot()">getKeeproot</A></B>()</CODE>
339
340	<BR>
341	</TD>
342	</TR>
343	<TR BGCOLOR="white" CLASS="TableRowColor">
344	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345	<CODE>protected  java.lang.String</CODE></FONT></TD>
346	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getPrefix()">getPrefix</A></B>()</CODE>
347
348	<BR>
349	</TD>
350	</TR>
351	<TR BGCOLOR="white" CLASS="TableRowColor">
352	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353	<CODE>protected  java.io.File</CODE></FONT></TD>
354	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getRootDirectory()">getRootDirectory</A></B>()</CODE>
355
356	<BR>
357	</TD>
358	</TR>
359	<TR BGCOLOR="white" CLASS="TableRowColor">
360	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361	<CODE>protected  boolean</CODE></FONT></TD>
362	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getSemanticAttributes()">getSemanticAttributes</A></B>()</CODE>
363
364	<BR>
365	</TD>
366	</TR>
367	<TR BGCOLOR="white" CLASS="TableRowColor">
368	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
369	<CODE>protected  boolean</CODE></FONT></TD>
370	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#getValidate()">getValidate</A></B>()</CODE>
371
372	<BR>
373	</TD>
374	</TR>
375	<TR BGCOLOR="white" CLASS="TableRowColor">
376	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
377	<CODE> void</CODE></FONT></TD>
378	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#init()">init</A></B>()</CODE>
379
380	<BR>
381	Initializes the task.</TD>
382	</TR>
383	<TR BGCOLOR="white" CLASS="TableRowColor">
384	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
385	<CODE> java.lang.Object</CODE></FONT></TD>
386	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#processNode(org.w3c.dom.Node, java.lang.String, java.lang.Object)">processNode</A></B>(org.w3c.dom.Node node,
387	java.lang.String prefix,
388	java.lang.Object container)</CODE>
389
390	<BR>
391	Process the given node, adding any required attributes from
392	this child node alone -- but <em>not</em> processing any
393	children.</TD>
394	</TR>
395	<TR BGCOLOR="white" CLASS="TableRowColor">
396	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
397	<CODE> void</CODE></FONT></TD>
398	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setCollapseAttributes(boolean)">setCollapseAttributes</A></B>(boolean collapseAttributes)</CODE>
399
400	<BR>
401	flag to treat attributes as nested elements;
402	optional, default false</TD>
403	</TR>
404	<TR BGCOLOR="white" CLASS="TableRowColor">
405	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
406	<CODE> void</CODE></FONT></TD>
407	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setFile(java.io.File)">setFile</A></B>(java.io.File src)</CODE>
408
409	<BR>
410	The XML file to parse; required.</TD>
411	</TR>
412	<TR BGCOLOR="white" CLASS="TableRowColor">
413	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
414	<CODE> void</CODE></FONT></TD>
415	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setIncludeSemanticAttribute(boolean)">setIncludeSemanticAttribute</A></B>(boolean includeSemanticAttribute)</CODE>
416
417	<BR>
418	Include the semantic attribute name as part of the property name.</TD>
419	</TR>
420	<TR BGCOLOR="white" CLASS="TableRowColor">
421	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
422	<CODE> void</CODE></FONT></TD>
423	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setKeeproot(boolean)">setKeeproot</A></B>(boolean keepRoot)</CODE>
424
425	<BR>
426	flag to include the xml root tag as a
427	first value in the property name; optional,
428	default is true</TD>
429	</TR>
430	<TR BGCOLOR="white" CLASS="TableRowColor">
431	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
432	<CODE> void</CODE></FONT></TD>
433	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setPrefix(java.lang.String)">setPrefix</A></B>(java.lang.String prefix)</CODE>
434
435	<BR>
436	the prefix to prepend to each property</TD>
437	</TR>
438	<TR BGCOLOR="white" CLASS="TableRowColor">
439	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
440	<CODE> void</CODE></FONT></TD>
441	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setRootDirectory(java.io.File)">setRootDirectory</A></B>(java.io.File rootDirectory)</CODE>
442
443	<BR>
444	The directory to use for resolving file references.</TD>
445	</TR>
446	<TR BGCOLOR="white" CLASS="TableRowColor">
447	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
448	<CODE> void</CODE></FONT></TD>
449	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setSemanticAttributes(boolean)">setSemanticAttributes</A></B>(boolean semanticAttributes)</CODE>
450
451	<BR>
452	Attribute to enable special handling of attributes - see ant manual.</TD>
453	</TR>
454	<TR BGCOLOR="white" CLASS="TableRowColor">
455	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
456	<CODE> void</CODE></FONT></TD>
457	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/XmlProperty.html#setValidate(boolean)">setValidate</A></B>(boolean validate)</CODE>
458
459	<BR>
460	flag to validate the XML file; optional, default false</TD>
461	</TR>
462	</TABLE>
463	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
464	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
465	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
466	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
467	</TR>
468	<TR BGCOLOR="white" CLASS="TableRowColor">
469	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
470	</TR>
471	</TABLE>
472	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
473	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
474	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
475	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
476	</TR>
477	<TR BGCOLOR="white" CLASS="TableRowColor">
478	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
479	</TR>
480	</TABLE>
481	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
482	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
483	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
484	<TD><B>Methods inherited from class java.lang.Object</B></TD>
485	</TR>
486	<TR BGCOLOR="white" CLASS="TableRowColor">
487	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
488	</TR>
489	</TABLE>
490
491	<P>
492
493	<!-- ============ FIELD DETAIL =========== -->
494
495
496	<!-- ========= CONSTRUCTOR DETAIL ======== -->
497
498	<A NAME="constructor_detail"><!-- --></A>
499	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
500	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
501	<TD COLSPAN=1><FONT SIZE="+2">
502	<B>Constructor Detail</B></FONT></TD>
503	</TR>
504	</TABLE>
505
506	<A NAME="XmlProperty()"><!-- --></A><H3>
507	XmlProperty</H3>
508	<PRE>
509	public <B>XmlProperty</B>()</PRE>
510	<DL>
511	<DD>Constructor.
512	<P>
513	</DL>
514
515	<!-- ============ METHOD DETAIL ========== -->
516
517	<A NAME="method_detail"><!-- --></A>
518	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
519	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
520	<TD COLSPAN=1><FONT SIZE="+2">
521	<B>Method Detail</B></FONT></TD>
522	</TR>
523	</TABLE>
524
525	<A NAME="init()"><!-- --></A><H3>
526	init</H3>
527	<PRE>
528	public void <B>init</B>()</PRE>
529	<DL>
530	<DD>Initializes the task.
531	<P>
532	<DD><DL>
533	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
534	</DD>
535	<DD><DL>
536	</DL>
537	</DD>
538	</DL>
539	<HR>
540
541	<A NAME="getEntityResolver()"><!-- --></A><H3>
542	getEntityResolver</H3>
543	<PRE>
544	protected org.xml.sax.EntityResolver <B>getEntityResolver</B>()</PRE>
545	<DL>
546	<DD><DL>
547
548	<DT><B>Returns:</B><DD>the xmlCatalog as the entityresolver.</DL>
549	</DD>
550	</DL>
551	<HR>
552
553	<A NAME="execute()"><!-- --></A><H3>
554	execute</H3>
555	<PRE>
556	public void <B>execute</B>()
557	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
558	<DL>
559	<DD>Run the task.
560	<P>
561	<DD><DL>
562	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
563	</DD>
564	<DD><DL>
565
566	<DT><B>Throws:</B>
567	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - The exception raised during task execution.<DT><B>To do:</B></DT>
568	<DD>validate the source file is valid before opening, print a better error message, add a verbose level log message listing the name of the file being loaded</DD>
569	</DL>
570	</DD>
571	</DL>
572	<HR>
573
574	<A NAME="processNode(org.w3c.dom.Node, java.lang.String, java.lang.Object)"><!-- --></A><H3>
575	processNode</H3>
576	<PRE>
577	public java.lang.Object <B>processNode</B>(org.w3c.dom.Node node,
578	java.lang.String prefix,
579	java.lang.Object container)</PRE>
580	<DL>
581	<DD>Process the given node, adding any required attributes from
582	this child node alone -- but <em>not</em> processing any
583	children.
584	<P>
585	<DD><DL>
586	<DT><B>Parameters:</B><DD><CODE>node</CODE> - the XML Node to parse<DD><CODE>prefix</CODE> - A string to prepend to any properties that get
587	added by this node.<DD><CODE>container</CODE> - Optionally, an object that a parent node
588	generated that this node might belong to. For example, this
589	node could be within a node that generated a Path.
590	<DT><B>Returns:</B><DD>the Object created by this node. Generally, this is
591	either a String if this node resulted in setting an attribute,
592	or a Path.</DL>
593	</DD>
594	</DL>
595	<HR>
596
597	<A NAME="setFile(java.io.File)"><!-- --></A><H3>
598	setFile</H3>
599	<PRE>
600	public void <B>setFile</B>(java.io.File src)</PRE>
601	<DL>
602	<DD>The XML file to parse; required.
603	<P>
604	<DD><DL>
605	<DT><B>Parameters:</B><DD><CODE>src</CODE> - the file to parse</DL>
606	</DD>
607	</DL>
608	<HR>
609
610	<A NAME="setPrefix(java.lang.String)"><!-- --></A><H3>
611	setPrefix</H3>
612	<PRE>
613	public void <B>setPrefix</B>(java.lang.String prefix)</PRE>
614	<DL>
615	<DD>the prefix to prepend to each property
616	<P>
617	<DD><DL>
618	<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix to prepend to each property</DL>
619	</DD>
620	</DL>
621	<HR>
622
623	<A NAME="setKeeproot(boolean)"><!-- --></A><H3>
624	setKeeproot</H3>
625	<PRE>
626	public void <B>setKeeproot</B>(boolean keepRoot)</PRE>
627	<DL>
628	<DD>flag to include the xml root tag as a
629	first value in the property name; optional,
630	default is true
631	<P>
632	<DD><DL>
633	<DT><B>Parameters:</B><DD><CODE>keepRoot</CODE> - if true (default), include the xml root tag</DL>
634	</DD>
635	</DL>
636	<HR>
637
638	<A NAME="setValidate(boolean)"><!-- --></A><H3>
639	setValidate</H3>
640	<PRE>
641	public void <B>setValidate</B>(boolean validate)</PRE>
642	<DL>
643	<DD>flag to validate the XML file; optional, default false
644	<P>
645	<DD><DL>
646	<DT><B>Parameters:</B><DD><CODE>validate</CODE> - if true validate the XML file, default false</DL>
647	</DD>
648	</DL>
649	<HR>
650
651	<A NAME="setCollapseAttributes(boolean)"><!-- --></A><H3>
652	setCollapseAttributes</H3>
653	<PRE>
654	public void <B>setCollapseAttributes</B>(boolean collapseAttributes)</PRE>
655	<DL>
656	<DD>flag to treat attributes as nested elements;
657	optional, default false
658	<P>
659	<DD><DL>
660	<DT><B>Parameters:</B><DD><CODE>collapseAttributes</CODE> - if true treat attributes as nested elements</DL>
661	</DD>
662	</DL>
663	<HR>
664
665	<A NAME="setSemanticAttributes(boolean)"><!-- --></A><H3>
666	setSemanticAttributes</H3>
667	<PRE>
668	public void <B>setSemanticAttributes</B>(boolean semanticAttributes)</PRE>
669	<DL>
670	<DD>Attribute to enable special handling of attributes - see ant manual.
671	<P>
672	<DD><DL>
673	<DT><B>Parameters:</B><DD><CODE>semanticAttributes</CODE> - if true enable the special handling.</DL>
674	</DD>
675	</DL>
676	<HR>
677
678	<A NAME="setRootDirectory(java.io.File)"><!-- --></A><H3>
679	setRootDirectory</H3>
680	<PRE>
681	public void <B>setRootDirectory</B>(java.io.File rootDirectory)</PRE>
682	<DL>
683	<DD>The directory to use for resolving file references.
684	Ignored if semanticAttributes is not set to true.
685	<P>
686	<DD><DL>
687	<DT><B>Parameters:</B><DD><CODE>rootDirectory</CODE> - the directory.</DL>
688	</DD>
689	</DL>
690	<HR>
691
692	<A NAME="setIncludeSemanticAttribute(boolean)"><!-- --></A><H3>
693	setIncludeSemanticAttribute</H3>
694	<PRE>
695	public void <B>setIncludeSemanticAttribute</B>(boolean includeSemanticAttribute)</PRE>
696	<DL>
697	<DD>Include the semantic attribute name as part of the property name.
698	Ignored if semanticAttributes is not set to true.
699	<P>
700	<DD><DL>
701	<DT><B>Parameters:</B><DD><CODE>includeSemanticAttribute</CODE> - if true include the sematic attribute
702	name.</DL>
703	</DD>
704	</DL>
705	<HR>
706
707	<A NAME="addConfiguredXMLCatalog(org.apache.tools.ant.types.XMLCatalog)"><!-- --></A><H3>
708	addConfiguredXMLCatalog</H3>
709	<PRE>
710	public void <B>addConfiguredXMLCatalog</B>(<A HREF="../../../../../org/apache/tools/ant/types/XMLCatalog.html" title="class in org.apache.tools.ant.types">XMLCatalog</A> catalog)</PRE>
711	<DL>
712	<DD>add an XMLCatalog as a nested element; optional.
713	<P>
714	<DD><DL>
715	<DT><B>Parameters:</B><DD><CODE>catalog</CODE> - the XMLCatalog to use</DL>
716	</DD>
717	</DL>
718	<HR>
719
720	<A NAME="getFile()"><!-- --></A><H3>
721	getFile</H3>
722	<PRE>
723	protected java.io.File <B>getFile</B>()</PRE>
724	<DL>
725	<DD><DL>
726
727	<DT><B>Returns:</B><DD>the file attribute.</DL>
728	</DD>
729	</DL>
730	<HR>
731
732	<A NAME="getPrefix()"><!-- --></A><H3>
733	getPrefix</H3>
734	<PRE>
735	protected java.lang.String <B>getPrefix</B>()</PRE>
736	<DL>
737	<DD><DL>
738
739	<DT><B>Returns:</B><DD>the prefix attribute.</DL>
740	</DD>
741	</DL>
742	<HR>
743
744	<A NAME="getKeeproot()"><!-- --></A><H3>
745	getKeeproot</H3>
746	<PRE>
747	protected boolean <B>getKeeproot</B>()</PRE>
748	<DL>
749	<DD><DL>
750
751	<DT><B>Returns:</B><DD>the keeproot attribute.</DL>
752	</DD>
753	</DL>
754	<HR>
755
756	<A NAME="getValidate()"><!-- --></A><H3>
757	getValidate</H3>
758	<PRE>
759	protected boolean <B>getValidate</B>()</PRE>
760	<DL>
761	<DD><DL>
762
763	<DT><B>Returns:</B><DD>the validate attribute.</DL>
764	</DD>
765	</DL>
766	<HR>
767
768	<A NAME="getCollapseAttributes()"><!-- --></A><H3>
769	getCollapseAttributes</H3>
770	<PRE>
771	protected boolean <B>getCollapseAttributes</B>()</PRE>
772	<DL>
773	<DD><DL>
774
775	<DT><B>Returns:</B><DD>the collapse attributes attribute.</DL>
776	</DD>
777	</DL>
778	<HR>
779
780	<A NAME="getSemanticAttributes()"><!-- --></A><H3>
781	getSemanticAttributes</H3>
782	<PRE>
783	protected boolean <B>getSemanticAttributes</B>()</PRE>
784	<DL>
785	<DD><DL>
786
787	<DT><B>Returns:</B><DD>the semantic attributes attribute.</DL>
788	</DD>
789	</DL>
790	<HR>
791
792	<A NAME="getRootDirectory()"><!-- --></A><H3>
793	getRootDirectory</H3>
794	<PRE>
795	protected java.io.File <B>getRootDirectory</B>()</PRE>
796	<DL>
797	<DD><DL>
798
799	<DT><B>Returns:</B><DD>the root directory attribute.</DL>
800	</DD>
801	</DL>
802	<HR>
803
804	<A NAME="getIncludeSementicAttribute()"><!-- --></A><H3>
805	getIncludeSementicAttribute</H3>
806	<PRE>
807	protected boolean <B>getIncludeSementicAttribute</B>()</PRE>
808	<DL>
809	<DD><DL>
810
811	<DT><B>Returns:</B><DD>the include semantic attribute.</DL>
812	</DD>
813	</DL>
814	<!-- ========= END OF CLASS DATA ========= -->
815	<HR>
816
817
818	<!-- ======= START OF BOTTOM NAVBAR ====== -->
819	<A NAME="navbar_bottom"><!-- --></A>
820	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
821	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
822	<TR>
823	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
824	<A NAME="navbar_bottom_firstrow"><!-- --></A>
825	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
826	<TR ALIGN="center" VALIGN="top">
827	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
828	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
829	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
830	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
831	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
832	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
833	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
834	</TR>
835	</TABLE>
836	</TD>
837	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
838	</EM>
839	</TD>
840	</TR>
841
842	<TR>
843	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
844	<A HREF="../../../../../org/apache/tools/ant/taskdefs/WhichResource.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
845	<A HREF="../../../../../org/apache/tools/ant/taskdefs/XSLTProcess.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
846	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
847	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
848	<A HREF="XmlProperty.html" target="_top"><B>NO FRAMES</B></A>
849	<SCRIPT type="text/javascript">
850	<!--
851	if(window==top) {
852	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
853	}
854	//-->
855	</SCRIPT>
856	<NOSCRIPT>
857	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
858	</NOSCRIPT>
859
860	</FONT></TD>
861	</TR>
862	<TR>
863	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
864	SUMMARY: NESTED \| <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
865	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
866	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
867	</TR>
868	</TABLE>
869	<A NAME="skip-navbar_bottom"></A>
870	<!-- ======== END OF BOTTOM NAVBAR ======= -->
871
872	<HR>
873	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
874	</BODY>
875	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: