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

335 lines
16 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:12 PDT 2017 -->
<title>JRubyJarCopyAction (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="JRubyJarCopyAction (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/JRubyJarCopyAction" target="_top">Frames</a></li>
<li><a href="JRubyJarCopyAction.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;Field&nbsp;&nbsp;&nbsp;&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>
Field&nbsp;&nbsp;&nbsp;&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.internal</strong></div>
<h2 title="[Groovy] Class JRubyJarCopyAction" class="title">[Groovy] Class JRubyJarCopyAction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li>com.github.jrubygradle.jar.internal.JRubyJarCopyAction
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces and Traits:</dt>
<dd>org.gradle.api.internal.file.copy.CopyAction</dd>
</dl>
<!-- todo: direct known subclasses -->
<hr>
<br>
<pre>@groovy.util.logging.Slf4j
@java.lang.SuppressWarnings(['ParameterCount', 'CatchException', 'DuplicateStringLiteral',
'CatchThrowable', 'VariableName'])
class JRubyJarCopyAction
extends java.lang.Object
</pre>
<p> JRubyJarCopyAction is an implementation of the org.gradle.api.internal.file.copy.CopyAction interface for mutating the JRubyJar archive.
This class, in its current form is really just a big copy and paste of the
shadow plugin's <a
href="https://github.com/johnrengelman/shadow/blob/51f2b5916edd7690dca5e89e8b3a8f330d435423/src/main/groovy/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowCopyAction.groovy">ShadowCopyAction</a>.
with one notable exception, it disables the behavior of unzipping nested
archives when creating the resulting archive.
This class is only intended to be used with the <a href='../../../../../com/github/jrubygradle/jar/internal/JRubyDirInfoTransformer.html' title='JRubyDirInfoTransformer'>JRubyDirInfoTransformer</a> until such a time when this can be refactored to
support the same behavior in a less hackish way.
</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>class</strong></code>&nbsp;</td>
<td class="colLast"><code><a href='../../../../../com/github/jrubygradle/jar/internal/JRubyJarCopyAction.ArchiveFileTreeElement.html'>JRubyJarCopyAction.ArchiveFileTreeElement</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>class</strong></code>&nbsp;</td>
<td class="colLast"><code><a href='../../../../../com/github/jrubygradle/jar/internal/JRubyJarCopyAction.RelativeArchivePath.html'>JRubyJarCopyAction.RelativeArchivePath</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>class</strong></code>&nbsp;</td>
<td class="colLast"><code><a href='../../../../../com/github/jrubygradle/jar/internal/JRubyJarCopyAction.StreamAction.html'>JRubyJarCopyAction.StreamAction</a></code></td>
<td class="colLast"></code></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== 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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor and description</th>
</tr>
<tr class="altColor">
<td class="colFirst">
<code><a href="#JRubyJarCopyAction(java.io.File, com.github.jengelman.gradle.plugins.shadow.internal.ZipCompressor, org.gradle.api.internal.DocumentationRegistry, List<Transformer>, List<Relocator>, org.gradle.api.tasks.util.PatternSet)">JRubyJarCopyAction</a></strong>
(java.io.File zipFile, com.github.jengelman.gradle.plugins.shadow.internal.ZipCompressor compressor, org.gradle.api.internal.DocumentationRegistry documentationRegistry, java.util.List&lt;com.github.jengelman.gradle.plugins.shadow.transformers.Transformer&gt; transformers, java.util.List&lt;com.github.jengelman.gradle.plugins.shadow.relocation.Relocator&gt; relocators, org.gradle.api.tasks.util.PatternSet patternSet)</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>org.gradle.api.tasks.WorkResult</strong></code></td>
<td class="colLast"><code><strong><a href="#execute(org.gradle.api.internal.file.copy.CopyActionProcessingStream)">execute</a></strong>(org.gradle.api.internal.file.copy.CopyActionProcessingStream stream)</code><br></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">&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 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">
<!-- =========== CONSTRUCTOR DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JRubyJarCopyAction(java.io.File, com.github.jengelman.gradle.plugins.shadow.internal.ZipCompressor, org.gradle.api.internal.DocumentationRegistry, List<Transformer>, List<Relocator>, org.gradle.api.tasks.util.PatternSet)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><strong>JRubyJarCopyAction</strong>(java.io.File zipFile, com.github.jengelman.gradle.plugins.shadow.internal.ZipCompressor compressor, org.gradle.api.internal.DocumentationRegistry documentationRegistry, java.util.List&lt;com.github.jengelman.gradle.plugins.shadow.transformers.Transformer&gt; transformers, java.util.List&lt;com.github.jengelman.gradle.plugins.shadow.relocation.Relocator&gt; relocators, org.gradle.api.tasks.util.PatternSet patternSet)</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="execute(org.gradle.api.internal.file.copy.CopyActionProcessingStream)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@java.lang.Override
org.gradle.api.tasks.WorkResult <strong>execute</strong>(org.gradle.api.internal.file.copy.CopyActionProcessingStream stream)</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/internal/JRubyJarCopyAction" target="_top">Frames</a></li>
<li><a href="JRubyJarCopyAction.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;Field&nbsp;&nbsp;&nbsp;&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>
Field&nbsp;&nbsp;&nbsp;&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>