????
| Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/ |
| Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/jlink.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:53 CEST 2012 -->
<title>jlink (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="jlink (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/jlink/jlink.html" target="_top">Frames</a></li>
<li><a href="jlink.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs.optional.jlink</div>
<h2 title="Class jlink" class="title">Class jlink</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.jlink.jlink</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">jlink</span>
extends java.lang.Object</pre>
<div class="block">jlink links together multiple .jar files.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#jlink()">jlink</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addAddFile(java.lang.String)">addAddFile</a></strong>(java.lang.String fileToAdd)</code>
<div class="block">Adds a file to be added into the output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addAddFiles(java.lang.String[])">addAddFiles</a></strong>(java.lang.String[] filesToAdd)</code>
<div class="block">Adds several file to be added into the output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addMergeFile(java.lang.String)">addMergeFile</a></strong>(java.lang.String fileToMerge)</code>
<div class="block">Adds a file to be merged into the output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#addMergeFiles(java.lang.String[])">addMergeFiles</a></strong>(java.lang.String[] filesToMerge)</code>
<div class="block">Adds several files to be merged into the output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#link()">link</a></strong>()</code>
<div class="block">Performs the linking of files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</code>
<div class="block">The command line entry point for jlink.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#setCompression(boolean)">setCompression</a></strong>(boolean compress)</code>
<div class="block">Determines whether output will be compressed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/jlink.html#setOutfile(java.lang.String)">setOutfile</a></strong>(java.lang.String outfile)</code>
<div class="block">The file that will be created by this instance of jlink.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="jlink()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>jlink</h4>
<pre>public jlink()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setOutfile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutfile</h4>
<pre>public void setOutfile(java.lang.String outfile)</pre>
<div class="block">The file that will be created by this instance of jlink.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outfile</code> - the file to create.</dd></dl>
</li>
</ul>
<a name="addMergeFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMergeFile</h4>
<pre>public void addMergeFile(java.lang.String fileToMerge)</pre>
<div class="block">Adds a file to be merged into the output.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileToMerge</code> - the file to merge into the output.</dd></dl>
</li>
</ul>
<a name="addAddFile(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAddFile</h4>
<pre>public void addAddFile(java.lang.String fileToAdd)</pre>
<div class="block">Adds a file to be added into the output.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileToAdd</code> - the file to add to the output.</dd></dl>
</li>
</ul>
<a name="addMergeFiles(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMergeFiles</h4>
<pre>public void addMergeFiles(java.lang.String[] filesToMerge)</pre>
<div class="block">Adds several files to be merged into the output.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filesToMerge</code> - an array of files to merge into the output.</dd></dl>
</li>
</ul>
<a name="addAddFiles(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAddFiles</h4>
<pre>public void addAddFiles(java.lang.String[] filesToAdd)</pre>
<div class="block">Adds several file to be added into the output.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filesToAdd</code> - an array of files to add to the output.</dd></dl>
</li>
</ul>
<a name="setCompression(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCompression</h4>
<pre>public void setCompression(boolean compress)</pre>
<div class="block">Determines whether output will be compressed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>compress</code> - if true use compression.</dd></dl>
</li>
</ul>
<a name="link()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>link</h4>
<pre>public void link()
throws java.lang.Exception</pre>
<div class="block">Performs the linking of files. Addfiles are added to the output as-is.
For example, a jar file is added to the output as a jar file. However,
mergefiles are first examined for their type. If it is a jar or zip
file, the contents will be extracted from the mergefile and entered
into the output. If a zip or jar file is encountered in a subdirectory
it will be added, not merged. If a directory is encountered, it becomes
the root entry of all the files below it. Thus, you can provide
multiple, disjoint directories, as addfiles: they will all be added in
a rational manner to outfile.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - on error.</dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(java.lang.String[] args)</pre>
<div class="block">The command line entry point for jlink.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - an array of arguments</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html" title="class in org.apache.tools.ant.taskdefs.optional.jlink"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/jlink/jlink.html" target="_top">Frames</a></li>
<li><a href="jlink.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>