416 lines
23 KiB
HTML
416 lines
23 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>JRubyExecUtils (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="JRubyExecUtils (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/JRubyExecUtils" target="_top">Frames</a></li>
|
|
<li><a href="JRubyExecUtils.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> Constructor <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#prop_detail">Property</a></li> Constructor <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] Class JRubyExecUtils" class="title">[Groovy] Class JRubyExecUtils</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.internal.JRubyExecUtils
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
|
|
|
|
<p>
|
|
<DL><DT><B>Authors:</B></DT><DD>Schalk W. Cronjé.</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>static java.lang.String</strong></code> </td>
|
|
<td class="colLast"><code><a href="#DEFAULT_JRUBYEXEC_CONFIG"></a>DEFAULT_JRUBYEXEC_CONFIG</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><strong>static java.lang.String</strong></code> </td>
|
|
<td class="colLast"><code><a href="#JAR_DEPENDENCIES_VERSION"></a>JAR_DEPENDENCIES_VERSION</code><br></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>static java.util.List<java.lang.String></strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#buildArgs(List<Object>, java.io.File, List<Object>)">buildArgs</a></strong>(java.util.List<java.lang.Object> jrubyArgs, java.io.File script, java.util.List<java.lang.Object> scriptArgs)</code><br></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.util.List<java.lang.String></strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#buildArgs(List<Object>, List<Object>, java.io.File, List<Object>)">buildArgs</a></strong>(java.util.List<java.lang.Object> extra, java.util.List<java.lang.Object> jrubyArgs, java.io.File script, java.util.List<java.lang.Object> scriptArgs)</code><br>Construct the correct set of arguments based on the parameters to invoke jruby-complete.jar with</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.Object</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#classpathFromConfiguration(org.gradle.api.artifacts.Configuration)">classpathFromConfiguration</a></strong>(org.gradle.api.artifacts.Configuration cfg)</code><br>Extract a list of files from a configuration that is suitable for a jruby classpath</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.io.File</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#jrubyJar(org.gradle.api.artifacts.Configuration)">jrubyJar</a></strong>(org.gradle.api.artifacts.Configuration cfg)</code><br>Extract the jruby-complete-XXX.jar classpath</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static org.gradle.api.file.FileCollection</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#jrubyJar(org.gradle.api.file.FileCollection)">jrubyJar</a></strong>(org.gradle.api.file.FileCollection fc)</code><br>Extract the jruby-complete-XXX.jar as a FileCollection</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#jrubyJarVersion(java.io.File)">jrubyJarVersion</a></strong>(java.io.File jar)</code><br>Extracts the JRuby version number from a jruby-complete-XXX.jar filename</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.util.Map</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#jrubyJarVersionTriple(java.io.File)">jrubyJarVersionTriple</a></strong>(java.io.File jar)</code><br>Extracts the JRuby version number as a triplet from a jruby-complete-XXX.jar filename</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#pathVar()">pathVar</a></strong>()</code><br>Get the name of the system search path environmental variable</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#prepareWorkingPath(java.io.File, java.lang.String)">prepareWorkingPath</a></strong>(java.io.File gemWorkDir, java.lang.String originalPath)</code><br>Create a search path that includes the GEM working directory</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#updateJRubyDependenciesForConfiguration(org.gradle.api.Project, java.lang.String, java.lang.String)">updateJRubyDependenciesForConfiguration</a></strong>(org.gradle.api.Project project, java.lang.String configuration, java.lang.String version)</code><br>Update the given configuration on the project with the appropriate versions
|
|
of JRuby and supplemental dependencies to execute JRuby successfully</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
<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"> </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 java.lang.Object</strong></code></td>
|
|
<td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></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="DEFAULT_JRUBYEXEC_CONFIG"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static final java.lang.String <strong>DEFAULT_JRUBYEXEC_CONFIG</strong></h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="JAR_DEPENDENCIES_VERSION"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static final java.lang.String <strong>JAR_DEPENDENCIES_VERSION</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="buildArgs(List<Object>, java.io.File, List<Object>)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static java.util.List<java.lang.String> <strong>buildArgs</strong>(java.util.List<java.lang.Object> jrubyArgs, java.io.File script, java.util.List<java.lang.Object> scriptArgs)</h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="buildArgs(List<Object>, List<Object>, java.io.File, List<Object>)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static java.util.List<java.lang.String> <strong>buildArgs</strong>(java.util.List<java.lang.Object> extra, java.util.List<java.lang.Object> jrubyArgs, java.io.File script, java.util.List<java.lang.Object> scriptArgs)</h4>
|
|
<p> Construct the correct set of arguments based on the parameters to invoke jruby-complete.jar with
|
|
<DL><DT><B>Returns:</B></DT><DD>sequential list of arguments to pass jruby-complete.jar</DD></DL><DL><DT><B>Parameters:</B></DT><DD>extra</DD><DD>jrubyArgs</DD><DD>script</DD><DD>scriptArgs</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="classpathFromConfiguration(org.gradle.api.artifacts.Configuration)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static java.lang.Object <strong>classpathFromConfiguration</strong>(org.gradle.api.artifacts.Configuration cfg)</h4>
|
|
<p> Extract a list of files from a configuration that is suitable for a jruby classpath <DL><DT><B>Returns:</B></DT><DD></DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>cfg</code> - Configuration to use</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="jrubyJar(org.gradle.api.artifacts.Configuration)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static java.io.File <strong>jrubyJar</strong>(org.gradle.api.artifacts.Configuration cfg)</h4>
|
|
<p> Extract the jruby-complete-XXX.jar classpath
|
|
<DL><DT><B>Returns:</B></DT><DD>Returns the classpath as a File or null if the jar was not found</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>cfg</code> - Configuration</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="jrubyJar(org.gradle.api.file.FileCollection)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static org.gradle.api.file.FileCollection <strong>jrubyJar</strong>(org.gradle.api.file.FileCollection fc)</h4>
|
|
<p> Extract the jruby-complete-XXX.jar as a FileCollection
|
|
<DL><DT><B>Returns:</B></DT><DD>Returns the classpath as a File or null if the jar was not found</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>cfg</code> - FileCollection</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="jrubyJarVersion(java.io.File)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@groovy.transform.CompileDynamic
|
|
static java.lang.String <strong>jrubyJarVersion</strong>(java.io.File jar)</h4>
|
|
<p> Extracts the JRuby version number from a jruby-complete-XXX.jar filename
|
|
<DL><DT><B>Returns:</B></DT><DD>Version string or null</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>jar</code> - JRuby Jar</DD></DL><DL><DT><B>Since:</B></DT><DD>0.1.9</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="jrubyJarVersionTriple(java.io.File)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>@groovy.transform.CompileDynamic
|
|
static java.util.Map <strong>jrubyJarVersionTriple</strong>(java.io.File jar)</h4>
|
|
<p> Extracts the JRuby version number as a triplet from a jruby-complete-XXX.jar filename
|
|
<DL><DT><B>Returns:</B></DT><DD>Version string map [major,minor,patchlevel] or null</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>jar</code> - JRuby Jar</DD></DL><DL><DT><B>Since:</B></DT><DD>0.1.16</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="pathVar()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static java.lang.String <strong>pathVar</strong>()</h4>
|
|
<p> Get the name of the system search path environmental variable
|
|
<DL><DT><B>Returns:</B></DT><DD>Name of variable</DD></DL><DL><DT><B>Since:</B></DT><DD>0.1.11</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="prepareWorkingPath(java.io.File, java.lang.String)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static java.lang.String <strong>prepareWorkingPath</strong>(java.io.File gemWorkDir, java.lang.String originalPath)</h4>
|
|
<p> Create a search path that includes the GEM working directory
|
|
<DL><DT><B>Returns:</B></DT><DD>A search suitable for the specific operating system the job will run on</DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>gemWorkDir</code> - GEM work dir instance</DD><DD><code>originalPath</code> - The original platform-specific search path</DD></DL><DL><DT><B>Since:</B></DT><DD>0.1.11</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="updateJRubyDependenciesForConfiguration(org.gradle.api.Project, java.lang.String, java.lang.String)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>static void <strong>updateJRubyDependenciesForConfiguration</strong>(org.gradle.api.Project project, java.lang.String configuration, java.lang.String version)</h4>
|
|
<p> Update the given configuration on the project with the appropriate versions
|
|
of JRuby and supplemental dependencies to execute JRuby successfully
|
|
</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/JRubyExecUtils" target="_top">Frames</a></li>
|
|
<li><a href="JRubyExecUtils.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> Constructor <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
Field <li><a href="#prop_detail">Property</a></li> Constructor <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>
|