source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/jlink/jlink.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 14.9 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:27 NZST 2007 -->
6<TITLE>
7jlink (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.jlink.jlink 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="jlink (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/jlink/ClassNameReader.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><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="jlink.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;FIELD&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.jlink</FONT>
85<BR>
86Class jlink</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.jlink.jlink</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>jlink</B><DT>extends java.lang.Object</DL>
94
95<P>
96<HR>
97
98<P>
99<!-- ======== NESTED CLASS SUMMARY ======== -->
100
101
102<!-- =========== FIELD SUMMARY =========== -->
103
104
105<!-- ======== CONSTRUCTOR SUMMARY ======== -->
106
107<A NAME="constructor_summary"><!-- --></A>
108<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
109<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
110<TD COLSPAN=2><FONT SIZE="+2">
111<B>Constructor Summary</B></FONT></TD>
112</TR>
113<TR BGCOLOR="white" CLASS="TableRowColor">
114<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#jlink()">jlink</A></B>()</CODE>
115
116<BR>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
118</TR>
119</TABLE>
120&nbsp;
121<!-- ========== METHOD SUMMARY =========== -->
122
123<A NAME="method_summary"><!-- --></A>
124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126<TD COLSPAN=2><FONT SIZE="+2">
127<B>Method Summary</B></FONT></TD>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>&nbsp;void</CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addAddFile(java.lang.String)">addAddFile</A></B>(java.lang.String&nbsp;addfile)</CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a file to be added into the output.</TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;void</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addAddFiles(java.lang.String[])">addAddFiles</A></B>(java.lang.String[]&nbsp;addfiles)</CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds several file to be added into the output.</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;void</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addMergeFile(java.lang.String)">addMergeFile</A></B>(java.lang.String&nbsp;mergefile)</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a file to be merged into the output.</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;void</CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addMergeFiles(java.lang.String[])">addMergeFiles</A></B>(java.lang.String[]&nbsp;mergefiles)</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds several files to be merged into the output.</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;void</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#link()">link</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs the linking of files.</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>static&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;void</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#setCompression(boolean)">setCompression</A></B>(boolean&nbsp;compress)</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether output will be compressed.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;void</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#setOutfile(java.lang.String)">setOutfile</A></B>(java.lang.String&nbsp;outfile)</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The file that will be created by this instance of jlink.</TD>
192</TR>
193</TABLE>
194&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
197<TD><B>Methods inherited from class java.lang.Object</B></TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
201</TR>
202</TABLE>
203&nbsp;
204<P>
205
206<!-- ============ FIELD DETAIL =========== -->
207
208
209<!-- ========= CONSTRUCTOR DETAIL ======== -->
210
211<A NAME="constructor_detail"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214<TD COLSPAN=1><FONT SIZE="+2">
215<B>Constructor Detail</B></FONT></TD>
216</TR>
217</TABLE>
218
219<A NAME="jlink()"><!-- --></A><H3>
220jlink</H3>
221<PRE>
222public <B>jlink</B>()</PRE>
223<DL>
224</DL>
225
226<!-- ============ METHOD DETAIL ========== -->
227
228<A NAME="method_detail"><!-- --></A>
229<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
230<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
231<TD COLSPAN=1><FONT SIZE="+2">
232<B>Method Detail</B></FONT></TD>
233</TR>
234</TABLE>
235
236<A NAME="setOutfile(java.lang.String)"><!-- --></A><H3>
237setOutfile</H3>
238<PRE>
239public void <B>setOutfile</B>(java.lang.String&nbsp;outfile)</PRE>
240<DL>
241<DD>The file that will be created by this instance of jlink.
242<P>
243<DD><DL>
244</DL>
245</DD>
246</DL>
247<HR>
248
249<A NAME="addMergeFile(java.lang.String)"><!-- --></A><H3>
250addMergeFile</H3>
251<PRE>
252public void <B>addMergeFile</B>(java.lang.String&nbsp;mergefile)</PRE>
253<DL>
254<DD>Adds a file to be merged into the output.
255<P>
256<DD><DL>
257</DL>
258</DD>
259</DL>
260<HR>
261
262<A NAME="addAddFile(java.lang.String)"><!-- --></A><H3>
263addAddFile</H3>
264<PRE>
265public void <B>addAddFile</B>(java.lang.String&nbsp;addfile)</PRE>
266<DL>
267<DD>Adds a file to be added into the output.
268<P>
269<DD><DL>
270</DL>
271</DD>
272</DL>
273<HR>
274
275<A NAME="addMergeFiles(java.lang.String[])"><!-- --></A><H3>
276addMergeFiles</H3>
277<PRE>
278public void <B>addMergeFiles</B>(java.lang.String[]&nbsp;mergefiles)</PRE>
279<DL>
280<DD>Adds several files to be merged into the output.
281<P>
282<DD><DL>
283</DL>
284</DD>
285</DL>
286<HR>
287
288<A NAME="addAddFiles(java.lang.String[])"><!-- --></A><H3>
289addAddFiles</H3>
290<PRE>
291public void <B>addAddFiles</B>(java.lang.String[]&nbsp;addfiles)</PRE>
292<DL>
293<DD>Adds several file to be added into the output.
294<P>
295<DD><DL>
296</DL>
297</DD>
298</DL>
299<HR>
300
301<A NAME="setCompression(boolean)"><!-- --></A><H3>
302setCompression</H3>
303<PRE>
304public void <B>setCompression</B>(boolean&nbsp;compress)</PRE>
305<DL>
306<DD>Determines whether output will be compressed.
307<P>
308<DD><DL>
309</DL>
310</DD>
311</DL>
312<HR>
313
314<A NAME="link()"><!-- --></A><H3>
315link</H3>
316<PRE>
317public void <B>link</B>()
318 throws java.lang.Exception</PRE>
319<DL>
320<DD>Performs the linking of files. Addfiles are added to the output as-is.
321 For example, a jar file is added to the output as a jar file. However,
322 mergefiles are first examined for their type. If it is a jar or zip
323 file, the contents will be extracted from the mergefile and entered
324 into the output. If a zip or jar file is encountered in a subdirectory
325 it will be added, not merged. If a directory is encountered, it becomes
326 the root entry of all the files below it. Thus, you can provide
327 multiple, disjoint directories, as addfiles: they will all be added in
328 a rational manner to outfile.
329<P>
330<DD><DL>
331
332<DT><B>Throws:</B>
333<DD><CODE>java.lang.Exception</CODE></DL>
334</DD>
335</DL>
336<HR>
337
338<A NAME="main(java.lang.String[])"><!-- --></A><H3>
339main</H3>
340<PRE>
341public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
342<DL>
343<DD><DL>
344</DL>
345</DD>
346</DL>
347<!-- ========= END OF CLASS DATA ========= -->
348<HR>
349
350
351<!-- ======= START OF BOTTOM NAVBAR ====== -->
352<A NAME="navbar_bottom"><!-- --></A>
353<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
354<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
355<TR>
356<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
357<A NAME="navbar_bottom_firstrow"><!-- --></A>
358<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
359 <TR ALIGN="center" VALIGN="top">
360 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
361 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
362 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
363 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
364 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
365 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
366 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
367 </TR>
368</TABLE>
369</TD>
370<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
371</EM>
372</TD>
373</TR>
374
375<TR>
376<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
377&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><B>PREV CLASS</B></A>&nbsp;
378&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><B>NEXT CLASS</B></A></FONT></TD>
379<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
380 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
381&nbsp;<A HREF="jlink.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
382&nbsp;<SCRIPT type="text/javascript">
383 <!--
384 if(window==top) {
385 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
386 }
387 //-->
388</SCRIPT>
389<NOSCRIPT>
390 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
391</NOSCRIPT>
392
393</FONT></TD>
394</TR>
395<TR>
396<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
397 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
398<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
399DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
400</TR>
401</TABLE>
402<A NAME="skip-navbar_bottom"></A>
403<!-- ======== END OF BOTTOM NAVBAR ======= -->
404
405<HR>
406Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
407</BODY>
408</HTML>
Note: See TracBrowser for help on using the repository browser.