jruby-gradle.github.io/groovydoc/jruby-gradle-jar-plugin/com/github/jrubygradle/jar/JRubyJar.html

663 lines
32 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->
<html>
<head>
<!-- Generated by groovydoc (2.3.3) on Fri Jul 31 01:11:25 PDT 2015 -->
<title>JRubyJar (jruby-gradle-jar-plugin 1.0.0)</title>
<meta name="date" content="2015-07-31">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JRubyJar (jruby-gradle-jar-plugin 1.0.0)";
}
//-->
</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="../../../../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">
<div>
<ul class="navList">
<li><a href="../../../../index.html?com/github/jrubygradle/jar/JRubyJar" target="_top">Frames</a></li>
<li><a href="JRubyJar.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_summary">Nested</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#field_summary">Field</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#property_summary">Property</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#prop_detail">Property</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Package: <strong>com.github.jrubygradle.jar</strong></div>
<h2 title="[Groovy] Class JRubyJar" class="title">[Groovy] Class JRubyJar</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.jar.JRubyJar
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<p>
<DL><DT><B>Authors:</B></DT><DD>Christian Meier</DD></DL></p>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== NESTED CLASS SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="nested_summary"><!-- --></a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifiers</th>
<th class="colLast" scope="col">Name</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>enum</strong></code>&nbsp;</td>
<td class="colLast"><code><a href='../../../../com/github/jrubygradle/jar/JRubyJar.Type.html'>JRubyJar.Type</a></code></td>
<td class="colLast"></code></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary"><!-- --></a>
<h3>Field Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum constants summary table">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifiers</th>
<th class="colLast" scope="col">Name</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>protected&nbsp;<a href='../../../../com/github/jrubygradle/jar/internal/JRubyDirInfo.html'>JRubyDirInfo</a></strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#dirInfo">dirInfo</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>protected&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#jrubyVersion">jrubyVersion</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>protected&nbsp;<a href='../../../../JRubyPrepare.html'>JRubyPrepare</a></strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#prepareTask">prepareTask</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>protected&nbsp;java.lang.Object</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#scriptName">scriptName</a></code></td>
<td class="colLast"></code></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- =========== PROPERTY SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="property_summary"><!-- --></a>
<h3>Properties Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Properties Summary table, listing nested classes, and an explanation">
<caption><span>Properties</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#DEFAULT_JRUBYJAR_CONFIG"></a>DEFAULT_JRUBYJAR_CONFIG</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#DEFAULT_MAIN_CLASS"></a>DEFAULT_MAIN_CLASS</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#EXTRACTING_MAIN_CLASS"></a>EXTRACTING_MAIN_CLASS</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#configuration"></a>configuration</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#jrubyMainsVersion"></a>jrubyMainsVersion</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#mainClass"></a>mainClass</code><br></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- =========== ELEMENT SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary"><!-- --></a>
<h3>Constructor Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor and description</th>
</tr>
<tr class="altColor">
<td class="colFirst">
<code><a href="#JRubyJar()">JRubyJar</a></strong>
()</code><br></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#addJRubyDependencies(Configuration)">addJRubyDependencies</a></strong>(<a href='../../../../Configuration.html'>Configuration</a> config)</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#applyConfig()">applyConfig</a></strong>()</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#defaultMainClass()">defaultMainClass</a></strong>()</code><br>Makes the executable by adding a default main class</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#defaults(java.lang.String)">defaults</a></strong>(java.lang.String... defs)</code><br>Sets the defaults</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#extractingMainClass()">extractingMainClass</a></strong>()</code><br>Makes the executable by adding a default main class
which extracts the jar to temporary directory</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.File</strong></code></td>
<td class="colLast"><code><strong><a href="#getGemDir()">getGemDir</a></strong>()</code><br>Return the directory that the dependencies for this project will be staged into</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</strong></code></td>
<td class="colLast"><code><strong><a href="#getJrubyVersion()">getJrubyVersion</a></strong>()</code><br>Return the project default unless set</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#initScript(java.lang.Object)">initScript</a></strong>(java.lang.Object scriptName)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#jrubyMainsVersion(java.lang.String)">jrubyMainsVersion</a></strong>(java.lang.String version)</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#jrubyVersion(java.lang.String)">jrubyVersion</a></strong>(java.lang.String version)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href='../../../../com/github/jrubygradle/jar/JRubyJar.Type.html'>JRubyJar.Type</a></strong></code></td>
<td class="colLast"><code><strong><a href="#library()">library</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#mainClass(java.lang.String)">mainClass</a></strong>(java.lang.String className)</code><br>Makes the JAR executable by setting a custom main class</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href='../../../../com/github/jrubygradle/jar/JRubyJar.Type.html'>JRubyJar.Type</a></strong></code></td>
<td class="colLast"><code><strong><a href="#runnable()">runnable</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#setConfiguration(java.lang.String)">setConfiguration</a></strong>(java.lang.String newConfiguration)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#updateDependencies()">updateDependencies</a></strong>()</code><br></td>
</tr>
</table>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="dirInfo"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;<a href='../../../../com/github/jrubygradle/jar/internal/JRubyDirInfo.html'>JRubyDirInfo</a> <strong>dirInfo</strong></h4>
<p></p>
</li>
</ul>
<a name="jrubyVersion"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.String <strong>jrubyVersion</strong></h4>
<p></p>
</li>
</ul>
<a name="prepareTask"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;<a href='../../../../JRubyPrepare.html'>JRubyPrepare</a> <strong>prepareTask</strong></h4>
<p></p>
</li>
</ul>
<a name="scriptName"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.Object <strong>scriptName</strong></h4>
<p></p>
</li>
</ul>
</li>
</ul>
<!-- =========== PROPERTY DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="prop_detail">
<!-- -->
</a>
<h3>Property Detail</h3>
<a name="DEFAULT_JRUBYJAR_CONFIG"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;final&nbsp;java.lang.String <strong>DEFAULT_JRUBYJAR_CONFIG</strong></h4>
<p></p>
</li>
</ul>
<a name="DEFAULT_MAIN_CLASS"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;final&nbsp;java.lang.String <strong>DEFAULT_MAIN_CLASS</strong></h4>
<p></p>
</li>
</ul>
<a name="EXTRACTING_MAIN_CLASS"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;final&nbsp;java.lang.String <strong>EXTRACTING_MAIN_CLASS</strong></h4>
<p></p>
</li>
</ul>
<a name="configuration"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@Input
@java.util.Optional
java.lang.String <strong>configuration</strong></h4>
<p></p>
</li>
</ul>
<a name="jrubyMainsVersion"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@Input
java.lang.String <strong>jrubyMainsVersion</strong></h4>
<p></p>
</li>
</ul>
<a name="mainClass"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@Input
java.lang.String <strong>mainClass</strong></h4>
<p></p>
</li>
</ul>
</li>
</ul>
<!-- =========== CONSTRUCTOR DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JRubyJar()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><strong>JRubyJar</strong>()</h4>
<p></p>
</li>
</ul>
</li>
</ul>
<!-- =========== METHOD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addJRubyDependencies(Configuration)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>addJRubyDependencies</strong>(<a href='../../../../Configuration.html'>Configuration</a> config)</h4>
<p></p>
</li>
</ul>
<a name="applyConfig()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@groovy.transform.PackageScope
void <strong>applyConfig</strong>()</h4>
<p></p>
</li>
</ul>
<a name="defaultMainClass()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>defaultMainClass</strong>()</h4>
<p> Makes the executable by adding a default main class
</p>
</li>
</ul>
<a name="defaults(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>defaults</strong>(java.lang.String... defs)</h4>
<p> Sets the defaults
<DL><DT><B>Parameters:</B></DT><DD><code>defs</code> - A list of defaults. Currently <CODE>gems</CODE> and <CODE>mainClass</CODE> are the only recognised values.
Unrecognised values are silently discarded</DD></DL></p>
</li>
</ul>
<a name="extractingMainClass()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>extractingMainClass</strong>()</h4>
<p> Makes the executable by adding a default main class
which extracts the jar to temporary directory
</p>
</li>
</ul>
<a name="getGemDir()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>java.io.File <strong>getGemDir</strong>()</h4>
<p> Return the directory that the dependencies for this project will be staged into </p>
</li>
</ul>
<a name="getJrubyVersion()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>java.lang.String <strong>getJrubyVersion</strong>()</h4>
<p> Return the project default unless set </p>
</li>
</ul>
<a name="initScript(java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>initScript</strong>(java.lang.Object scriptName)</h4>
<p></p>
</li>
</ul>
<a name="jrubyMainsVersion(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>jrubyMainsVersion</strong>(java.lang.String version)</h4>
<p></p>
</li>
</ul>
<a name="jrubyVersion(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@Input
void <strong>jrubyVersion</strong>(java.lang.String version)</h4>
<p></p>
</li>
</ul>
<a name="library()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><a href='../../../../com/github/jrubygradle/jar/JRubyJar.Type.html'>JRubyJar.Type</a> <strong>library</strong>()</h4>
<p></p>
</li>
</ul>
<a name="mainClass(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>mainClass</strong>(java.lang.String className)</h4>
<p> Makes the JAR executable by setting a custom main class
<DL><DT><B>Parameters:</B></DT><DD><code>className</code> - Name of main class</DD></DL></p>
</li>
</ul>
<a name="runnable()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><a href='../../../../com/github/jrubygradle/jar/JRubyJar.Type.html'>JRubyJar.Type</a> <strong>runnable</strong>()</h4>
<p></p>
</li>
</ul>
<a name="setConfiguration(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>setConfiguration</strong>(java.lang.String newConfiguration)</h4>
<p></p>
</li>
</ul>
<a name="updateDependencies()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>updateDependencies</strong>()</h4>
<p></p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</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="../../../../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">
<div>
<ul class="navList">
<li><a href="../../../../index.html?com/github/jrubygradle/jar/JRubyJar" target="_top">Frames</a></li>
<li><a href="JRubyJar.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_summary">Nested</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#field_summary">Field</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#property_summary">Property</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#prop_detail">Property</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<p>Groovy Documentation</p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>