source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Symlink.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.6 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:31 NZST 2007 -->
6<TITLE>
7Symlink (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.unix.Symlink 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="Symlink (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/optional/unix/Chown.html" title="class in org.apache.tools.ant.taskdefs.optional.unix"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;NEXT CLASS</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="Symlink.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;NESTED&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.optional.unix</FONT>
85<BR>
86Class Symlink</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.optional.unix.Symlink</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>Symlink</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Creates, Records and Restores Symlinks.
99
100 <p> This task performs several related operations. In the most trivial
101 and default usage, it creates a link specified in the link attribute to
102 a resource specified in the resource attribute. The second usage of this
103 task is to traverse a directory structure specified by a fileset,
104 and write a properties file in each included directory describing the
105 links found in that directory. The third usage is to traverse a
106 directory structure specified by a fileset, looking for properties files
107 (also specified as included in the fileset) and recreate the links
108 that have been previously recorded for each directory. Finally, it can be
109 used to remove a symlink without deleting the file or directory it points
110 to.
111
112 <p> Examples of use:
113
114 <p> Make a link named &quot;foo&quot; to a resource named
115 &quot;bar.foo&quot; in subdir:
116 <pre>
117 &lt;symlink link=&quot;${dir.top}/foo&quot; resource=&quot;${dir.top}/subdir/bar.foo&quot;/&gt;
118 </pre>
119
120 <p> Record all links in subdir and its descendants in files named
121 &quot;dir.links&quot;
122 <pre>
123 &lt;symlink action=&quot;record&quot; linkfilename=&quot;dir.links&quot;&gt;
124 &lt;fileset dir=&quot;${dir.top}&quot; includes=&quot;subdir&#47;**&quot; /&gt;
125 &lt;/symlink&gt;
126 </pre>
127
128 <p> Recreate the links recorded in the previous example:
129 <pre>
130 &lt;symlink action=&quot;recreate&quot;&gt;
131 &lt;fileset dir=&quot;${dir.top}&quot; includes=&quot;subdir&#47;**&#47;dir.links&quot; /&gt;
132 &lt;/symlink&gt;
133 </pre>
134
135 <p> Delete a link named &quot;foo&quot; to a resource named
136 &quot;bar.foo&quot; in subdir:
137 <pre>
138 &lt;symlink action=&quot;delete&quot; link=&quot;${dir.top}/foo&quot;/&gt;
139 </pre>
140
141 <p><strong>LIMITATIONS:</strong> Because Java has no direct support for
142 handling symlinks this task divines them by comparing canonical and
143 absolute paths. On non-unix systems this may cause false positives.
144 Furthermore, any operating system on which the command
145 <code>ln -s link resource</code> is not a valid command on the command line
146 will not be able to use action= &quot;delete&quot;, action=&quot;single&quot;
147 or action=&quot;recreate&quot;, but action=&quot;record&quot; should still
148 work. Finally, the lack of support for symlinks in Java means that all links
149 are recorded as links to the <strong>canonical</strong> resource name.
150 Therefore the link: <code>link --> subdir/dir/../foo.bar</code> will be
151 recorded as <code>link=subdir/foo.bar</code> and restored as
152 <code>link --> subdir/foo.bar</code>.
153<P>
154
155<P>
156<HR>
157
158<P>
159<!-- ======== NESTED CLASS SUMMARY ======== -->
160
161
162<!-- =========== FIELD SUMMARY =========== -->
163
164<A NAME="field_summary"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TD COLSPAN=2><FONT SIZE="+2">
168<B>Field Summary</B></FONT></TD>
169</TR>
170</TABLE>
171&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
174<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>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<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>
178</TR>
179</TABLE>
180&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183<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>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
187</TR>
188</TABLE>
189&nbsp;
190<!-- ======== CONSTRUCTOR SUMMARY ======== -->
191
192<A NAME="constructor_summary"><!-- --></A>
193<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
195<TD COLSPAN=2><FONT SIZE="+2">
196<B>Constructor Summary</B></FONT></TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#Symlink()">Symlink</A></B>()</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
203</TR>
204</TABLE>
205&nbsp;
206<!-- ========== METHOD SUMMARY =========== -->
207
208<A NAME="method_summary"><!-- --></A>
209<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
210<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
211<TD COLSPAN=2><FONT SIZE="+2">
212<B>Method Summary</B></FONT></TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a fileset to this task.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>static&nbsp;void</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#deleteSymlink(java.io.File)">deleteSymlink</A></B>(java.io.File&nbsp;linkfil)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes a symlink without deleting the resource it points to.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>static&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#deleteSymlink(java.lang.String)">deleteSymlink</A></B>(java.lang.String&nbsp;path)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes a symlink without deleting the resource it points to.</TD>
237</TR>
238<TR BGCOLOR="white" CLASS="TableRowColor">
239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240<CODE>&nbsp;void</CODE></FONT></TD>
241<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#execute()">execute</A></B>()</CODE>
242
243<BR>
244&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The standard method for executing any task.</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/optional/unix/Symlink.html#init()">init</A></B>()</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the task.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#setAction(java.lang.String)">setAction</A></B>(java.lang.String&nbsp;typ)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the action to be performed.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#setFailOnError(boolean)">setFailOnError</A></B>(boolean&nbsp;foe)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The setter for the failonerror attribute.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#setLink(java.lang.String)">setLink</A></B>(java.lang.String&nbsp;lnk)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the same of the link.</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#setLinkfilename(java.lang.String)">setLinkfilename</A></B>(java.lang.String&nbsp;lf)</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the file to which links will be written.</TD>
285</TR>
286<TR BGCOLOR="white" CLASS="TableRowColor">
287<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288<CODE>&nbsp;void</CODE></FONT></TD>
289<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#setOverwrite(boolean)">setOverwrite</A></B>(boolean&nbsp;owrite)</CODE>
290
291<BR>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The setter for the overwrite attribute.</TD>
293</TR>
294<TR BGCOLOR="white" CLASS="TableRowColor">
295<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296<CODE>&nbsp;void</CODE></FONT></TD>
297<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Symlink.html#setResource(java.lang.String)">setResource</A></B>(java.lang.String&nbsp;src)</CODE>
298
299<BR>
300&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the resource to which a link should be created.</TD>
301</TR>
302</TABLE>
303&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
304<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
305<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
306<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>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<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>
310</TR>
311</TABLE>
312&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
313<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
314<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
315<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>
316</TR>
317<TR BGCOLOR="white" CLASS="TableRowColor">
318<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>
319</TR>
320</TABLE>
321&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
322<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
323<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
324<TD><B>Methods inherited from class java.lang.Object</B></TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
328</TR>
329</TABLE>
330&nbsp;
331<P>
332
333<!-- ============ FIELD DETAIL =========== -->
334
335
336<!-- ========= CONSTRUCTOR DETAIL ======== -->
337
338<A NAME="constructor_detail"><!-- --></A>
339<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
340<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
341<TD COLSPAN=1><FONT SIZE="+2">
342<B>Constructor Detail</B></FONT></TD>
343</TR>
344</TABLE>
345
346<A NAME="Symlink()"><!-- --></A><H3>
347Symlink</H3>
348<PRE>
349public <B>Symlink</B>()</PRE>
350<DL>
351</DL>
352
353<!-- ============ METHOD DETAIL ========== -->
354
355<A NAME="method_detail"><!-- --></A>
356<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
357<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
358<TD COLSPAN=1><FONT SIZE="+2">
359<B>Method Detail</B></FONT></TD>
360</TR>
361</TABLE>
362
363<A NAME="init()"><!-- --></A><H3>
364init</H3>
365<PRE>
366public void <B>init</B>()
367 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
368<DL>
369<DD>Initialize the task.
370<P>
371<DD><DL>
372<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>
373</DD>
374<DD><DL>
375
376<DT><B>Throws:</B>
377<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - on error.</DL>
378</DD>
379</DL>
380<HR>
381
382<A NAME="execute()"><!-- --></A><H3>
383execute</H3>
384<PRE>
385public void <B>execute</B>()
386 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
387<DL>
388<DD>The standard method for executing any task.
389<P>
390<DD><DL>
391<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>
392</DD>
393<DD><DL>
394
395<DT><B>Throws:</B>
396<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - on error.</DL>
397</DD>
398</DL>
399<HR>
400
401<A NAME="setOverwrite(boolean)"><!-- --></A><H3>
402setOverwrite</H3>
403<PRE>
404public void <B>setOverwrite</B>(boolean&nbsp;owrite)</PRE>
405<DL>
406<DD>The setter for the overwrite attribute. If set to false (default)
407 the task will not overwrite existing links, and may stop the build
408 if a link already exists depending on the setting of failonerror.
409<P>
410<DD><DL>
411<DT><B>Parameters:</B><DD><CODE>owrite</CODE> - If true overwrite existing links.</DL>
412</DD>
413</DL>
414<HR>
415
416<A NAME="setFailOnError(boolean)"><!-- --></A><H3>
417setFailOnError</H3>
418<PRE>
419public void <B>setFailOnError</B>(boolean&nbsp;foe)</PRE>
420<DL>
421<DD>The setter for the failonerror attribute. If set to true (default)
422 the entire build fails upon error. If set to false, the error is
423 logged and the build will continue.
424<P>
425<DD><DL>
426<DT><B>Parameters:</B><DD><CODE>foe</CODE> - If true throw BuildException on error else log it.</DL>
427</DD>
428</DL>
429<HR>
430
431<A NAME="setAction(java.lang.String)"><!-- --></A><H3>
432setAction</H3>
433<PRE>
434public void <B>setAction</B>(java.lang.String&nbsp;typ)</PRE>
435<DL>
436<DD>Set the action to be performed. May be
437 &quot;single&quot;, &quot;multi&quot; or &quot;record&quot;.
438<P>
439<DD><DL>
440<DT><B>Parameters:</B><DD><CODE>typ</CODE> - The action to perform.</DL>
441</DD>
442</DL>
443<HR>
444
445<A NAME="setLink(java.lang.String)"><!-- --></A><H3>
446setLink</H3>
447<PRE>
448public void <B>setLink</B>(java.lang.String&nbsp;lnk)</PRE>
449<DL>
450<DD>Set the same of the link.
451 Only used when action = &quot;single&quot;.
452<P>
453<DD><DL>
454<DT><B>Parameters:</B><DD><CODE>lnk</CODE> - The name for the link.</DL>
455</DD>
456</DL>
457<HR>
458
459<A NAME="setResource(java.lang.String)"><!-- --></A><H3>
460setResource</H3>
461<PRE>
462public void <B>setResource</B>(java.lang.String&nbsp;src)</PRE>
463<DL>
464<DD>Set the name of the resource to which a link should be created.
465 Only used when action = &quot;single&quot;.
466<P>
467<DD><DL>
468<DT><B>Parameters:</B><DD><CODE>src</CODE> - The resource to be linked.</DL>
469</DD>
470</DL>
471<HR>
472
473<A NAME="setLinkfilename(java.lang.String)"><!-- --></A><H3>
474setLinkfilename</H3>
475<PRE>
476public void <B>setLinkfilename</B>(java.lang.String&nbsp;lf)</PRE>
477<DL>
478<DD>Set the name of the file to which links will be written.
479 Only used when action = &quot;record&quot;.
480<P>
481<DD><DL>
482<DT><B>Parameters:</B><DD><CODE>lf</CODE> - The name of the file to write links to.</DL>
483</DD>
484</DL>
485<HR>
486
487<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
488addFileset</H3>
489<PRE>
490public void <B>addFileset</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A>&nbsp;set)</PRE>
491<DL>
492<DD>Add a fileset to this task.
493<P>
494<DD><DL>
495<DT><B>Parameters:</B><DD><CODE>set</CODE> - The fileset to add.</DL>
496</DD>
497</DL>
498<HR>
499
500<A NAME="deleteSymlink(java.lang.String)"><!-- --></A><H3>
501deleteSymlink</H3>
502<PRE>
503public static void <B>deleteSymlink</B>(java.lang.String&nbsp;path)
504 throws java.io.IOException,
505 java.io.FileNotFoundException</PRE>
506<DL>
507<DD>Deletes a symlink without deleting the resource it points to.
508
509 <p>This is a convenience method that simply invokes
510 <code>deleteSymlink(java.io.File)</code>.
511<P>
512<DD><DL>
513<DT><B>Parameters:</B><DD><CODE>path</CODE> - A string containing the path of the symlink to delete.
514<DT><B>Throws:</B>
515<DD><CODE>java.io.FileNotFoundException</CODE> - When the path results in a
516 <code>File</code> that doesn't exist.
517<DD><CODE>java.io.IOException</CODE> - If calls to <code>File.rename</code>
518 or <code>File.delete</code> fail.</DL>
519</DD>
520</DL>
521<HR>
522
523<A NAME="deleteSymlink(java.io.File)"><!-- --></A><H3>
524deleteSymlink</H3>
525<PRE>
526public static void <B>deleteSymlink</B>(java.io.File&nbsp;linkfil)
527 throws java.io.IOException,
528 java.io.FileNotFoundException</PRE>
529<DL>
530<DD>Deletes a symlink without deleting the resource it points to.
531
532 <p>This is a utility method that removes a unix symlink without removing
533 the resource that the symlink points to. If it is accidentally invoked
534 on a real file, the real file will not be harmed, but an exception
535 will be thrown when the deletion is attempted. This method works by
536 getting the canonical path of the link, using the canonical path to
537 rename the resource (breaking the link) and then deleting the link.
538 The resource is then returned to its original name inside a finally
539 block to ensure that the resource is unharmed even in the event of
540 an exception.
541<P>
542<DD><DL>
543<DT><B>Parameters:</B><DD><CODE>linkfil</CODE> - A <code>File</code> object of the symlink to delete.
544<DT><B>Throws:</B>
545<DD><CODE>java.io.FileNotFoundException</CODE> - When the path results in a
546 <code>File</code> that doesn't exist.
547<DD><CODE>java.io.IOException</CODE> - If calls to <code>File.rename</code>,
548 <code>File.delete</code> or
549 <code>File.getCanonicalPath</code>
550 fail.</DL>
551</DD>
552</DL>
553<!-- ========= END OF CLASS DATA ========= -->
554<HR>
555
556
557<!-- ======= START OF BOTTOM NAVBAR ====== -->
558<A NAME="navbar_bottom"><!-- --></A>
559<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
560<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
561<TR>
562<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
563<A NAME="navbar_bottom_firstrow"><!-- --></A>
564<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
565 <TR ALIGN="center" VALIGN="top">
566 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
567 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
568 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
569 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
571 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
572 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
573 </TR>
574</TABLE>
575</TD>
576<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
577</EM>
578</TD>
579</TR>
580
581<TR>
582<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
583&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/unix/Chown.html" title="class in org.apache.tools.ant.taskdefs.optional.unix"><B>PREV CLASS</B></A>&nbsp;
584&nbsp;NEXT CLASS</FONT></TD>
585<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
586 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
587&nbsp;<A HREF="Symlink.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
588&nbsp;<SCRIPT type="text/javascript">
589 <!--
590 if(window==top) {
591 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
592 }
593 //-->
594</SCRIPT>
595<NOSCRIPT>
596 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
597</NOSCRIPT>
598
599</FONT></TD>
600</TR>
601<TR>
602<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
603 SUMMARY:&nbsp;NESTED&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>
604<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
605DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
606</TR>
607</TABLE>
608<A NAME="skip-navbar_bottom"></A>
609<!-- ======== END OF BOTTOM NAVBAR ======= -->
610
611<HR>
612Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
613</BODY>
614</HTML>
Note: See TracBrowser for help on using the repository browser.