425 lines
20 KiB
HTML
425 lines
20 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 Tue Aug 15 11:41:10 PDT 2017 -->
|
|
<title>JRubyDirInfoTransformer (jruby-gradle-jar-plugin 1.5.0)</title>
|
|
<meta name="date" content="2017-08-15">
|
|
<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="JRubyDirInfoTransformer (jruby-gradle-jar-plugin 1.5.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/internal/JRubyDirInfoTransformer" target="_top">Frames</a></li>
|
|
<li><a href="JRubyDirInfoTransformer.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested <li><a href="#field_summary">Field</a></li> <li><a href="#constructor_summary">Constructor</a></li> <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
<li><a href="#field_detail">Field</a></li> <li><a href="#constructor_detail">Constructor</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.jar.internal</strong></div>
|
|
|
|
<h2 title="[Groovy] Class JRubyDirInfoTransformer" class="title">[Groovy] Class JRubyDirInfoTransformer</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.jar.internal.JRubyDirInfoTransformer
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
|
|
<dl>
|
|
<dt>All Implemented Interfaces and Traits:</dt>
|
|
<dd>com.github.jengelman.gradle.plugins.shadow.transformers.Transformer</dd>
|
|
</dl>
|
|
<!-- todo: direct known subclasses -->
|
|
<hr>
|
|
<br>
|
|
<pre>@java.lang.SuppressWarnings('UnusedMethodParameter')
|
|
class JRubyDirInfoTransformer
|
|
extends java.lang.Object
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
<p> JRubyDirInfoTransformer implements a com.github.jengelman.gradle.plugins.shadow.transformers.Transformer interface.
|
|
|
|
This is internal primarily because it rewrequires an interaction with the
|
|
transformer interface inside of the shadow plugin, which will hopefully go
|
|
away at some point in the future
|
|
</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== NESTED CLASS SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== 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"> </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 <a href='../../../../../com/github/jrubygradle/jar/internal/JRubyDirInfo.html'>JRubyDirInfo</a></strong></code> </td>
|
|
<td class="colLast"><code><a href="#info">info</a></code></td>
|
|
<td class="colLast"></code></td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><strong>protected java.io.File</strong></code> </td>
|
|
<td class="colLast"><code><a href="#tmpDir">tmpDir</a></code></td>
|
|
<td class="colLast"></code></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<!-- =========== PROPERTY SUMMARY =========== -->
|
|
|
|
|
|
<!-- =========== 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"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor and description</th>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst">
|
|
<code><a href="#JRubyDirInfoTransformer()">JRubyDirInfoTransformer</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"> </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>boolean</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#canTransformResource(org.gradle.api.file.FileTreeElement)">canTransformResource</a></strong>(org.gradle.api.file.FileTreeElement element)</code><br>Register the relative path of the <CODE>element</CODE> that will be jarred.</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#deleteTempDirectory(java.io.File)">deleteTempDirectory</a></strong>(java.io.File directory)</code><br>Recursively delete the given java.io.File</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#hasTransformedResource()">hasTransformedResource</a></strong>()</code><br>Confirm that we've done some work so our <CODE>modifyOutputStream</CODE> is called</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#modifyOutputStream(org.apache.tools.zip.ZipOutputStream)">modifyOutputStream</a></strong>(org.apache.tools.zip.ZipOutputStream os)</code><br>Process the output stream and add our .jrubydir entries.</td>
|
|
</tr>
|
|
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#processDirectory(org.apache.tools.zip.ZipOutputStream, java.io.File)">processDirectory</a></strong>(org.apache.tools.zip.ZipOutputStream stream, java.io.File directory)</code><br>Process the directory given and ensure that all our .jrubydir files are added.</td>
|
|
</tr>
|
|
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</strong></code></td>
|
|
<td class="colLast"><code><strong><a href="#transform(java.lang.String, java.io.InputStream, List<Relocator>)">transform</a></strong>(java.lang.String path, java.io.InputStream is, java.util.List<com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> relocators)</code><br>No-op since we don't transform the actual file</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">
|
|
|
|
|
|
|
|
<!-- =========== FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
|
|
<a name="info"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>protected <a href='../../../../../com/github/jrubygradle/jar/internal/JRubyDirInfo.html'>JRubyDirInfo</a> <strong>info</strong></h4>
|
|
<p></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="tmpDir"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>protected java.io.File <strong>tmpDir</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="JRubyDirInfoTransformer()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4><strong>JRubyDirInfoTransformer</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="canTransformResource(org.gradle.api.file.FileTreeElement)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>boolean <strong>canTransformResource</strong>(org.gradle.api.file.FileTreeElement element)</h4>
|
|
<p> Register the relative path of the <CODE>element</CODE> that will be jarred.
|
|
|
|
Since this transformer is just performing book-keeping, it returns false
|
|
to avoid telling the machinery in shadow to transform the actual file
|
|
being visited and jarred up
|
|
<DL><DT><B>Returns:</B></DT><DD>false</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="deleteTempDirectory(java.io.File)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>protected void <strong>deleteTempDirectory</strong>(java.io.File directory)</h4>
|
|
<p> Recursively delete the given java.io.File </p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="hasTransformedResource()"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>boolean <strong>hasTransformedResource</strong>()</h4>
|
|
<p> Confirm that we've done some work so our <CODE>modifyOutputStream</CODE> is called
|
|
<DL><DT><B>Returns:</B></DT><DD>true</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="modifyOutputStream(org.apache.tools.zip.ZipOutputStream)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>modifyOutputStream</strong>(org.apache.tools.zip.ZipOutputStream os)</h4>
|
|
<p> Process the output stream and add our .jrubydir entries.
|
|
|
|
This method will also clean up our tempdir to make sure we don't
|
|
clutter the user's machine with junk
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="processDirectory(org.apache.tools.zip.ZipOutputStream, java.io.File)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>protected void <strong>processDirectory</strong>(org.apache.tools.zip.ZipOutputStream stream, java.io.File directory)</h4>
|
|
<p> Process the directory given and ensure that all our .jrubydir files are added.
|
|
<DL><DT><B>Parameters:</B></DT><DD><code>stream</code> - org.apache.tools.zip.ZipOutputStream for our archive being built</DD><DD><code>directory</code> - Directory which contains our .jrubydir files to be
|
|
copied</DD></DL></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<a name="transform(java.lang.String, java.io.InputStream, List<Relocator>)"><!-- --></a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>void <strong>transform</strong>(java.lang.String path, java.io.InputStream is, java.util.List<com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> relocators)</h4>
|
|
<p> No-op since we don't transform the actual file </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/internal/JRubyDirInfoTransformer" target="_top">Frames</a></li>
|
|
<li><a href="JRubyDirInfoTransformer.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
Nested <li><a href="#field_summary">Field</a></li> <li><a href="#constructor_summary">Constructor</a></li> <li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li> | Detail: </li>
|
|
<li><a href="#field_detail">Field</a></li> <li><a href="#constructor_detail">Constructor</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>
|