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

798 lines
75 KiB
HTML
Raw Normal View History

2015-07-21 18:45:51 +00:00
<!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>
2015-09-10 22:25:23 +00:00
<!-- Generated by groovydoc (2.3.3) on Thu Sep 10 15:25:16 PDT 2015 -->
<title>JRubyJar (jruby-gradle-jar-plugin 1.1.0)</title>
2015-09-10 22:23:51 +00:00
<meta name="date" content="2015-09-10">
2015-07-21 18:45:51 +00:00
<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) {
2015-09-10 22:25:23 +00:00
parent.document.title="JRubyJar (jruby-gradle-jar-plugin 1.1.0)";
2015-07-21 18:45:51 +00:00
}
//-->
</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>
2015-07-31 08:11:32 +00:00
<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;
2015-07-21 18:45:51 +00:00
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
2015-07-31 08:11:32 +00:00
<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;
2015-07-21 18:45:51 +00:00
</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">
2015-08-14 16:06:49 +00:00
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.jar.JRubyJar
2015-07-21 18:45:51 +00:00
</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 =========== -->
2015-07-31 08:11:32 +00:00
<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">
2015-08-14 16:06:49 +00:00
<td class="colFirst"><code><strong>protected&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#customConfigName">customConfigName</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="rowColor">
2015-07-31 08:11:32 +00:00
<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>
2015-08-14 16:06:49 +00:00
<tr class="altColor">
2015-07-31 08:11:32 +00:00
<td class="colFirst"><code><strong>protected&nbsp;java.lang.String</strong></code>&nbsp;</td>
2015-09-10 22:23:51 +00:00
<td class="colLast"><code><a href="#embeddedJRubyMainsVersion">embeddedJRubyMainsVersion</a></code></td>
2015-07-31 08:11:32 +00:00
<td class="colLast"></code></td>
</tr>
2015-08-14 16:06:49 +00:00
<tr class="rowColor">
2015-09-10 22:23:51 +00:00
<td class="colFirst"><code><strong>protected&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#embeddedJRubyVersion">embeddedJRubyVersion</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>protected&nbsp;java.lang.String</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#jarConfiguration">jarConfiguration</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="#jarMainClass">jarMainClass</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="altColor">
2015-08-14 16:06:49 +00:00
<td class="colFirst"><code><strong>protected&nbsp;com.github.jrubygradle.JRubyPrepare</strong></code>&nbsp;</td>
2015-07-31 08:11:32 +00:00
<td class="colLast"><code><a href="#prepareTask">prepareTask</a></code></td>
<td class="colLast"></code></td>
</tr>
2015-09-10 22:23:51 +00:00
<tr class="rowColor">
2015-07-31 08:11:32 +00:00
<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>
2015-08-14 16:06:49 +00:00
<li class="blockList"><a name="field_summary"><!-- --></a>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited fields summary table">
<caption><span>Inherited fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Fields inherited from class</th>
<th class="colLast" scope="col">Fields</th>
</tr>
<tr class="altColor">
<td class="colFirst"><strong><code>class org.gradle.api.tasks.bundling.Jar</code></strong></td>
<td class="colLast"><code>DEFAULT_EXTENSION, __$stMC, __timeStamp, __timeStamp__239_neverHappen1404200857496, ZIP_EXTENSION, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><strong><code>class org.gradle.api.tasks.bundling.Zip</code></strong></td>
<td class="colLast"><code>ZIP_EXTENSION, TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION</code></td>
</tr>
</table>
</ul>
</li>
2015-07-31 08:11:32 +00:00
</ul>
2015-07-21 18:45:51 +00:00
<!-- =========== 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>
2015-07-31 08:11:32 +00:00
<td class="colLast"><code><a href="#DEFAULT_JRUBYJAR_CONFIG"></a>DEFAULT_JRUBYJAR_CONFIG</code><br></td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
2015-08-07 15:24:54 +00:00
<td class="colLast"><code><a href="#DEFAULT_JRUBY_MAINS"></a>DEFAULT_JRUBY_MAINS</code><br></td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="altColor">
2015-07-31 08:11:32 +00:00
<td class="colFirst"><code><strong>static&nbsp;java.lang.String</strong></code>&nbsp;</td>
2015-08-07 15:24:54 +00:00
<td class="colLast"><code><a href="#DEFAULT_MAIN_CLASS"></a>DEFAULT_MAIN_CLASS</code><br></td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="rowColor">
2015-08-07 15:24:54 +00:00
<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>
2015-07-21 18:45:51 +00:00
</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>
2015-08-14 16:06:49 +00:00
<td class="colLast"><code><strong><a href="#addEmbeddedDependencies(org.gradle.api.artifacts.Configuration)">addEmbeddedDependencies</a></strong>(org.gradle.api.artifacts.Configuration config)</code><br>Add the necessary JRuby dependencies to the specified <CODE>org.gradle.api.artifacts.Configuration</CODE></td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
2015-08-14 16:06:49 +00:00
<td class="colLast"><code><strong><a href="#addJRubyDependency()">addJRubyDependency</a></strong>()</code><br>Adds our jruby-complete to a custom configuration only so it can be
safely unzipped later when we build the jar</td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
2015-08-14 16:06:49 +00:00
<td class="colLast"><code><strong><a href="#applyConfig()">applyConfig</a></strong>()</code><br></td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</strong></code></td>
2015-08-14 16:06:49 +00:00
<td class="colLast"><code><strong><a href="#defaultMainClass()">defaultMainClass</a></strong>()</code><br>Makes the executable by adding a default main class</td>
2015-07-21 18:45:51 +00:00
</tr>
<tr class="altColor">
2015-08-14 16:06:49 +00:00
<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="rowColor">
2015-07-21 18:45:51 +00:00
<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>
2015-08-14 16:06:49 +00:00
<tr class="altColor">
2015-09-10 22:23:51 +00:00
<td class="colFirst"><code>java.lang.String</strong></code></td>
<td class="colLast"><code><strong><a href="#getConfiguration()">getConfiguration</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
2015-07-31 08:11:32 +00:00
<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>
2015-07-21 18:45:51 +00:00
</tr>
2015-09-10 22:23:51 +00:00
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</strong></code></td>
<td class="colLast"><code><strong><a href="#getJrubyMainsVersion()">getJrubyMainsVersion</a></strong>()</code><br></td>
</tr>
2015-08-14 16:06:49 +00:00
<tr class="rowColor">
2015-07-31 08:11:32 +00:00
<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>
2015-07-21 18:45:51 +00:00
</tr>
2015-08-14 16:06:49 +00:00
<tr class="altColor">
2015-09-10 22:23:51 +00:00
<td class="colFirst"><code>java.lang.String</strong></code></td>
<td class="colLast"><code><strong><a href="#getMainClass()">getMainClass</a></strong>()</code><br></td>
</tr>
<tr class="rowColor">
2015-07-21 18:45:51 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="altColor">
2015-07-21 18:45:51 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="rowColor">
2015-07-21 18:45:51 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="altColor">
2015-07-21 18:45:51 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="rowColor">
2015-07-21 18:45:51 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="altColor">
2015-07-21 18:45:51 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="rowColor">
2015-07-31 08:11:32 +00:00
<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>
2015-09-10 22:23:51 +00:00
<tr class="altColor">
2015-07-31 08:11:32 +00:00
<td class="colFirst"><code>void</strong></code></td>
2015-08-14 16:06:49 +00:00
<td class="colLast"><code><strong><a href="#updateStageDirectory()">updateStageDirectory</a></strong>()</code><br>Update the staging directory and tasks responsible for setting it up</td>
2015-07-31 08:11:32 +00:00
</tr>
2015-07-21 18:45:51 +00:00
</table>
</ul>
</li>
2015-08-14 16:06:49 +00:00
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Inherited Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
<caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Methods inherited from class</th>
<th class="colLast" scope="col">Name</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class org.gradle.api.tasks.bundling.Jar</strong></code></td>
2015-09-10 22:23:51 +00:00
<td class="colLast"><code>org.gradle.api.tasks.bundling.Jar#setMetaClass(groovy.lang.MetaClass), org.gradle.api.tasks.bundling.Jar#getMetaClass(), org.gradle.api.tasks.bundling.Jar#super$1$notifyAll(), org.gradle.api.tasks.bundling.Jar#super$1$clone(), org.gradle.api.tasks.bundling.Jar#super$1$finalize(), org.gradle.api.tasks.bundling.Jar#super$1$equals(java.lang.Object), org.gradle.api.tasks.bundling.Jar#__$swapInit(), org.gradle.api.tasks.bundling.Jar#super$1$wait(), org.gradle.api.tasks.bundling.Jar#super$1$wait(long), org.gradle.api.tasks.bundling.Jar#super$1$wait(long, int), org.gradle.api.tasks.bundling.Jar#super$1$getClass(), org.gradle.api.tasks.bundling.Jar#super$1$hashCode(), org.gradle.api.tasks.bundling.Jar#super$1$notify(), org.gradle.api.tasks.bundling.Jar#super$2$onlyIf(groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$2$onlyIf(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Jar#super$2$setDependsOn(java.lang.Iterable), org.gradle.api.tasks.bundling.Jar#super$2$setProject(org.gradle.api.Project), org.gradle.api.tasks.bundling.Jar#super$5$from(java.lang.Object, groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$5$from([Ljava.lang.Object;), org.gradle.api.tasks.bundling.Jar#super$5$getMainSpec(), org.gradle.api.tasks.bundling.Jar#super$6$getDestinationDir(), org.gradle.api.tasks.bundling.Jar#super$2$addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.tasks.bundling.Jar#super$2$getConvention(), org.gradle.api.tasks.bundling.Jar#super$6$into(java.lang.Object), org.gradle.api.tasks.bundling.Jar#super$6$into(java.lang.Object, groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$2$getDependsOn(), org.gradle.api.tasks.bundling.Jar#super$5$filesNotMatching(java.lang.String, org.gradle.api.Action), org.gradle.api.tasks.bundling.Jar#super$7$getEntryCompression(), org.gradle.api.tasks.bundling.Jar#super$2$getName(), org.gradle.api.tasks.bundling.Jar#super$2$getMustRunAfter(), org.gradle.api.tasks.bundling.Jar#super$5$getDuplicatesStrategy(), org.gradle.api.tasks.bundling.Jar#super$5$getFileLookup(), org.gradle.api.tasks.bundling.Jar#super$2$getOnlyIf(), org.gradle.api.tasks.bundling.Jar#super$5$exclude([Ljava.lang.String;), org.gradle.api.tasks.bundling.Jar#super$5$exclude(java.lang.Iterable), org.gradle.api.tasks.bundling.Jar#super$5$exclude(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Jar#super$5$exclude(groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$2$getActions(), org.gradle.api.tasks.bundling.Jar#super$5$getSource(), org.gradle.api.tasks.bundling.Jar#super$2$getState(), org.gradle.api.tasks.bundling.Jar#super$2$setOnlyIf(groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$2$setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Jar#super$2$getTaskDependencies(), org.gradle.api.tasks.bundling.Jar#super$5$filesMatching(java.lang.String, org.gradle.api.Action), org.gradle.api.tasks.bundling.Jar#super$2$hasProperty(java.lang.String), org.gradle.api.tasks.bundling.Jar#super$6$getAppendix(), org.gradle.api.tasks.bundling.Jar#super$2$property(java.lang.String), org.gradle.api.tasks.bundling.Jar#super$6$getClassifier(), org.gradle.api.tasks.bundling.Jar#super$2$doFirst(groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$2$doFirst(org.gradle.api.Action), org.gradle.api.tasks.bundling.Jar#super$2$deleteAllActions(), org.gradle.api.tasks.bundling.Jar#super$4$conventionMapping(java.lang.String, groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$4$conventionMapping(java.lang.String, java.util.concurrent.Callable), org.gradle.api.tasks.bundling.Jar#super$5$setCaseSensitive(boolean), org.gradle.api.tasks.bundling.Jar#super$2$compareTo(org.gradle.api.Task), org.gradle.api.tasks.bundling.Jar#super$2$doLast(groovy.lang.Closure), org.gradle.api.tasks.bundling.Jar#super$2$doLast(org.gradle.api.Action), org.gradle.api.tasks.bundling.Jar#super$6$setClassifier(java.lang.String), org.gradle.api.tasks.bundling.Jar#super$5$expand(java.util.Map), org.gradle.api.tasks.
2015-08-14 16:06:49 +00:00
</tr>
<tr class="altColor">
<td class="colFirst"><code>class org.gradle.api.tasks.bundling.Zip</strong></code></td>
2015-09-10 22:23:51 +00:00
<td class="colLast"><code>org.gradle.api.tasks.bundling.Zip#getEntryCompression(), org.gradle.api.tasks.bundling.Zip#setEntryCompression(org.gradle.api.tasks.bundling.ZipEntryCompression), org.gradle.api.tasks.bundling.Zip#isZip64(), org.gradle.api.tasks.bundling.Zip#setZip64(boolean), org.gradle.api.tasks.bundling.Zip#setBaseName(java.lang.String), org.gradle.api.tasks.bundling.Zip#getBaseName(), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object, groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object, groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object, groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#into(java.lang.Object), org.gradle.api.tasks.bundling.Zip#getClassifier(), org.gradle.api.tasks.bundling.Zip#getArchiveName(), org.gradle.api.tasks.bundling.Zip#getDestinationDir(), org.gradle.api.tasks.bundling.Zip#setDestinationDir(java.io.File), org.gradle.api.tasks.bundling.Zip#setAppendix(java.lang.String), org.gradle.api.tasks.bundling.Zip#setExtension(java.lang.String), org.gradle.api.tasks.bundling.Zip#setArchiveName(java.lang.String), org.gradle.api.tasks.bundling.Zip#getArchivePath(), org.gradle.api.tasks.bundling.Zip#getAppendix(), org.gradle.api.tasks.bundling.Zip#setClassifier(java.lang.String), org.gradle.api.tasks.bundling.Zip#getVersion(), org.gradle.api.tasks.bundling.Zip#setVersion(java.lang.String), org.gradle.api.tasks.bundling.Zip#getExtension(), org.gradle.api.tasks.bundling.Zip#eachFile(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#eachFile(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#eachFile(org.gradle.api.Action), org.gradle.api.tasks.bundling.Zip#eachFile(org.gradle.api.Action), org.gradle.api.tasks.bundling.Zip#eachFile(org.gradle.api.Action), org.gradle.api.tasks.bundling.Zip#eachFile(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#include([Ljava.lang.String;), org.gradle.api.tasks.bundling.Zip#include(java.lang.Iterable), org.gradle.api.tasks.bundling.Zip#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Zip#include([Ljava.lang.String;), org.gradle.api.tasks.bundling.Zip#include(java.lang.Iterable), org.gradle.api.tasks.bundling.Zip#include(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Zip#include(java.lang.Iterable), org.gradle.api.tasks.bundling.Zip#include([Ljava.lang.String;), org.gradle.api.tasks.bundling.Zip#include(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#include(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Zip#include(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#exclude(java.lang.Iterable), org.gradle.api.tasks.bundling.Zip#exclude(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Zip#exclude(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#exclude(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Zip#exclude([Ljava.lang.String;), org.gradle.api.tasks.bundling.Zip#exclude(java.lang.Iterable), org.gradle.api.tasks.bundling.Zip#exclude(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#exclude(groovy.lang.Closure), org.gradle.api.tasks.bundling.Zip#exclude(org.gradle.api.specs.Spec), org.gradle.api.tasks.bundling.Zip#exclude([Ljava.lang.String;), org.gradle.api.tasks.bundling.Zip#exclude([Ljava.lang.String;), org.gradle.api.tasks.bundling.Zip#exclude(java.lang.Iterable), org.gradle.api.tasks.bundling.Zip#setIncludeEmptyDirs(boolean), org.gradle.api.tasks.bundling.Zip#getDuplicatesStrategy(), org.gradle.api.tasks.bundling.Zip#setDuplicatesStrategy(org.gradle.api.file.DuplicatesStrategy), org.gradle.api.tasks.bundling.Zip#filesMatching(java.lang.String, org.gradle.api.Action), org.gradle.api.tasks.bundling.Zip#filesMatching(java.lang.String, org.gradle.api.Action), org.gradle.api.tasks.bundling.Zip#filesNotMatching(java.lang.String, org.gradle.a
2015-08-14 16:06:49 +00:00
</tr>
</table>
</ul>
</li>
2015-07-21 18:45:51 +00:00
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2015-07-31 08:11:32 +00:00
<!-- =========== FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
2015-08-14 16:06:49 +00:00
<a name="customConfigName"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.String <strong>customConfigName</strong></h4>
<p></p>
</li>
</ul>
2015-07-31 08:11:32 +00:00
<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>
2015-09-10 22:23:51 +00:00
<a name="embeddedJRubyMainsVersion"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.String <strong>embeddedJRubyMainsVersion</strong></h4>
<p></p>
</li>
</ul>
<a name="embeddedJRubyVersion"><!-- --></a>
2015-07-31 08:11:32 +00:00
<ul class="blockListLast">
<li class="blockList">
2015-09-10 22:23:51 +00:00
<h4>protected&nbsp;java.lang.String <strong>embeddedJRubyVersion</strong></h4>
<p></p>
</li>
</ul>
<a name="jarConfiguration"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.String <strong>jarConfiguration</strong></h4>
<p></p>
</li>
</ul>
<a name="jarMainClass"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.lang.String <strong>jarMainClass</strong></h4>
2015-07-31 08:11:32 +00:00
<p></p>
</li>
</ul>
<a name="prepareTask"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
2015-08-14 16:06:49 +00:00
<h4>protected&nbsp;com.github.jrubygradle.JRubyPrepare <strong>prepareTask</strong></h4>
2015-07-31 08:11:32 +00:00
<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>
2015-07-21 18:45:51 +00:00
<!-- =========== PROPERTY DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="prop_detail">
<!-- -->
</a>
<h3>Property Detail</h3>
2015-07-31 08:11:32 +00:00
<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>
2015-08-07 15:24:54 +00:00
<a name="DEFAULT_JRUBY_MAINS"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>static&nbsp;final&nbsp;java.lang.String <strong>DEFAULT_JRUBY_MAINS</strong></h4>
<p></p>
</li>
</ul>
2015-07-21 18:45:51 +00:00
<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>
</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>
2015-08-14 16:06:49 +00:00
<a name="addEmbeddedDependencies(org.gradle.api.artifacts.Configuration)"><!-- --></a>
2015-07-21 18:45:51 +00:00
<ul class="blockListLast">
<li class="blockList">
2015-08-14 16:06:49 +00:00
<h4>void <strong>addEmbeddedDependencies</strong>(org.gradle.api.artifacts.Configuration config)</h4>
<p> Add the necessary JRuby dependencies to the specified <CODE>org.gradle.api.artifacts.Configuration</CODE> </p>
</li>
</ul>
<a name="addJRubyDependency()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>addJRubyDependency</strong>()</h4>
<p> Adds our jruby-complete to a custom configuration only so it can be
safely unzipped later when we build the jar
</p>
2015-07-21 18:45:51 +00:00
</li>
</ul>
2015-07-31 08:11:32 +00:00
<a name="applyConfig()"><!-- --></a>
2015-07-21 18:45:51 +00:00
<ul class="blockListLast">
<li class="blockList">
2015-07-31 08:11:32 +00:00
<h4>@groovy.transform.PackageScope
void <strong>applyConfig</strong>()</h4>
<p></p>
2015-07-21 18:45:51 +00:00
</li>
</ul>
<a name="defaultMainClass()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
2015-07-31 08:11:32 +00:00
<h4>void <strong>defaultMainClass</strong>()</h4>
2015-07-21 18:45:51 +00:00
<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">
2015-07-31 08:11:32 +00:00
<h4>void <strong>extractingMainClass</strong>()</h4>
2015-07-21 18:45:51 +00:00
<p> Makes the executable by adding a default main class
which extracts the jar to temporary directory
</p>
</li>
</ul>
2015-09-10 22:23:51 +00:00
<a name="getConfiguration()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@org.gradle.api.tasks.Input
@java.util.Optional
java.lang.String <strong>getConfiguration</strong>()</h4>
<p></p>
</li>
</ul>
2015-07-31 08:11:32 +00:00
<a name="getGemDir()"><!-- --></a>
2015-07-21 18:45:51 +00:00
<ul class="blockListLast">
<li class="blockList">
2015-07-31 08:11:32 +00:00
<h4>java.io.File <strong>getGemDir</strong>()</h4>
<p> Return the directory that the dependencies for this project will be staged into </p>
2015-07-21 18:45:51 +00:00
</li>
</ul>
2015-09-10 22:23:51 +00:00
<a name="getJrubyMainsVersion()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@org.gradle.api.tasks.Input
@java.util.Optional
java.lang.String <strong>getJrubyMainsVersion</strong>()</h4>
<p></p>
</li>
</ul>
2015-07-31 08:11:32 +00:00
<a name="getJrubyVersion()"><!-- --></a>
2015-07-21 18:45:51 +00:00
<ul class="blockListLast">
<li class="blockList">
2015-07-31 08:11:32 +00:00
<h4>java.lang.String <strong>getJrubyVersion</strong>()</h4>
2015-08-07 15:24:54 +00:00
<p> Return the project default unless set
The reason that this is defined as a getter instead of just setting
<CODE>jrubyVersion</CODE> at task construction-time is to ensure that if a user
modifies the jrubyVersion on the project after we have instantiated, that we still
respect this setting
</p>
2015-07-21 18:45:51 +00:00
</li>
</ul>
2015-09-10 22:23:51 +00:00
<a name="getMainClass()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@org.gradle.api.tasks.Input
java.lang.String <strong>getMainClass</strong>()</h4>
<p></p>
</li>
</ul>
2015-07-21 18:45:51 +00:00
<a name="initScript(java.lang.Object)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
2015-07-31 08:11:32 +00:00
<h4>void <strong>initScript</strong>(java.lang.Object scriptName)</h4>
2015-07-21 18:45:51 +00:00
<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">
2015-08-14 16:06:49 +00:00
<h4>@org.gradle.api.tasks.Input
2015-07-31 08:11:32 +00:00
void <strong>jrubyVersion</strong>(java.lang.String version)</h4>
2015-07-21 18:45:51 +00:00
<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">
2015-07-31 08:11:32 +00:00
<h4>void <strong>mainClass</strong>(java.lang.String className)</h4>
2015-07-21 18:45:51 +00:00
<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>
2015-07-31 08:11:32 +00:00
<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>
2015-08-14 16:06:49 +00:00
<a name="updateStageDirectory()"><!-- --></a>
2015-07-31 08:11:32 +00:00
<ul class="blockListLast">
<li class="blockList">
2015-08-14 16:06:49 +00:00
<h4>void <strong>updateStageDirectory</strong>()</h4>
<p> Update the staging directory and tasks responsible for setting it up </p>
2015-07-31 08:11:32 +00:00
</li>
</ul>
2015-07-21 18:45:51 +00:00
</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>
2015-07-31 08:11:32 +00:00
<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;
2015-07-21 18:45:51 +00:00
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
2015-07-31 08:11:32 +00:00
<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;
2015-07-21 18:45:51 +00:00
</ul>
</div>
<p>Groovy Documentation</p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>