Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
Sat Apr 20 14:51:39 2024
@@ -1,591 +1,388 @@
<!DOCTYPE HTML>
-<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc -->
-<title>CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.8.1
API)</title>
+<!-- Generated by javadoc (17) -->
+<title>CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.8.2
API)</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta name="description" content="declaration: package:
org.apache.commons.release.plugin.mojos, class: CommonsSiteCompressionMojo">
+<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css"
title="Style">
-<link rel="stylesheet" type="text/css"
href="../../../../../../jquery/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css"
href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css"
href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
-<script type="text/javascript"
src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
-<script type="text/javascript"
src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
-<!--[if IE]>
-<script type="text/javascript"
src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
-<![endif]-->
-<script type="text/javascript"
src="../../../../../../jquery/jquery-3.6.1.min.js"></script>
-<script type="text/javascript"
src="../../../../../../jquery/jquery-ui.min.js"></script>
+<script type="text/javascript"
src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
+<script type="text/javascript"
src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
-<body>
-<script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CommonsSiteCompressionMojo (Apache Commons
Release Plugin 1.8.1 API)";
- }
- }
- catch(err) {
- }
-//-->
-var data = {"i0":42,"i1":42,"i2":42,"i3":42};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
-var altColor = "altColor";
-var rowColor = "rowColor";
-var tableTab = "tableTab";
-var activeTableTab = "activeTableTab";
+<body class="class-declaration-page">
+<script type="text/javascript">var evenRowColor = "even-row-color";
+var oddRowColor = "odd-row-color";
+var tableTab = "table-tab";
+var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
-var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
-<header role="banner">
+<div class="flex-box">
+<header role="banner" class="flex-header">
<nav role="navigation">
-<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a id="navbar.top">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation
links">Skip navigation links</a></div>
-<a id="navbar.top.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
+<div class="top-nav" id="navbar-top">
+<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation
links">Skip navigation links</a></div>
+<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
+<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/CommonsSiteCompressionMojo.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></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>
+<li><a href="../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
-<div class="subNav">
-<ul class="navList" id="allclasses_navbar_top">
-<li><a href="../../../../../../allclasses.html">All Classes</a></li>
-</ul>
-<ul class="navListSearch">
-<li><label for="search">SEARCH:</label>
-<input type="text" id="search" value="search" disabled="disabled">
-<input type="reset" id="reset" value="reset" disabled="disabled">
-</li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
-</div>
+<div class="sub-nav">
<div>
-<ul class="subNavList">
+<ul class="sub-nav-list">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field.summary">Field</a> | </li>
-<li><a href="#constructor.summary">Constr</a> | </li>
-<li><a href="#method.summary">Method</a></li>
+<li><a href="#field-summary">Field</a> | </li>
+<li><a href="#constructor-summary">Constr</a> | </li>
+<li><a href="#method-summary">Method</a></li>
</ul>
-<ul class="subNavList">
+<ul class="sub-nav-list">
<li>Detail: </li>
-<li><a href="#field.detail">Field</a> | </li>
-<li><a href="#constructor.detail">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
+<li><a href="#field-detail">Field</a> | </li>
+<li><a href="#constructor-detail">Constr</a> | </li>
+<li><a href="#method-detail">Method</a></li>
</ul>
</div>
-<a id="skip.navbar.top">
-<!-- -->
-</a></div>
-<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="nav-list-search"><label for="search-input">SEARCH:</label>
+<input type="text" id="search-input" value="search" disabled="disabled">
+<input type="reset" id="reset-button" value="reset" disabled="disabled">
+</div>
</div>
-<div class="navPadding"> </div>
-<script type="text/javascript"><!--
-$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
-//-->
-</script>
-</nav>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
-<!-- ======== START OF CLASS DATA ======== -->
+<div class="flex-content">
<main role="main">
+<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
-<div class="subTitle"><span class="packageLabelInType">Package</span> <a
href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div>
-<h2 title="Class CommonsSiteCompressionMojo" class="title">Class
CommonsSiteCompressionMojo</h2>
+<div class="sub-title"><span
class="package-label-in-type">Package</span> <a
href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div>
+<h1 title="Class CommonsSiteCompressionMojo" class="title">Class
CommonsSiteCompressionMojo</h1>
</div>
-<div class="contentContainer">
-<ul class="inheritance">
-<li><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang"
class="externalLink">java.lang.Object</a></li>
-<li>
-<ul class="inheritance">
-<li>org.apache.maven.plugin.AbstractMojo</li>
-<li>
-<ul class="inheritance">
-<li>org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-<div class="description">
-<ul class="blockList">
-<li class="blockList">
-<dl>
+<div class="inheritance" title="Inheritance Tree"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"
title="class or interface in java.lang"
class="external-link">java.lang.Object</a>
+<div class="inheritance">org.apache.maven.plugin.AbstractMojo
+<div
class="inheritance">org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</div>
+</div>
+</div>
+<section class="class-description" id="class-description">
+<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>org.apache.maven.plugin.ContextEnabled</code>,
<code>org.apache.maven.plugin.Mojo</code></dd>
</dl>
<hr>
-<pre><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"
title="class or interface in java.lang" class="externalLink">@Deprecated</a>
+<div class="type-signature"><span class="annotations"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html"
title="class or interface in java.lang" class="external-link">@Deprecated</a>
@Mojo(name="compress-site",
defaultPhase=POST_SITE,
threadSafe=true,
aggregator=true)
-public class <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.46">CommonsSiteCompressionMojo</a>
-extends org.apache.maven.plugin.AbstractMojo</pre>
-<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
-<div class="deprecationComment">- as we no longer wish to compress the site,
we are going to put this functionality in the
+</span><span class="modifiers">public class </span><span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-46">CommonsSiteCompressionMojo</a></span>
+<span class="extends-implements">extends
org.apache.maven.plugin.AbstractMojo</span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span>
+<div class="deprecation-comment">- as we no longer wish to compress the site,
we are going to put this functionality in the
<a href="CommonsDistributionStagingMojo.html" title="class in
org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div>
</div>
<div class="block">Takes the built <code>./target/site</code> directory and
compresses it to
<code>./target/commons-release-plugin/site.zip</code>.</div>
-<dl>
-<dt><span class="simpleTagLabel">Since:</span></dt>
+<dl class="notes">
+<dt>Since:</dt>
<dd>1.0</dd>
</dl>
-</li>
-</ul>
-</div>
-<div class="summary">
-<ul class="blockList">
-<li class="blockList">
+</section>
+<section class="summary">
+<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="field.summary">
-<!-- -->
-</a>
-<h3>Field Summary</h3>
-<table class="memberSummary">
-<caption><span>Fields</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colSecond" scope="col">Field</th>
-<th class="colLast" scope="col">Description</th>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#distSvnStagingUrl">distSvnStagingUrl</a></span></code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+<li>
+<section class="field-summary" id="field-summary">
+<h2>Field Summary</h2>
+<div class="caption"><span>Fields</span></div>
+<div class="summary-table three-column-summary">
+<div class="table-header col-first">Modifier and Type</div>
+<div class="table-header col-second">Field</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#distSvnStagingUrl"
class="member-name-link">distSvnStagingUrl</a></code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util" class="externalLink">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a>></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#filesToCompress">filesToCompress</a></span></code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a>></code></div>
+<div class="col-second odd-row-color"><code><a href="#filesToCompress"
class="member-name-link">filesToCompress</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">The list of files to compress into the site.zip file.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"
title="class or interface in java.lang"
class="externalLink">Boolean</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#isDistModule">isDistModule</a></span></code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html"
title="class or interface in java.lang"
class="external-link">Boolean</a></code></div>
+<div class="col-second even-row-color"><code><a href="#isDistModule"
class="member-name-link">isDistModule</a></code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">A parameter to generally avoid running unless it is
specifically turned on by the consuming module.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#siteDirectory">siteDirectory</a></span></code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#workingDirectory">workingDirectory</a></span></code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#siteDirectory"
class="member-name-link">siteDirectory</a></code></div>
+<div class="col-last odd-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+ </div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second even-row-color"><code><a href="#workingDirectory"
class="member-name-link">workingDirectory</a></code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">The working directory for the plugin which, assuming the
maven uses the default
<code>${project.build.directory}</code>, this becomes
<code>target/commons-release-plugin</code>.</div>
-</td>
-</tr>
-</table>
-<ul class="blockList">
-<li class="blockList"><a
id="fields.inherited.from.class.org.apache.maven.plugin.Mojo">
-<!-- -->
-</a>
-<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3>
-<code>ROLE</code></li>
-</ul>
-</li>
-</ul>
+</div>
+</div>
+<div class="inherited-list">
+<h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields
inherited from interface org.apache.maven.plugin.Mojo</h3>
+<code>ROLE</code></div>
</section>
-<!-- ======== CONSTRUCTOR SUMMARY ======== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="constructor.summary">
-<!-- -->
-</a>
-<h3>Constructor Summary</h3>
-<table class="memberSummary">
-<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Constructor</th>
-<th class="colLast" scope="col">Description</th>
-</tr>
-<tr class="altColor">
-<th class="colConstructorName" scope="row"><code><span
class="memberNameLink"><a
href="#%3Cinit%3E()">CommonsSiteCompressionMojo</a></span>()</code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </td>
-</tr>
-</table>
</li>
-</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<li>
+<section class="constructor-summary" id="constructor-summary">
+<h2>Constructor Summary</h2>
+<div class="caption"><span>Constructors</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Constructor</div>
+<div class="table-header col-last">Description</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()"
class="member-name-link">CommonsSiteCompressionMojo</a>()</code></div>
+<div class="col-last even-row-color">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+ </div>
+</div>
</section>
+</li>
<!-- ========== METHOD SUMMARY =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="method.summary">
-<!-- -->
-</a>
-<h3>Method Summary</h3>
-<table class="memberSummary">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span
class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a
href="javascript:show(32);">Deprecated Methods</a></span><span
class="tabEnd"> </span></span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colSecond" scope="col">Method</th>
-<th class="colLast" scope="col">Description</th>
-</tr>
-<tr id="i0" class="altColor">
-<td class="colFirst"><code>private void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)">addToZip</a></span>​(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> directoryToZip,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a> file,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html?is-external=true"
title="class or interface in java.util.zip"
class="externalLink">ZipOutputStream</a> zos)</code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+<li>
+<section class="method-summary" id="method-summary">
+<h2>Method Summary</h2>
+<div id="method-summary-table">
+<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button
id="method-summary-table-tab0" role="tab" aria-selected="true"
aria-controls="method-summary-table.tabpanel" tabindex="0"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table', 3)" class="active-table-tab">All
Methods</button><button id="method-summary-table-tab2" role="tab"
aria-selected="false" aria-controls="method-summary-table.tabpanel"
tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab2', 3)"
class="table-tab">Instance Methods</button><button
id="method-summary-table-tab4" role="tab" aria-selected="false"
aria-controls="method-summary-table.tabpanel" tabindex="-1"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table-tab4', 3)" class="table-tab">Concrete
Methods</button><button id="method-summary-table-tab6" role="tab"
aria-selected="false" aria-controls="method-summary-table.
tabpanel" tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab6', 3)"
class="table-tab">Deprecated Methods</button></div>
+<div id="method-summary-table.tabpanel" role="tabpanel">
+<div class="summary-table three-column-summary"
aria-labelledby="method-summary-table-tab0">
+<div class="table-header col-first">Modifier and Type</div>
+<div class="table-header col-second">Method</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code>private void</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code><a
href="#addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)"
class="member-name-link">addToZip</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"
title="class or interface in java.io" class="external-link">File</a> file,
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html"
title="class or interface in java.util.zip"
class="external-link">ZipOutputStream</a> zos)</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Given the <code>directoryToZip</code> we add the
<code>file</code> to the ZIP archive represented by
<code>zos</code>.</div>
-</td>
-</tr>
-<tr id="i1" class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#execute()">execute</a></span>()</code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
- </td>
-</tr>
-<tr id="i2" class="altColor">
-<td class="colFirst"><code>private void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#getAllSiteFiles(java.io.File,java.util.List)">getAllSiteFiles</a></span>​(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> siteDirectory,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util" class="externalLink">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a>> filesToCompress)</code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code>void</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code><a href="#execute()"
class="member-name-link">execute</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
+ </div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code>private void</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code><a
href="#getAllSiteFiles(java.io.File,java.util.List)"
class="member-name-link">getAllSiteFiles</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a> siteDirectory,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io"
class="external-link">File</a>> filesToCompress)</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">By default this method iterates across the
<code>target/site</code> directory and adds all the files
- to the <a href="#filesToCompress"><code>filesToCompress</code></a> <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util"
class="externalLink"><code>List</code></a>.</div>
-</td>
-</tr>
-<tr id="i3" class="rowColor">
-<td class="colFirst"><code>private void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#writeZipFile(java.io.File,java.io.File,java.util.List)">writeZipFile</a></span>​(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> outputDirectory,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> directoryToZip,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util" class="externalLink">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a>> fileList)</code></th>
-<td class="colLast">
-<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+ to the <a href="#filesToCompress"><code>filesToCompress</code></a> <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util"
class="external-link"><code>List</code></a>.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code>private void</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4
method-summary-table-tab6"><code><a
href="#writeZipFile(java.io.File,java.io.File,java.util.List)"
class="member-name-link">writeZipFile</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a> outputDirectory,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"
title="class or interface in java.io"
class="external-link">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io"
class="external-link">File</a>> fileList)</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
+<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">A helper method for writing all the files in our
<code>fileList</code> to a <code>site.zip</code> file
in the <code>workingDirectory</code>.</div>
-</td>
-</tr>
-</table>
-<ul class="blockList">
-<li class="blockList"><a
id="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
-<!-- -->
-</a>
-<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3>
-<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
-</ul>
-<ul class="blockList">
-<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
-<!-- -->
-</a>
-<h3>Methods inherited from class java.lang.<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang" class="externalLink">Object</a></h3>
-<code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang" class="externalLink">clone</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang" class="externalLink">equals</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang" class="externalLink">finalize</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang" class="externalLink">getClass</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang" class="externalLink">hashCode</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang" class="externalLink">notify</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()"
title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang" class="externalLink">toString</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang" class="externalLink">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)"
title="class or interface in java.lang" class="externalLink">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)"
title="class or interface in java.lang"
class="externalLink">wait</a></code></li>
-</ul>
-</li>
-</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="inherited-list">
+<h3
id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods
inherited from class org.apache.maven.plugin.AbstractMojo</h3>
+<code>getLog, getPluginContext, setLog, setPluginContext</code></div>
+<div class="inherited-list">
+<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from
class java.lang.<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"
title="class or interface in java.lang" class="external-link">Object</a></h3>
+<code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--"
title="class or interface in java.lang" class="external-link">clone</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-"
title="class or interface in java.lang" class="external-link">equals</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--"
title="class or interface in java.lang" class="external-link">finalize</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--"
title="class or interface in java.lang" class="external-link">getClass</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--"
title="class or interface in java.lang" class="external-link">hashCode</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--"
title="class or interface in java.lang" class="external-link">notify</a>, <a
href="https://docs.o
racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or
interface in java.lang" class="external-link">notifyAll</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--"
title="class or interface in java.lang" class="external-link">toString</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--"
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-"
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-"
title="class or interface in java.lang"
class="external-link">wait</a></code></div>
</section>
</li>
</ul>
-</div>
-<div class="details">
-<ul class="blockList">
-<li class="blockList">
+</section>
+<section class="details">
+<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="field.detail">
-<!-- -->
-</a>
-<h3>Field Detail</h3>
-<a id="workingDirectory">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>workingDirectory</h4>
-<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
+<li>
+<section class="field-details" id="field-detail">
+<h2>Field Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="workingDirectory">
+<h3>workingDirectory</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
property="commons.outputDirectory")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.57">workingDirectory</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-57">workingDirectory</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">The working directory for the plugin which, assuming the
maven uses the default
<code>${project.build.directory}</code>, this becomes
<code>target/commons-release-plugin</code>.</div>
+</section>
</li>
-</ul>
-<a id="siteDirectory">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>siteDirectory</h4>
-<pre>@Parameter(defaultValue="${project.build.directory}/site",
+<li>
+<section class="detail" id="siteDirectory">
+<h3>siteDirectory</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${project.build.directory}/site",
property="commons.siteOutputDirectory")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.63">siteDirectory</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-63">siteDirectory</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
+</section>
</li>
-</ul>
-<a id="distSvnStagingUrl">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>distSvnStagingUrl</h4>
-<pre>@Parameter(defaultValue="",
+<li>
+<section class="detail" id="distSvnStagingUrl">
+<h3>distSvnStagingUrl</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="",
property="commons.distSvnStagingUrl")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.72">distSvnStagingUrl</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-72">distSvnStagingUrl</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged. Typically
this would need to be of the form:
<code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>.
Note. that the prefix to the
substring <code>https</code> is a requirement.</div>
+</section>
</li>
-</ul>
-<a id="isDistModule">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>isDistModule</h4>
-<pre>@Parameter(defaultValue="false",
+<li>
+<section class="detail" id="isDistModule">
+<h3>isDistModule</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="false",
property="commons.release.isDistModule")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true"
title="class or interface in java.lang" class="externalLink">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.78">isDistModule</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html"
title="class or interface in java.lang"
class="external-link">Boolean</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-78">isDistModule</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">A parameter to generally avoid running unless it is
specifically turned on by the consuming module.</div>
+</section>
</li>
-</ul>
-<a id="filesToCompress">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>filesToCompress</h4>
-<pre>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util" class="externalLink">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.84">filesToCompress</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+<li>
+<section class="detail" id="filesToCompress">
+<h3>filesToCompress</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a>></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-84">filesToCompress</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">The list of files to compress into the site.zip file.</div>
-</li>
-</ul>
+</section>
</li>
</ul>
</section>
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="constructor.detail">
-<!-- -->
-</a>
-<h3>Constructor Detail</h3>
-<a id="<init>()">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>CommonsSiteCompressionMojo</h4>
-<pre>public <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.51">CommonsSiteCompressionMojo</a>()</pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
</li>
-</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<li>
+<section class="constructor-details" id="constructor-detail">
+<h2>Constructor Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="<init>()">
+<h3>CommonsSiteCompressionMojo</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-51">CommonsSiteCompressionMojo</a></span>()</div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
+</section>
</li>
</ul>
</section>
+</li>
<!-- ============ METHOD DETAIL ========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="method.detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a id="execute()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>execute</h4>
-<pre class="methodSignature">public void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.86">execute</a>()
- throws org.apache.maven.plugin.MojoExecutionException,
- org.apache.maven.plugin.MojoFailureException</pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
-<dl>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<li>
+<section class="method-details" id="method-detail">
+<h2>Method Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="execute()">
+<h3>execute</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-86">execute</a></span>()
+ throws <span
class="exceptions">org.apache.maven.plugin.MojoExecutionException,
+org.apache.maven.plugin.MojoFailureException</span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
+<dl class="notes">
+<dt>Throws:</dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
</dl>
+</section>
</li>
-</ul>
-<a id="getAllSiteFiles(java.io.File,java.util.List)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getAllSiteFiles</h4>
-<pre class="methodSignature">private void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.127">getAllSiteFiles</a>​(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> siteDirectory,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util" class="externalLink">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a>> filesToCompress)</pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+<li>
+<section class="detail" id="getAllSiteFiles(java.io.File,java.util.List)">
+<h3>getAllSiteFiles</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-127">getAllSiteFiles</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a> siteDirectory,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io"
class="external-link">File</a>> filesToCompress)</span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">By default this method iterates across the
<code>target/site</code> directory and adds all the files
- to the <a href="#filesToCompress"><code>filesToCompress</code></a> <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util"
class="externalLink"><code>List</code></a>.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>siteDirectory</code> - the <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink"><code>File</code></a> that represents the
<code>target/site</code> directory.</dd>
-<dd><code>filesToCompress</code> - the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util"
class="externalLink"><code>List</code></a> to which to add all the files.</dd>
+ to the <a href="#filesToCompress"><code>filesToCompress</code></a> <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util"
class="external-link"><code>List</code></a>.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>siteDirectory</code> - the <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link"><code>File</code></a> that
represents the <code>target/site</code> directory.</dd>
+<dd><code>filesToCompress</code> - the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util"
class="external-link"><code>List</code></a> to which to add all the files.</dd>
</dl>
+</section>
</li>
-</ul>
-<a id="writeZipFile(java.io.File,java.io.File,java.util.List)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>writeZipFile</h4>
-<pre class="methodSignature">private void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.148">writeZipFile</a>​(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> outputDirectory,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> directoryToZip,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"
title="class or interface in java.util" class="externalLink">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a>> fileList)
- throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io"
class="externalLink">IOException</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+<li>
+<section class="detail"
id="writeZipFile(java.io.File,java.io.File,java.util.List)">
+<h3>writeZipFile</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-148">writeZipFile</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a> outputDirectory,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"
title="class or interface in java.io"
class="external-link">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"
title="class or interface in java.util" class="external-link">List</a><<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io"
class="external-link">File</a>> fileList)</span>
+ throws <span class="exceptions"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"
title="class or interface in java.io"
class="external-link">IOException</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">A helper method for writing all the files in our
<code>fileList</code> to a <code>site.zip</code> file
in the <code>workingDirectory</code>.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>outputDirectory</code> - is a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink"><code>File</code></a> representing the place to put the
site.zip file.</dd>
-<dd><code>directoryToZip</code> - is a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink"><code>File</code></a> representing the directory of the
site (normally
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>outputDirectory</code> - is a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link"><code>File</code></a>
representing the place to put the site.zip file.</dd>
+<dd><code>directoryToZip</code> - is a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link"><code>File</code></a>
representing the directory of the site (normally
<code>target/site</code>).</dd>
<dd><code>fileList</code> - the list of files to be zipped up, generally
generated by
<a
href="#getAllSiteFiles(java.io.File,java.util.List)"><code>getAllSiteFiles(File,
List)</code></a>.</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io"
class="externalLink">IOException</a></code> - when the copying of the files
goes incorrectly.</dd>
+<dt>Throws:</dt>
+<dd><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"
title="class or interface in java.io"
class="external-link">IOException</a></code> - when the copying of the files
goes incorrectly.</dd>
</dl>
+</section>
</li>
-</ul>
-<a id="addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>addToZip</h4>
-<pre class="methodSignature">private void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.171">addToZip</a>​(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink">File</a> directoryToZip,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io" class="externalLink">File</a> file,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html?is-external=true"
title="class or interface in java.util.zip"
class="externalLink">ZipOutputStream</a> zos)
- throws <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io"
class="externalLink">IOException</a></pre>
-<div class="deprecationBlock"><span
class="deprecatedLabel">Deprecated.</span></div>
+<li>
+<section class="detail"
id="addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)">
+<h3>addToZip</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line-171">addToZip</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"
title="class or interface in java.io" class="external-link">File</a> file,
+ <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html"
title="class or interface in java.util.zip"
class="external-link">ZipOutputStream</a> zos)</span>
+ throws <span class="exceptions"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"
title="class or interface in java.io"
class="external-link">IOException</a></span></div>
+<div class="deprecation-block"><span
class="deprecated-label">Deprecated.</span></div>
<div class="block">Given the <code>directoryToZip</code> we add the
<code>file</code> to the ZIP archive represented by
<code>zos</code>.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>directoryToZip</code> - a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink"><code>File</code></a> representing the directory from
which the file exists that we are
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>directoryToZip</code> - a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link"><code>File</code></a>
representing the directory from which the file exists that we are
compressing. Generally this is
<code>target/site</code>.</dd>
-<dd><code>file</code> - a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"
title="class or interface in java.io"
class="externalLink"><code>File</code></a> to add to the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html?is-external=true"
title="class or interface in java.util.zip"
class="externalLink"><code>ZipOutputStream</code></a> <code>zos</code>.</dd>
-<dd><code>zos</code> - the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html?is-external=true"
title="class or interface in java.util.zip"
class="externalLink"><code>ZipOutputStream</code></a> to which to add our
<code>file</code>.</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"
title="class or interface in java.io"
class="externalLink">IOException</a></code> - if adding the <code>file</code>
doesn't work out properly.</dd>
+<dd><code>file</code> - a <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class
or interface in java.io" class="external-link"><code>File</code></a> to add to
the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html"
title="class or interface in java.util.zip"
class="external-link"><code>ZipOutputStream</code></a> <code>zos</code>.</dd>
+<dd><code>zos</code> - the <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/zip/ZipOutputStream.html"
title="class or interface in java.util.zip"
class="external-link"><code>ZipOutputStream</code></a> to which to add our
<code>file</code>.</dd>
+<dt>Throws:</dt>
+<dd><code><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html"
title="class or interface in java.io"
class="external-link">IOException</a></code> - if adding the <code>file</code>
doesn't work out properly.</dd>
</dl>
-</li>
-</ul>
+</section>
</li>
</ul>
</section>
</li>
</ul>
-</div>
-</div>
-</main>
+</section>
<!-- ========= END OF CLASS DATA ========= -->
+</main>
<footer role="contentinfo">
-<nav role="navigation">
-<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a id="navbar.bottom">
-<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation
links">Skip navigation links</a></div>
-<a id="navbar.bottom.firstrow">
-<!-- -->
-</a>
-<ul class="navList" title="Navigation">
-<li><a href="../../../../../../index.html">Overview</a></li>
-<li><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
-<li><a href="class-use/CommonsSiteCompressionMojo.html">Use</a></li>
-<li><a href="package-tree.html">Tree</a></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>
+<hr>
+<p class="legal-copy"><small>Copyright © 2018–2024 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
+</footer>
</div>
-<div class="subNav">
-<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../../../allclasses.html">All Classes</a></li>
-</ul>
-<div>
-<script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
-</script>
-<noscript>
-<div>JavaScript is disabled on your browser.</div>
-</noscript>
</div>
-<div>
-<ul class="subNavList">
-<li>Summary: </li>
-<li>Nested | </li>
-<li><a href="#field.summary">Field</a> | </li>
-<li><a href="#constructor.summary">Constr</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">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
-</ul>
-</div>
-<a id="skip.navbar.bottom">
-<!-- -->
-</a></div>
-<!-- ======== END OF BOTTOM NAVBAR ======= -->
-</nav>
-<p class="legalCopy"><small>Copyright © 2018–2023 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</small></p>
-</footer>
</body>
</html>
\ No newline at end of file