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

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 28.2 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:21 NZST 2007 -->
6<TITLE>
7PathConvert (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.PathConvert class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="PathConvert (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>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Patch.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.MapEntry.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> &nbsp;
56&nbsp;<A HREF="PathConvert.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<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:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
84org.apache.tools.ant.taskdefs</FONT>
85<BR>
86Class PathConvert</H2>
87<PRE>
88java.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.PathConvert</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>PathConvert</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Converts path and classpath information to a specific target OS
99 format. The resulting formatted path is placed into the specified property.
100<P>
101
102<P>
103<DL>
104<DT><B>Since:</B></DT>
105 <DD>Ant 1.4</DD>
106</DL>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112<A NAME="nested_class_summary"><!-- --></A>
113<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
114<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115<TD COLSPAN=2><FONT SIZE="+2">
116<B>Nested Class Summary</B></FONT></TD>
117</TR>
118<TR BGCOLOR="white" CLASS="TableRowColor">
119<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
120<CODE>&nbsp;class</CODE></FONT></TD>
121<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.MapEntry</A></B></CODE>
122
123<BR>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Helper class, holds the nested &lt;map&gt; values.</TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>static&nbsp;class</CODE></FONT></TD>
129<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.TargetOs</A></B></CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An enumeration of supported targets:
133 "windows", "unix", "netware", and "os/2".</TD>
134</TR>
135</TABLE>
136&nbsp;
137<!-- =========== FIELD SUMMARY =========== -->
138
139<A NAME="field_summary"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
142<TD COLSPAN=2><FONT SIZE="+2">
143<B>Field Summary</B></FONT></TD>
144</TR>
145</TABLE>
146&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
149<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>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<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>
153</TR>
154</TABLE>
155&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
158<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>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ======== CONSTRUCTOR SUMMARY ======== -->
166
167<A NAME="constructor_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TD COLSPAN=2><FONT SIZE="+2">
171<B>Constructor Summary</B></FONT></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#PathConvert()">PathConvert</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new instance of the PathConvert task.</TD>
178</TR>
179</TABLE>
180&nbsp;
181<!-- ========== METHOD SUMMARY =========== -->
182
183<A NAME="method_summary"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TD COLSPAN=2><FONT SIZE="+2">
187<B>Method Summary</B></FONT></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;void</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#add(org.apache.tools.ant.util.FileNameMapper)">add</A></B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a nested filenamemapper.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#addMapper(org.apache.tools.ant.types.Mapper)">addMapper</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>&nbsp;mapper)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a mapper to convert the file names.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.MapEntry</A></CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#createMap()">createMap</A></B>()</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a nested MAP element.</TD>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#createPath()">createPath</A></B>()</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a nested PATH element.</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;void</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#execute()">execute</A></B>()</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do the execution.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;boolean</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#isReference()">isReference</A></B>()</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Learn whether the refid attribute of this element been set.</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<CODE>&nbsp;void</CODE></FONT></TD>
240<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setDirSep(java.lang.String)">setDirSep</A></B>(java.lang.String&nbsp;sep)</CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the default directory separator string;
244 defaults to current JVM <CODE>File.separator</CODE>.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setPathSep(java.lang.String)">setPathSep</A></B>(java.lang.String&nbsp;sep)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the default path separator string; defaults to current JVM
253 <CODE>File.pathSeparator</CODE>.</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>&nbsp;void</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setProperty(java.lang.String)">setProperty</A></B>(java.lang.String&nbsp;p)</CODE>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the property into which the converted path will be placed.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;void</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;void</CODE></FONT></TD>
274<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setSetonempty(boolean)">setSetonempty</A></B>(boolean&nbsp;setonempty)</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether the specified property will be set if the result
278 is the empty string.</TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282<CODE>&nbsp;void</CODE></FONT></TD>
283<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setTargetos(org.apache.tools.ant.taskdefs.PathConvert.TargetOs)">setTargetos</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.TargetOs</A>&nbsp;target)</CODE>
284
285<BR>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set targetos to a platform to one of
287 "windows", "unix", "netware", or "os/2";
288 current platform settings are used by default.</TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292<CODE>&nbsp;void</CODE></FONT></TD>
293<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setTargetos(java.lang.String)">setTargetos</A></B>(java.lang.String&nbsp;target)</CODE>
294
295<BR>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use the method taking a TargetOs argument instead.</I></TD>
297</TR>
298</TABLE>
299&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
300<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
302<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>
303</TR>
304<TR BGCOLOR="white" CLASS="TableRowColor">
305<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#init()">init</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>
306</TR>
307</TABLE>
308&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
311<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>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<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>
315</TR>
316</TABLE>
317&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
318<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
319<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
320<TD><B>Methods inherited from class java.lang.Object</B></TD>
321</TR>
322<TR BGCOLOR="white" CLASS="TableRowColor">
323<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
324</TR>
325</TABLE>
326&nbsp;
327<P>
328
329<!-- ============ FIELD DETAIL =========== -->
330
331
332<!-- ========= CONSTRUCTOR DETAIL ======== -->
333
334<A NAME="constructor_detail"><!-- --></A>
335<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
336<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
337<TD COLSPAN=1><FONT SIZE="+2">
338<B>Constructor Detail</B></FONT></TD>
339</TR>
340</TABLE>
341
342<A NAME="PathConvert()"><!-- --></A><H3>
343PathConvert</H3>
344<PRE>
345public <B>PathConvert</B>()</PRE>
346<DL>
347<DD>Construct a new instance of the PathConvert task.
348<P>
349</DL>
350
351<!-- ============ METHOD DETAIL ========== -->
352
353<A NAME="method_detail"><!-- --></A>
354<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
355<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
356<TD COLSPAN=1><FONT SIZE="+2">
357<B>Method Detail</B></FONT></TD>
358</TR>
359</TABLE>
360
361<A NAME="createPath()"><!-- --></A><H3>
362createPath</H3>
363<PRE>
364public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createPath</B>()</PRE>
365<DL>
366<DD>Create a nested PATH element.
367<P>
368<DD><DL>
369
370<DT><B>Returns:</B><DD>a Path to be used by Ant reflection.</DL>
371</DD>
372</DL>
373<HR>
374
375<A NAME="createMap()"><!-- --></A><H3>
376createMap</H3>
377<PRE>
378public <A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.MapEntry</A> <B>createMap</B>()</PRE>
379<DL>
380<DD>Create a nested MAP element.
381<P>
382<DD><DL>
383
384<DT><B>Returns:</B><DD>a Map to configure.</DL>
385</DD>
386</DL>
387<HR>
388
389<A NAME="setTargetos(java.lang.String)"><!-- --></A><H3>
390setTargetos</H3>
391<PRE>
392public void <B>setTargetos</B>(java.lang.String&nbsp;target)</PRE>
393<DL>
394<DD><B>Deprecated.</B>&nbsp;<I>use the method taking a TargetOs argument instead.</I>
395<P>
396<DD>Set targetos to a platform to one of
397 "windows", "unix", "netware", or "os/2";
398 current platform settings are used by default.
399<P>
400<DD><DL>
401<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.html#setTargetos(org.apache.tools.ant.taskdefs.PathConvert.TargetOs)"><CODE>setTargetos(PathConvert.TargetOs)</CODE></A></DL>
402</DD>
403</DL>
404<HR>
405
406<A NAME="setTargetos(org.apache.tools.ant.taskdefs.PathConvert.TargetOs)"><!-- --></A><H3>
407setTargetos</H3>
408<PRE>
409public void <B>setTargetos</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html" title="class in org.apache.tools.ant.taskdefs">PathConvert.TargetOs</A>&nbsp;target)</PRE>
410<DL>
411<DD>Set targetos to a platform to one of
412 "windows", "unix", "netware", or "os/2";
413 current platform settings are used by default.
414<P>
415<DD><DL>
416<DT><B>Parameters:</B><DD><CODE>target</CODE> - the target os<DT><B>Since:</B></DT>
417 <DD>Ant 1.5</DD>
418</DL>
419</DD>
420</DL>
421<HR>
422
423<A NAME="setSetonempty(boolean)"><!-- --></A><H3>
424setSetonempty</H3>
425<PRE>
426public void <B>setSetonempty</B>(boolean&nbsp;setonempty)</PRE>
427<DL>
428<DD>Set whether the specified property will be set if the result
429 is the empty string.
430<P>
431<DD><DL>
432<DT><B>Parameters:</B><DD><CODE>setonempty</CODE> - true or false.<DT><B>Since:</B></DT>
433 <DD>Ant 1.5</DD>
434</DL>
435</DD>
436</DL>
437<HR>
438
439<A NAME="setProperty(java.lang.String)"><!-- --></A><H3>
440setProperty</H3>
441<PRE>
442public void <B>setProperty</B>(java.lang.String&nbsp;p)</PRE>
443<DL>
444<DD>Set the name of the property into which the converted path will be placed.
445<P>
446<DD><DL>
447<DT><B>Parameters:</B><DD><CODE>p</CODE> - the property name.</DL>
448</DD>
449</DL>
450<HR>
451
452<A NAME="setRefid(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
453setRefid</H3>
454<PRE>
455public void <B>setRefid</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
456<DL>
457<DD>Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
458<P>
459<DD><DL>
460<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference to a path, fileset, dirset or filelist.</DL>
461</DD>
462</DL>
463<HR>
464
465<A NAME="setPathSep(java.lang.String)"><!-- --></A><H3>
466setPathSep</H3>
467<PRE>
468public void <B>setPathSep</B>(java.lang.String&nbsp;sep)</PRE>
469<DL>
470<DD>Set the default path separator string; defaults to current JVM
471 <CODE>File.pathSeparator</CODE>.
472<P>
473<DD><DL>
474<DT><B>Parameters:</B><DD><CODE>sep</CODE> - path separator string.</DL>
475</DD>
476</DL>
477<HR>
478
479<A NAME="setDirSep(java.lang.String)"><!-- --></A><H3>
480setDirSep</H3>
481<PRE>
482public void <B>setDirSep</B>(java.lang.String&nbsp;sep)</PRE>
483<DL>
484<DD>Set the default directory separator string;
485 defaults to current JVM <CODE>File.separator</CODE>.
486<P>
487<DD><DL>
488<DT><B>Parameters:</B><DD><CODE>sep</CODE> - directory separator string.</DL>
489</DD>
490</DL>
491<HR>
492
493<A NAME="isReference()"><!-- --></A><H3>
494isReference</H3>
495<PRE>
496public boolean <B>isReference</B>()</PRE>
497<DL>
498<DD>Learn whether the refid attribute of this element been set.
499<P>
500<DD><DL>
501
502<DT><B>Returns:</B><DD>true if refid is valid.</DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="execute()"><!-- --></A><H3>
508execute</H3>
509<PRE>
510public void <B>execute</B>()
511 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
512<DL>
513<DD>Do the execution.
514<P>
515<DD><DL>
516<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>
517</DD>
518<DD><DL>
519
520<DT><B>Throws:</B>
521<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something is invalid.</DL>
522</DD>
523</DL>
524<HR>
525
526<A NAME="addMapper(org.apache.tools.ant.types.Mapper)"><!-- --></A><H3>
527addMapper</H3>
528<PRE>
529public void <B>addMapper</B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>&nbsp;mapper)</PRE>
530<DL>
531<DD>Add a mapper to convert the file names.
532<P>
533<DD><DL>
534<DT><B>Parameters:</B><DD><CODE>mapper</CODE> - a <code>Mapper</code> value.</DL>
535</DD>
536</DL>
537<HR>
538
539<A NAME="add(org.apache.tools.ant.util.FileNameMapper)"><!-- --></A><H3>
540add</H3>
541<PRE>
542public void <B>add</B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</PRE>
543<DL>
544<DD>Add a nested filenamemapper.
545<P>
546<DD><DL>
547<DT><B>Parameters:</B><DD><CODE>fileNameMapper</CODE> - the mapper to add.<DT><B>Since:</B></DT>
548 <DD>Ant 1.6.3</DD>
549</DL>
550</DD>
551</DL>
552<!-- ========= END OF CLASS DATA ========= -->
553<HR>
554
555
556<!-- ======= START OF BOTTOM NAVBAR ====== -->
557<A NAME="navbar_bottom"><!-- --></A>
558<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
559<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
560<TR>
561<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
562<A NAME="navbar_bottom_firstrow"><!-- --></A>
563<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
564 <TR ALIGN="center" VALIGN="top">
565 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
566 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
567 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
568 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
569 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
571 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
572 </TR>
573</TABLE>
574</TD>
575<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
576</EM>
577</TD>
578</TR>
579
580<TR>
581<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
582&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/Patch.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>&nbsp;
583&nbsp;<A HREF="../../../../../org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
584<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
585 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
586&nbsp;<A HREF="PathConvert.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
587&nbsp;<SCRIPT type="text/javascript">
588 <!--
589 if(window==top) {
590 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
591 }
592 //-->
593</SCRIPT>
594<NOSCRIPT>
595 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
596</NOSCRIPT>
597
598</FONT></TD>
599</TR>
600<TR>
601<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
602 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
603<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
604DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
605</TR>
606</TABLE>
607<A NAME="skip-navbar_bottom"></A>
608<!-- ======== END OF BOTTOM NAVBAR ======= -->
609
610<HR>
611Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
612</BODY>
613</HTML>
Note: See TracBrowser for help on using the repository browser.