512 lines
25 KiB
HTML
512 lines
25 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 Thu Sep 10 15:25:13 PDT 2015 -->
|
|
<title>JRubyExecTraits (jruby-gradle-base-plugin 1.1.0 API)</title>
|
|
<meta name="date" content="2015-09-10">
|
|
<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="JRubyExecTraits (jruby-gradle-base-plugin 1.1.0 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="../../../../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/internal/JRubyExecTraits" target="_top">Frames</a></li>
|
|
<li><a href="JRubyExecTraits.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested Field <li><a href="#property_summary">Property</a></li> <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#prop_detail">Property</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">Package: <strong>com.github.jrubygradle.internal</strong></div>
|
|
|
|
<h2 title="[Groovy] Trait JRubyExecTraits" class="title">[Groovy] Trait JRubyExecTraits</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.internal.JRubyExecTraits
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
|
|
|
|
<p> Provides common traits for JRuby script execution across the <CODE>JRubyExec</CODE>
|
|
task and {@project.jrubyexec} extension.
|
|
|
|
This trait is primarily meant as a plugin-internal interface/implementation which allows
|
|
for the asy set up and invocation of a JRuby environment unlike <CODE>JRubyExec</CODE>
|
|
it is not meant to directly set up or execute a Ruby script.
|
|
|
|
It's functions are primarily:
|
|
* Prepare Ruby gem dependencies
|
|
* Prepare JVm (jar) dependencies
|
|
* Set up the execution environment
|
|
|
|
After that, it is up to the actual subclass extending JRubyExecAbstractTask to
|
|
decide how it wants to execute JRuby
|
|
<DL><DT><B>Authors:</B></DT><DD>Schalk W. Cronjé</DD></DL><DL><DT><B>Since:</B></DT><DD>0.1.18</DD></DL></p>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== NESTED CLASS SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== 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"> </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>java.util.List<java.lang.String></strong></code> </td>
|
|
<td class="colLast"><code><a href="#FILTER_ENV_KEYS"></a>FILTER_ENV_KEYS</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><strong>boolean</strong></code> </td>
|
|
<td class="colLast"><code><a href="#inheritRubyEnv"></a>inheritRubyEnv</code><br>Allow JRubyExec to inherit a Ruby env from the shell (e.g. </td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<!-- =========== ELEMENT SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========== 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"> </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>java.io.File</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#_convertGemWorkDir(org.gradle.api.Project)">_convertGemWorkDir</a></strong>(org.gradle.api.Project project)</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.util.List<java.lang.String></strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#_convertJrubyArgs()">_convertJrubyArgs</a></strong>()</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.io.File</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#_convertScript()">_convertScript</a></strong>()</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.util.List<java.lang.String></strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#_convertScriptArgs()">_convertScriptArgs</a></strong>()</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#configuration(java.lang.String)">configuration</a></strong>(java.lang.String newConfiguration)</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#gemWorkDir(java.lang.Object)">gemWorkDir</a></strong>(java.lang.Object workingDir)</code><br>Set alternative GEM unpack directory to use</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#getComputedPATH(java.lang.String)">getComputedPATH</a></strong>(java.lang.String originalPath)</code><br>Return the computed `PATH` for the task</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<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="altColor">
|
|
<td class="colFirst"><code>java.io.File</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#getGemWorkDir()">getGemWorkDir</a></strong>()</code><br>Returns the directory that will be used to unpack Gems into</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.util.Map</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#getPreparedEnvironment(java.util.Map)">getPreparedEnvironment</a></strong>(java.util.Map env)</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#jrubyArgs(java.lang.Object)">jrubyArgs</a></strong>(java.lang.Object... args)</code><br>Add arguments for jruby</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#prepareDependencies(org.gradle.api.Project)">prepareDependencies</a></strong>(org.gradle.api.Project project)</code><br>Prepare the Ruby and Java dependencies for the configured configuration</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#prepareDependencies(org.gradle.api.Project, com.github.jrubygradle.GemUtils.OverwriteAction)">prepareDependencies</a></strong>(org.gradle.api.Project project, <a href='../../../../com/github/jrubygradle/GemUtils.OverwriteAction.html'>OverwriteAction</a> overwrite)</code><br>Prepare dependencies with a custom overwrite behavior</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#script(def)">script</a></strong>(java.lang.Object scr)</code><br>Set script to execute.</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#scriptArgs(java.lang.Object)">scriptArgs</a></strong>(java.lang.Object... args)</code><br>Add arguments for script</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#scriptArgs(groovy.lang.Closure)">scriptArgs</a></strong>(groovy.lang.Closure c)</code><br>Add arguments for script in a closure style</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#setScript(def)">setScript</a></strong>(java.lang.Object scr)</code><br>Set script to execute.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== PROPERTY DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="prop_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Property Detail</h3>
|
|
|
|
<a name="FILTER_ENV_KEYS"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>final java.util.List<java.lang.String> <strong>FILTER_ENV_KEYS</strong></h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="inheritRubyEnv"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@java.util.Optional
|
|
@org.gradle.api.tasks.Input
|
|
boolean <strong>inheritRubyEnv</strong></h4>
|
|
<p> Allow JRubyExec to inherit a Ruby env from the shell (e.g. RVM)
|
|
<DL><DT><B>Since:</B></DT><DD>0.1.10 (Moved from <CODE>JRubyExec</CODE>)</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== METHOD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
|
|
<a name="_convertGemWorkDir(org.gradle.api.Project)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>java.io.File <strong>_convertGemWorkDir</strong>(org.gradle.api.Project project)</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="_convertJrubyArgs()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@groovy.transform.CompileDynamic
|
|
java.util.List<java.lang.String> <strong>_convertJrubyArgs</strong>()</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="_convertScript()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>java.io.File <strong>_convertScript</strong>()</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="_convertScriptArgs()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@groovy.transform.CompileDynamic
|
|
java.util.List<java.lang.String> <strong>_convertScriptArgs</strong>()</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="configuration(java.lang.String)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@groovy.transform.CompileDynamic
|
|
void <strong>configuration</strong>(java.lang.String newConfiguration)</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="gemWorkDir(java.lang.Object)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>gemWorkDir</strong>(java.lang.Object workingDir)</h4>
|
|
<p> Set alternative GEM unpack directory to use
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>workingDir</code> - New working directory (convertible to file)</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="getComputedPATH(java.lang.String)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>java.lang.String <strong>getComputedPATH</strong>(java.lang.String originalPath)</h4>
|
|
<p> Return the computed `PATH` for the task </p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="getConfiguration()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@org.gradle.api.tasks.Input
|
|
java.lang.String <strong>getConfiguration</strong>()</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="getGemWorkDir()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@java.util.Optional
|
|
@org.gradle.api.tasks.Input
|
|
@groovy.transform.CompileDynamic
|
|
java.io.File <strong>getGemWorkDir</strong>()</h4>
|
|
<p> Returns the directory that will be used to unpack Gems into
|
|
<DL><DT><B>Returns:</B></DT><DD>Target directory</DD></DL><DL><DT><B>Since:</B></DT><DD>0.1.9</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="getPreparedEnvironment(java.util.Map)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>java.util.Map <strong>getPreparedEnvironment</strong>(java.util.Map env)</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="jrubyArgs(java.lang.Object)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>jrubyArgs</strong>(java.lang.Object... args)</h4>
|
|
<p> Add arguments for jruby
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>args</code> - Additional arguments to be passed to JRuby itself.</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="prepareDependencies(org.gradle.api.Project)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>prepareDependencies</strong>(org.gradle.api.Project project)</h4>
|
|
<p> Prepare the Ruby and Java dependencies for the configured configuration
|
|
|
|
This method will determine the appropriate dependency overwrite behavior
|
|
from the Gradle invocation. In effect, if the --refresh-dependencies flag
|
|
is used, already installed gems will be overwritten.
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>project</code> - The currently executing project</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="prepareDependencies(org.gradle.api.Project, com.github.jrubygradle.GemUtils.OverwriteAction)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>prepareDependencies</strong>(org.gradle.api.Project project, <a href='../../../../com/github/jrubygradle/GemUtils.OverwriteAction.html'>OverwriteAction</a> overwrite)</h4>
|
|
<p> Prepare dependencies with a custom overwrite behavior </p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="script(def)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>script</strong>(java.lang.Object scr)</h4>
|
|
<p> Set script to execute.
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>scr</code> - Path to script. Can be any object that is convertible to File.</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="scriptArgs(java.lang.Object)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>scriptArgs</strong>(java.lang.Object... args)</h4>
|
|
<p> Add arguments for script
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>args</code> - Arguments to be aqdded to script arguments</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="scriptArgs(groovy.lang.Closure)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>scriptArgs</strong>(groovy.lang.Closure c)</h4>
|
|
<p> Add arguments for script in a closure style
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>args</code> - Arguments to be aqdded to script arguments</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="setScript(def)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>setScript</strong>(java.lang.Object scr)</h4>
|
|
<p> Set script to execute.
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>scr</code> - Path to script. Can be any object that is convertible to File.</DD></DL></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/internal/JRubyExecTraits" target="_top">Frames</a></li>
|
|
<li><a href="JRubyExecTraits.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested Field <li><a href="#property_summary">Property</a></li> <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#prop_detail">Property</a></li> <li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<p>Groovy Documentation</p>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|