You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/06/25 19:04:10 UTC
svn commit: r62638 [14/39] - in /dev/commons/release-plugin/1.8.1-RC1: ./ binaries/ site/ site/apidocs/ site/apidocs/jquery/ site/apidocs/jquery/external/ site/apidocs/jquery/external/jquery/ site/apidocs/jquery/jszip-utils/ site/apidocs/jquery/jszip-u...
Added: dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added)
+++ dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Sun Jun 25 19:04:09 2023
@@ -0,0 +1,257 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
+<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
+<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">008</span><a id="line.8"> *</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">010</span><a id="line.10"> *</a>
+<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
+<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
+<span class="sourceLineNo">016</span><a id="line.16"> */</a>
+<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin.mojos;</a>
+<span class="sourceLineNo">018</span><a id="line.18"></a>
+<span class="sourceLineNo">019</span><a id="line.19">import java.io.File;</a>
+<span class="sourceLineNo">020</span><a id="line.20">import java.io.IOException;</a>
+<span class="sourceLineNo">021</span><a id="line.21">import java.io.InputStream;</a>
+<span class="sourceLineNo">022</span><a id="line.22">import java.io.OutputStream;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import java.nio.file.Files;</a>
+<span class="sourceLineNo">024</span><a id="line.24">import java.util.ArrayList;</a>
+<span class="sourceLineNo">025</span><a id="line.25">import java.util.List;</a>
+<span class="sourceLineNo">026</span><a id="line.26">import java.util.zip.ZipEntry;</a>
+<span class="sourceLineNo">027</span><a id="line.27">import java.util.zip.ZipOutputStream;</a>
+<span class="sourceLineNo">028</span><a id="line.28"></a>
+<span class="sourceLineNo">029</span><a id="line.29">import org.apache.commons.io.IOUtils;</a>
+<span class="sourceLineNo">030</span><a id="line.30">import org.apache.commons.lang3.StringUtils;</a>
+<span class="sourceLineNo">031</span><a id="line.31">import org.apache.maven.plugin.AbstractMojo;</a>
+<span class="sourceLineNo">032</span><a id="line.32">import org.apache.maven.plugin.MojoExecutionException;</a>
+<span class="sourceLineNo">033</span><a id="line.33">import org.apache.maven.plugin.MojoFailureException;</a>
+<span class="sourceLineNo">034</span><a id="line.34">import org.apache.maven.plugins.annotations.LifecyclePhase;</a>
+<span class="sourceLineNo">035</span><a id="line.35">import org.apache.maven.plugins.annotations.Mojo;</a>
+<span class="sourceLineNo">036</span><a id="line.36">import org.apache.maven.plugins.annotations.Parameter;</a>
+<span class="sourceLineNo">037</span><a id="line.37"></a>
+<span class="sourceLineNo">038</span><a id="line.38">/**</a>
+<span class="sourceLineNo">039</span><a id="line.39"> * Takes the built <code>./target/site</code> directory and compresses it to</a>
+<span class="sourceLineNo">040</span><a id="line.40"> * <code>./target/commons-release-plugin/site.zip</code>.</a>
+<span class="sourceLineNo">041</span><a id="line.41"> *</a>
+<span class="sourceLineNo">042</span><a id="line.42"> * @since 1.0</a>
+<span class="sourceLineNo">043</span><a id="line.43"> * @deprecated - as we no longer wish to compress the site, we are going to put this functionality in the</a>
+<span class="sourceLineNo">044</span><a id="line.44"> * {@link CommonsDistributionStagingMojo}.</a>
+<span class="sourceLineNo">045</span><a id="line.45"> */</a>
+<span class="sourceLineNo">046</span><a id="line.46">@Deprecated</a>
+<span class="sourceLineNo">047</span><a id="line.47">@Mojo(name = "compress-site",</a>
+<span class="sourceLineNo">048</span><a id="line.48"> defaultPhase = LifecyclePhase.POST_SITE,</a>
+<span class="sourceLineNo">049</span><a id="line.49"> threadSafe = true,</a>
+<span class="sourceLineNo">050</span><a id="line.50"> aggregator = true)</a>
+<span class="sourceLineNo">051</span><a id="line.51">public class CommonsSiteCompressionMojo extends AbstractMojo {</a>
+<span class="sourceLineNo">052</span><a id="line.52"></a>
+<span class="sourceLineNo">053</span><a id="line.53"> /**</a>
+<span class="sourceLineNo">054</span><a id="line.54"> * The working directory for the plugin which, assuming the maven uses the default</a>
+<span class="sourceLineNo">055</span><a id="line.55"> * <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</a>
+<span class="sourceLineNo">056</span><a id="line.56"> */</a>
+<span class="sourceLineNo">057</span><a id="line.57"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin",</a>
+<span class="sourceLineNo">058</span><a id="line.58"> property = "commons.outputDirectory")</a>
+<span class="sourceLineNo">059</span><a id="line.59"> private File workingDirectory;</a>
+<span class="sourceLineNo">060</span><a id="line.60"></a>
+<span class="sourceLineNo">061</span><a id="line.61"> /**</a>
+<span class="sourceLineNo">062</span><a id="line.62"> */</a>
+<span class="sourceLineNo">063</span><a id="line.63"> @Parameter(defaultValue = "${project.build.directory}/site", property = "commons.siteOutputDirectory")</a>
+<span class="sourceLineNo">064</span><a id="line.64"> private File siteDirectory;</a>
+<span class="sourceLineNo">065</span><a id="line.65"></a>
+<span class="sourceLineNo">066</span><a id="line.66"> /**</a>
+<span class="sourceLineNo">067</span><a id="line.67"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically</a>
+<span class="sourceLineNo">068</span><a id="line.68"> * this would need to be of the form:</a>
+<span class="sourceLineNo">069</span><a id="line.69"> * <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the</a>
+<span class="sourceLineNo">070</span><a id="line.70"> * substring <code>https</code> is a requirement.</a>
+<span class="sourceLineNo">071</span><a id="line.71"> */</a>
+<span class="sourceLineNo">072</span><a id="line.72"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</a>
+<span class="sourceLineNo">073</span><a id="line.73"> private String distSvnStagingUrl;</a>
+<span class="sourceLineNo">074</span><a id="line.74"></a>
+<span class="sourceLineNo">075</span><a id="line.75"> /**</a>
+<span class="sourceLineNo">076</span><a id="line.76"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</a>
+<span class="sourceLineNo">077</span><a id="line.77"> */</a>
+<span class="sourceLineNo">078</span><a id="line.78"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</a>
+<span class="sourceLineNo">079</span><a id="line.79"> private Boolean isDistModule;</a>
+<span class="sourceLineNo">080</span><a id="line.80"></a>
+<span class="sourceLineNo">081</span><a id="line.81"> /**</a>
+<span class="sourceLineNo">082</span><a id="line.82"> * The list of files to compress into the site.zip file.</a>
+<span class="sourceLineNo">083</span><a id="line.83"> */</a>
+<span class="sourceLineNo">084</span><a id="line.84"> private List<File> filesToCompress;</a>
+<span class="sourceLineNo">085</span><a id="line.85"></a>
+<span class="sourceLineNo">086</span><a id="line.86"> @Override</a>
+<span class="sourceLineNo">087</span><a id="line.87"> public void execute() throws MojoExecutionException, MojoFailureException {</a>
+<span class="sourceLineNo">088</span><a id="line.88"> if (!isDistModule) {</a>
+<span class="sourceLineNo">089</span><a id="line.89"> getLog().info("This module is marked as a non distribution "</a>
+<span class="sourceLineNo">090</span><a id="line.90"> + "or assembly module, and the plugin will not run.");</a>
+<span class="sourceLineNo">091</span><a id="line.91"> return;</a>
+<span class="sourceLineNo">092</span><a id="line.92"> }</a>
+<span class="sourceLineNo">093</span><a id="line.93"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</a>
+<span class="sourceLineNo">094</span><a id="line.94"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</a>
+<span class="sourceLineNo">095</span><a id="line.95"> return;</a>
+<span class="sourceLineNo">096</span><a id="line.96"> }</a>
+<span class="sourceLineNo">097</span><a id="line.97"> if (!siteDirectory.exists()) {</a>
+<span class="sourceLineNo">098</span><a id="line.98"> getLog().error("\"mvn site\" was not run before this goal, or a siteDirectory did not exist.");</a>
+<span class="sourceLineNo">099</span><a id="line.99"> throw new MojoFailureException(</a>
+<span class="sourceLineNo">100</span><a id="line.100"> "\"mvn site\" was not run before this goal, or a siteDirectory did not exist."</a>
+<span class="sourceLineNo">101</span><a id="line.101"> );</a>
+<span class="sourceLineNo">102</span><a id="line.102"> }</a>
+<span class="sourceLineNo">103</span><a id="line.103"> if (!workingDirectory.exists()) {</a>
+<span class="sourceLineNo">104</span><a id="line.104"> getLog().info("Current project contains no distributions. Not executing.");</a>
+<span class="sourceLineNo">105</span><a id="line.105"> return;</a>
+<span class="sourceLineNo">106</span><a id="line.106"> }</a>
+<span class="sourceLineNo">107</span><a id="line.107"> try {</a>
+<span class="sourceLineNo">108</span><a id="line.108"> filesToCompress = new ArrayList<>();</a>
+<span class="sourceLineNo">109</span><a id="line.109"> getAllSiteFiles(siteDirectory, filesToCompress);</a>
+<span class="sourceLineNo">110</span><a id="line.110"> writeZipFile(workingDirectory, siteDirectory, filesToCompress);</a>
+<span class="sourceLineNo">111</span><a id="line.111"> } catch (final IOException e) {</a>
+<span class="sourceLineNo">112</span><a id="line.112"> getLog().error("Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(), e);</a>
+<span class="sourceLineNo">113</span><a id="line.113"> throw new MojoExecutionException(</a>
+<span class="sourceLineNo">114</span><a id="line.114"> "Failed to create ./target/commons-release-plugin/site.zip: " + e.getMessage(),</a>
+<span class="sourceLineNo">115</span><a id="line.115"> e</a>
+<span class="sourceLineNo">116</span><a id="line.116"> );</a>
+<span class="sourceLineNo">117</span><a id="line.117"> }</a>
+<span class="sourceLineNo">118</span><a id="line.118"> }</a>
+<span class="sourceLineNo">119</span><a id="line.119"></a>
+<span class="sourceLineNo">120</span><a id="line.120"> /**</a>
+<span class="sourceLineNo">121</span><a id="line.121"> * By default this method iterates across the <code>target/site</code> directory and adds all the files</a>
+<span class="sourceLineNo">122</span><a id="line.122"> * to the {@link CommonsSiteCompressionMojo#filesToCompress} {@link List}.</a>
+<span class="sourceLineNo">123</span><a id="line.123"> *</a>
+<span class="sourceLineNo">124</span><a id="line.124"> * @param siteDirectory the {@link File} that represents the <code>target/site</code> directory.</a>
+<span class="sourceLineNo">125</span><a id="line.125"> * @param filesToCompress the {@link List} to which to add all the files.</a>
+<span class="sourceLineNo">126</span><a id="line.126"> */</a>
+<span class="sourceLineNo">127</span><a id="line.127"> private void getAllSiteFiles(final File siteDirectory, final List<File> filesToCompress) {</a>
+<span class="sourceLineNo">128</span><a id="line.128"> final File[] files = siteDirectory.listFiles();</a>
+<span class="sourceLineNo">129</span><a id="line.129"> for (final File file : files) {</a>
+<span class="sourceLineNo">130</span><a id="line.130"> filesToCompress.add(file);</a>
+<span class="sourceLineNo">131</span><a id="line.131"> if (file.isDirectory()) {</a>
+<span class="sourceLineNo">132</span><a id="line.132"> getAllSiteFiles(file, filesToCompress);</a>
+<span class="sourceLineNo">133</span><a id="line.133"> }</a>
+<span class="sourceLineNo">134</span><a id="line.134"> }</a>
+<span class="sourceLineNo">135</span><a id="line.135"> }</a>
+<span class="sourceLineNo">136</span><a id="line.136"></a>
+<span class="sourceLineNo">137</span><a id="line.137"> /**</a>
+<span class="sourceLineNo">138</span><a id="line.138"> * A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file</a>
+<span class="sourceLineNo">139</span><a id="line.139"> * in the <code>workingDirectory</code>.</a>
+<span class="sourceLineNo">140</span><a id="line.140"> *</a>
+<span class="sourceLineNo">141</span><a id="line.141"> * @param outputDirectory is a {@link File} representing the place to put the site.zip file.</a>
+<span class="sourceLineNo">142</span><a id="line.142"> * @param directoryToZip is a {@link File} representing the directory of the site (normally</a>
+<span class="sourceLineNo">143</span><a id="line.143"> * <code>target/site</code>).</a>
+<span class="sourceLineNo">144</span><a id="line.144"> * @param fileList the list of files to be zipped up, generally generated by</a>
+<span class="sourceLineNo">145</span><a id="line.145"> * {@link CommonsSiteCompressionMojo#getAllSiteFiles(File, List)}.</a>
+<span class="sourceLineNo">146</span><a id="line.146"> * @throws IOException when the copying of the files goes incorrectly.</a>
+<span class="sourceLineNo">147</span><a id="line.147"> */</a>
+<span class="sourceLineNo">148</span><a id="line.148"> private void writeZipFile(final File outputDirectory, final File directoryToZip, final List<File> fileList)</a>
+<span class="sourceLineNo">149</span><a id="line.149"> throws IOException {</a>
+<span class="sourceLineNo">150</span><a id="line.150"> try (OutputStream fos = Files.newOutputStream(new File(outputDirectory.getAbsolutePath() + "/site.zip")</a>
+<span class="sourceLineNo">151</span><a id="line.151"> .toPath());</a>
+<span class="sourceLineNo">152</span><a id="line.152"> ZipOutputStream zos = new ZipOutputStream(fos)) {</a>
+<span class="sourceLineNo">153</span><a id="line.153"> for (final File file : fileList) {</a>
+<span class="sourceLineNo">154</span><a id="line.154"> if (!file.isDirectory()) { // we only ZIP files, not directories</a>
+<span class="sourceLineNo">155</span><a id="line.155"> addToZip(directoryToZip, file, zos);</a>
+<span class="sourceLineNo">156</span><a id="line.156"> }</a>
+<span class="sourceLineNo">157</span><a id="line.157"> }</a>
+<span class="sourceLineNo">158</span><a id="line.158"> }</a>
+<span class="sourceLineNo">159</span><a id="line.159"> }</a>
+<span class="sourceLineNo">160</span><a id="line.160"></a>
+<span class="sourceLineNo">161</span><a id="line.161"> /**</a>
+<span class="sourceLineNo">162</span><a id="line.162"> * Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by</a>
+<span class="sourceLineNo">163</span><a id="line.163"> * <code>zos</code>.</a>
+<span class="sourceLineNo">164</span><a id="line.164"> *</a>
+<span class="sourceLineNo">165</span><a id="line.165"> * @param directoryToZip a {@link File} representing the directory from which the file exists that we are</a>
+<span class="sourceLineNo">166</span><a id="line.166"> * compressing. Generally this is <code>target/site</code>.</a>
+<span class="sourceLineNo">167</span><a id="line.167"> * @param file a {@link File} to add to the {@link ZipOutputStream} <code>zos</code>.</a>
+<span class="sourceLineNo">168</span><a id="line.168"> * @param zos the {@link ZipOutputStream} to which to add our <code>file</code>.</a>
+<span class="sourceLineNo">169</span><a id="line.169"> * @throws IOException if adding the <code>file</code> doesn't work out properly.</a>
+<span class="sourceLineNo">170</span><a id="line.170"> */</a>
+<span class="sourceLineNo">171</span><a id="line.171"> private void addToZip(final File directoryToZip, final File file, final ZipOutputStream zos) throws IOException {</a>
+<span class="sourceLineNo">172</span><a id="line.172"> try (InputStream fis = Files.newInputStream(file.toPath())) {</a>
+<span class="sourceLineNo">173</span><a id="line.173"> // we want the zipEntry's path to be a relative path that is relative</a>
+<span class="sourceLineNo">174</span><a id="line.174"> // to the directory being zipped, so chop off the rest of the path</a>
+<span class="sourceLineNo">175</span><a id="line.175"> final String zipFilePath = file.getCanonicalPath().substring(</a>
+<span class="sourceLineNo">176</span><a id="line.176"> directoryToZip.getCanonicalPath().length() + 1,</a>
+<span class="sourceLineNo">177</span><a id="line.177"> file.getCanonicalPath().length());</a>
+<span class="sourceLineNo">178</span><a id="line.178"> final ZipEntry zipEntry = new ZipEntry(zipFilePath);</a>
+<span class="sourceLineNo">179</span><a id="line.179"> zos.putNextEntry(zipEntry);</a>
+<span class="sourceLineNo">180</span><a id="line.180"> IOUtils.copy(fis, zos);</a>
+<span class="sourceLineNo">181</span><a id="line.181"> }</a>
+<span class="sourceLineNo">182</span><a id="line.182"> }</a>
+<span class="sourceLineNo">183</span><a id="line.183">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
Added: dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html
==============================================================================
--- dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html (added)
+++ dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html Sun Jun 25 19:04:09 2023
@@ -0,0 +1,276 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
+<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
+<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">008</span><a id="line.8"> *</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">010</span><a id="line.10"> *</a>
+<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
+<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
+<span class="sourceLineNo">016</span><a id="line.16"> */</a>
+<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin.mojos;</a>
+<span class="sourceLineNo">018</span><a id="line.18"></a>
+<span class="sourceLineNo">019</span><a id="line.19">import org.apache.commons.lang3.StringUtils;</a>
+<span class="sourceLineNo">020</span><a id="line.20">import org.apache.commons.release.plugin.SharedFunctions;</a>
+<span class="sourceLineNo">021</span><a id="line.21">import org.apache.maven.plugin.AbstractMojo;</a>
+<span class="sourceLineNo">022</span><a id="line.22">import org.apache.maven.plugin.MojoExecutionException;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import org.apache.maven.plugin.MojoFailureException;</a>
+<span class="sourceLineNo">024</span><a id="line.24">import org.apache.maven.plugins.annotations.Component;</a>
+<span class="sourceLineNo">025</span><a id="line.25">import org.apache.maven.plugins.annotations.LifecyclePhase;</a>
+<span class="sourceLineNo">026</span><a id="line.26">import org.apache.maven.plugins.annotations.Mojo;</a>
+<span class="sourceLineNo">027</span><a id="line.27">import org.apache.maven.plugins.annotations.Parameter;</a>
+<span class="sourceLineNo">028</span><a id="line.28">import org.apache.maven.project.MavenProject;</a>
+<span class="sourceLineNo">029</span><a id="line.29">import org.apache.maven.scm.ScmException;</a>
+<span class="sourceLineNo">030</span><a id="line.30">import org.apache.maven.scm.ScmFileSet;</a>
+<span class="sourceLineNo">031</span><a id="line.31">import org.apache.maven.scm.command.checkin.CheckInScmResult;</a>
+<span class="sourceLineNo">032</span><a id="line.32">import org.apache.maven.scm.command.checkout.CheckOutScmResult;</a>
+<span class="sourceLineNo">033</span><a id="line.33">import org.apache.maven.scm.command.remove.RemoveScmResult;</a>
+<span class="sourceLineNo">034</span><a id="line.34">import org.apache.maven.scm.manager.BasicScmManager;</a>
+<span class="sourceLineNo">035</span><a id="line.35">import org.apache.maven.scm.manager.ScmManager;</a>
+<span class="sourceLineNo">036</span><a id="line.36">import org.apache.maven.scm.provider.ScmProvider;</a>
+<span class="sourceLineNo">037</span><a id="line.37">import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;</a>
+<span class="sourceLineNo">038</span><a id="line.38">import org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;</a>
+<span class="sourceLineNo">039</span><a id="line.39">import org.apache.maven.scm.repository.ScmRepository;</a>
+<span class="sourceLineNo">040</span><a id="line.40">import org.apache.maven.settings.Settings;</a>
+<span class="sourceLineNo">041</span><a id="line.41">import org.apache.maven.settings.crypto.SettingsDecrypter;</a>
+<span class="sourceLineNo">042</span><a id="line.42"></a>
+<span class="sourceLineNo">043</span><a id="line.43">import java.io.File;</a>
+<span class="sourceLineNo">044</span><a id="line.44">import java.util.Arrays;</a>
+<span class="sourceLineNo">045</span><a id="line.45">import java.util.List;</a>
+<span class="sourceLineNo">046</span><a id="line.46"></a>
+<span class="sourceLineNo">047</span><a id="line.47">/**</a>
+<span class="sourceLineNo">048</span><a id="line.48"> * This class checks out the dev distribution location, checks whether anything exists in the</a>
+<span class="sourceLineNo">049</span><a id="line.49"> * distribution location, and if it is non-empty it deletes all the resources there.</a>
+<span class="sourceLineNo">050</span><a id="line.50"> *</a>
+<span class="sourceLineNo">051</span><a id="line.51"> * @since 1.6</a>
+<span class="sourceLineNo">052</span><a id="line.52"> */</a>
+<span class="sourceLineNo">053</span><a id="line.53">@Mojo(name = "clean-staging",</a>
+<span class="sourceLineNo">054</span><a id="line.54"> defaultPhase = LifecyclePhase.POST_CLEAN,</a>
+<span class="sourceLineNo">055</span><a id="line.55"> threadSafe = true,</a>
+<span class="sourceLineNo">056</span><a id="line.56"> aggregator = true)</a>
+<span class="sourceLineNo">057</span><a id="line.57">public class CommonsStagingCleanupMojo extends AbstractMojo {</a>
+<span class="sourceLineNo">058</span><a id="line.58"></a>
+<span class="sourceLineNo">059</span><a id="line.59"> /**</a>
+<span class="sourceLineNo">060</span><a id="line.60"> * The {@link MavenProject} object is essentially the context of the maven build at</a>
+<span class="sourceLineNo">061</span><a id="line.61"> * a given time.</a>
+<span class="sourceLineNo">062</span><a id="line.62"> */</a>
+<span class="sourceLineNo">063</span><a id="line.63"> @Parameter(defaultValue = "${project}", required = true)</a>
+<span class="sourceLineNo">064</span><a id="line.64"> private MavenProject project;</a>
+<span class="sourceLineNo">065</span><a id="line.65"></a>
+<span class="sourceLineNo">066</span><a id="line.66"> /**</a>
+<span class="sourceLineNo">067</span><a id="line.67"> * The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but</a>
+<span class="sourceLineNo">068</span><a id="line.68"> * that assumes that we're using the default maven <code>${project.build.directory}</code>.</a>
+<span class="sourceLineNo">069</span><a id="line.69"> */</a>
+<span class="sourceLineNo">070</span><a id="line.70"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", property = "commons.outputDirectory")</a>
+<span class="sourceLineNo">071</span><a id="line.71"> private File workingDirectory;</a>
+<span class="sourceLineNo">072</span><a id="line.72"></a>
+<span class="sourceLineNo">073</span><a id="line.73"> /**</a>
+<span class="sourceLineNo">074</span><a id="line.74"> * The location to which to checkout the dist subversion repository under our working directory, which</a>
+<span class="sourceLineNo">075</span><a id="line.75"> * was given above. We then do an SVN delete on all the directories in this repository.</a>
+<span class="sourceLineNo">076</span><a id="line.76"> */</a>
+<span class="sourceLineNo">077</span><a id="line.77"> @Parameter(defaultValue = "${project.build.directory}/commons-release-plugin/scm-cleanup",</a>
+<span class="sourceLineNo">078</span><a id="line.78"> property = "commons.distCleanupDirectory")</a>
+<span class="sourceLineNo">079</span><a id="line.79"> private File distCleanupDirectory;</a>
+<span class="sourceLineNo">080</span><a id="line.80"></a>
+<span class="sourceLineNo">081</span><a id="line.81"> /**</a>
+<span class="sourceLineNo">082</span><a id="line.82"> * A boolean that determines whether or not we actually commit the files up to the subversion repository.</a>
+<span class="sourceLineNo">083</span><a id="line.83"> * If this is set to {@code true}, we do all but make the commits. We do checkout the repository in question</a>
+<span class="sourceLineNo">084</span><a id="line.84"> * though.</a>
+<span class="sourceLineNo">085</span><a id="line.85"> */</a>
+<span class="sourceLineNo">086</span><a id="line.86"> @Parameter(property = "commons.release.dryRun", defaultValue = "false")</a>
+<span class="sourceLineNo">087</span><a id="line.87"> private Boolean dryRun;</a>
+<span class="sourceLineNo">088</span><a id="line.88"></a>
+<span class="sourceLineNo">089</span><a id="line.89"> /**</a>
+<span class="sourceLineNo">090</span><a id="line.90"> * The url of the subversion repository to which we wish the artifacts to be staged. Typically this would need to</a>
+<span class="sourceLineNo">091</span><a id="line.91"> * be of the form: <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>. Note. that</a>
+<span class="sourceLineNo">092</span><a id="line.92"> * the prefix to the substring <code>https</code> is a requirement.</a>
+<span class="sourceLineNo">093</span><a id="line.93"> */</a>
+<span class="sourceLineNo">094</span><a id="line.94"> @Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</a>
+<span class="sourceLineNo">095</span><a id="line.95"> private String distSvnStagingUrl;</a>
+<span class="sourceLineNo">096</span><a id="line.96"></a>
+<span class="sourceLineNo">097</span><a id="line.97"> /**</a>
+<span class="sourceLineNo">098</span><a id="line.98"> * A parameter to generally avoid running unless it is specifically turned on by the consuming module.</a>
+<span class="sourceLineNo">099</span><a id="line.99"> */</a>
+<span class="sourceLineNo">100</span><a id="line.100"> @Parameter(defaultValue = "false", property = "commons.release.isDistModule")</a>
+<span class="sourceLineNo">101</span><a id="line.101"> private Boolean isDistModule;</a>
+<span class="sourceLineNo">102</span><a id="line.102"></a>
+<span class="sourceLineNo">103</span><a id="line.103"> /**</a>
+<span class="sourceLineNo">104</span><a id="line.104"> * The ID of the server (specified in settings.xml) which should be used for dist authentication.</a>
+<span class="sourceLineNo">105</span><a id="line.105"> * This will be used in preference to {@link #username}/{@link #password}.</a>
+<span class="sourceLineNo">106</span><a id="line.106"> */</a>
+<span class="sourceLineNo">107</span><a id="line.107"> @Parameter(property = "commons.distServer")</a>
+<span class="sourceLineNo">108</span><a id="line.108"> private String distServer;</a>
+<span class="sourceLineNo">109</span><a id="line.109"></a>
+<span class="sourceLineNo">110</span><a id="line.110"> /**</a>
+<span class="sourceLineNo">111</span><a id="line.111"> * The username for the distribution subversion repository. This is typically your Apache id.</a>
+<span class="sourceLineNo">112</span><a id="line.112"> */</a>
+<span class="sourceLineNo">113</span><a id="line.113"> @Parameter(property = "user.name")</a>
+<span class="sourceLineNo">114</span><a id="line.114"> private String username;</a>
+<span class="sourceLineNo">115</span><a id="line.115"></a>
+<span class="sourceLineNo">116</span><a id="line.116"> /**</a>
+<span class="sourceLineNo">117</span><a id="line.117"> * The password associated with {@link CommonsDistributionStagingMojo#username}.</a>
+<span class="sourceLineNo">118</span><a id="line.118"> */</a>
+<span class="sourceLineNo">119</span><a id="line.119"> @Parameter(property = "user.password")</a>
+<span class="sourceLineNo">120</span><a id="line.120"> private String password;</a>
+<span class="sourceLineNo">121</span><a id="line.121"></a>
+<span class="sourceLineNo">122</span><a id="line.122"> /**</a>
+<span class="sourceLineNo">123</span><a id="line.123"> * Maven {@link Settings}.</a>
+<span class="sourceLineNo">124</span><a id="line.124"> */</a>
+<span class="sourceLineNo">125</span><a id="line.125"> @Parameter(defaultValue = "${settings}", readonly = true, required = true)</a>
+<span class="sourceLineNo">126</span><a id="line.126"> private Settings settings;</a>
+<span class="sourceLineNo">127</span><a id="line.127"></a>
+<span class="sourceLineNo">128</span><a id="line.128"> /**</a>
+<span class="sourceLineNo">129</span><a id="line.129"> * Maven {@link SettingsDecrypter} component.</a>
+<span class="sourceLineNo">130</span><a id="line.130"> */</a>
+<span class="sourceLineNo">131</span><a id="line.131"> @Component</a>
+<span class="sourceLineNo">132</span><a id="line.132"> private SettingsDecrypter settingsDecrypter;</a>
+<span class="sourceLineNo">133</span><a id="line.133"></a>
+<span class="sourceLineNo">134</span><a id="line.134"> @Override</a>
+<span class="sourceLineNo">135</span><a id="line.135"> public void execute() throws MojoExecutionException, MojoFailureException {</a>
+<span class="sourceLineNo">136</span><a id="line.136"> if (!isDistModule) {</a>
+<span class="sourceLineNo">137</span><a id="line.137"> getLog().info("This module is marked as a non distribution "</a>
+<span class="sourceLineNo">138</span><a id="line.138"> + "or assembly module, and the plugin will not run.");</a>
+<span class="sourceLineNo">139</span><a id="line.139"> return;</a>
+<span class="sourceLineNo">140</span><a id="line.140"> }</a>
+<span class="sourceLineNo">141</span><a id="line.141"> if (StringUtils.isEmpty(distSvnStagingUrl)) {</a>
+<span class="sourceLineNo">142</span><a id="line.142"> getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin will not run.");</a>
+<span class="sourceLineNo">143</span><a id="line.143"> return;</a>
+<span class="sourceLineNo">144</span><a id="line.144"> }</a>
+<span class="sourceLineNo">145</span><a id="line.145"> if (!workingDirectory.exists()) {</a>
+<span class="sourceLineNo">146</span><a id="line.146"> SharedFunctions.initDirectory(getLog(), workingDirectory);</a>
+<span class="sourceLineNo">147</span><a id="line.147"> }</a>
+<span class="sourceLineNo">148</span><a id="line.148"> try {</a>
+<span class="sourceLineNo">149</span><a id="line.149"> final ScmManager scmManager = new BasicScmManager();</a>
+<span class="sourceLineNo">150</span><a id="line.150"> scmManager.setScmProvider("svn", new SvnExeScmProvider());</a>
+<span class="sourceLineNo">151</span><a id="line.151"> final ScmRepository repository = scmManager.makeScmRepository(distSvnStagingUrl);</a>
+<span class="sourceLineNo">152</span><a id="line.152"> final ScmProvider provider = scmManager.getProviderByRepository(repository);</a>
+<span class="sourceLineNo">153</span><a id="line.153"> final SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository</a>
+<span class="sourceLineNo">154</span><a id="line.154"> .getProviderRepository();</a>
+<span class="sourceLineNo">155</span><a id="line.155"> SharedFunctions.setAuthentication(</a>
+<span class="sourceLineNo">156</span><a id="line.156"> providerRepository,</a>
+<span class="sourceLineNo">157</span><a id="line.157"> distServer,</a>
+<span class="sourceLineNo">158</span><a id="line.158"> settings,</a>
+<span class="sourceLineNo">159</span><a id="line.159"> settingsDecrypter,</a>
+<span class="sourceLineNo">160</span><a id="line.160"> username,</a>
+<span class="sourceLineNo">161</span><a id="line.161"> password</a>
+<span class="sourceLineNo">162</span><a id="line.162"> );</a>
+<span class="sourceLineNo">163</span><a id="line.163"> getLog().info("Checking out dist from: " + distSvnStagingUrl);</a>
+<span class="sourceLineNo">164</span><a id="line.164"> final ScmFileSet scmFileSet = new ScmFileSet(distCleanupDirectory);</a>
+<span class="sourceLineNo">165</span><a id="line.165"> final CheckOutScmResult checkOutResult = provider.checkOut(repository, scmFileSet);</a>
+<span class="sourceLineNo">166</span><a id="line.166"> if (!checkOutResult.isSuccess()) {</a>
+<span class="sourceLineNo">167</span><a id="line.167"> throw new MojoExecutionException("Failed to checkout files from SCM: "</a>
+<span class="sourceLineNo">168</span><a id="line.168"> + checkOutResult.getProviderMessage() + " [" + checkOutResult.getCommandOutput() + "]");</a>
+<span class="sourceLineNo">169</span><a id="line.169"> }</a>
+<span class="sourceLineNo">170</span><a id="line.170"> final List<File> filesToRemove = Arrays.asList(distCleanupDirectory.listFiles());</a>
+<span class="sourceLineNo">171</span><a id="line.171"> if (filesToRemove.size() == 1) {</a>
+<span class="sourceLineNo">172</span><a id="line.172"> getLog().info("No files to delete");</a>
+<span class="sourceLineNo">173</span><a id="line.173"> return;</a>
+<span class="sourceLineNo">174</span><a id="line.174"> }</a>
+<span class="sourceLineNo">175</span><a id="line.175"> if (!dryRun) {</a>
+<span class="sourceLineNo">176</span><a id="line.176"> final ScmFileSet fileSet = new ScmFileSet(distCleanupDirectory, filesToRemove);</a>
+<span class="sourceLineNo">177</span><a id="line.177"> final RemoveScmResult removeScmResult = provider.remove(repository, fileSet,</a>
+<span class="sourceLineNo">178</span><a id="line.178"> "Cleaning up staging area");</a>
+<span class="sourceLineNo">179</span><a id="line.179"> if (!removeScmResult.isSuccess()) {</a>
+<span class="sourceLineNo">180</span><a id="line.180"> throw new MojoFailureException("Failed to remove files from SCM: "</a>
+<span class="sourceLineNo">181</span><a id="line.181"> + removeScmResult.getProviderMessage()</a>
+<span class="sourceLineNo">182</span><a id="line.182"> + " [" + removeScmResult.getCommandOutput() + "]");</a>
+<span class="sourceLineNo">183</span><a id="line.183"> }</a>
+<span class="sourceLineNo">184</span><a id="line.184"> getLog().info("Cleaning distribution area for: " + project.getArtifactId());</a>
+<span class="sourceLineNo">185</span><a id="line.185"> final CheckInScmResult checkInResult = provider.checkIn(</a>
+<span class="sourceLineNo">186</span><a id="line.186"> repository,</a>
+<span class="sourceLineNo">187</span><a id="line.187"> fileSet,</a>
+<span class="sourceLineNo">188</span><a id="line.188"> "Cleaning distribution area for: " + project.getArtifactId()</a>
+<span class="sourceLineNo">189</span><a id="line.189"> );</a>
+<span class="sourceLineNo">190</span><a id="line.190"> if (!checkInResult.isSuccess()) {</a>
+<span class="sourceLineNo">191</span><a id="line.191"> throw new MojoFailureException("Failed to commit files: " + removeScmResult.getProviderMessage()</a>
+<span class="sourceLineNo">192</span><a id="line.192"> + " [" + removeScmResult.getCommandOutput() + "]");</a>
+<span class="sourceLineNo">193</span><a id="line.193"> }</a>
+<span class="sourceLineNo">194</span><a id="line.194"> } else {</a>
+<span class="sourceLineNo">195</span><a id="line.195"> getLog().info("Would have attempted to delete files from: " + distSvnStagingUrl);</a>
+<span class="sourceLineNo">196</span><a id="line.196"> }</a>
+<span class="sourceLineNo">197</span><a id="line.197"> } catch (final ScmException e) {</a>
+<span class="sourceLineNo">198</span><a id="line.198"> throw new MojoFailureException(e.getMessage());</a>
+<span class="sourceLineNo">199</span><a id="line.199"> }</a>
+<span class="sourceLineNo">200</span><a id="line.200"></a>
+<span class="sourceLineNo">201</span><a id="line.201"> }</a>
+<span class="sourceLineNo">202</span><a id="line.202">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
Added: dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html
==============================================================================
--- dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html (added)
+++ dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html Sun Jun 25 19:04:09 2023
@@ -0,0 +1,160 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
+<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
+<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">008</span><a id="line.8"> *</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">010</span><a id="line.10"> *</a>
+<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
+<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
+<span class="sourceLineNo">016</span><a id="line.16"> */</a>
+<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin.velocity;</a>
+<span class="sourceLineNo">018</span><a id="line.18"></a>
+<span class="sourceLineNo">019</span><a id="line.19">import java.io.Writer;</a>
+<span class="sourceLineNo">020</span><a id="line.20">import org.apache.velocity.Template;</a>
+<span class="sourceLineNo">021</span><a id="line.21">import org.apache.velocity.VelocityContext;</a>
+<span class="sourceLineNo">022</span><a id="line.22">import org.apache.velocity.app.VelocityEngine;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import org.apache.velocity.runtime.RuntimeConstants;</a>
+<span class="sourceLineNo">024</span><a id="line.24">import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</a>
+<span class="sourceLineNo">025</span><a id="line.25"></a>
+<span class="sourceLineNo">026</span><a id="line.26">/**</a>
+<span class="sourceLineNo">027</span><a id="line.27"> * This class' purpose is to generate the <code>HEADER.html</code> that moves along with the</a>
+<span class="sourceLineNo">028</span><a id="line.28"> * release for the sake of downloading the release from the distribution area.</a>
+<span class="sourceLineNo">029</span><a id="line.29"> *</a>
+<span class="sourceLineNo">030</span><a id="line.30"> * @since 1.3</a>
+<span class="sourceLineNo">031</span><a id="line.31"> */</a>
+<span class="sourceLineNo">032</span><a id="line.32">public class HeaderHtmlVelocityDelegate {</a>
+<span class="sourceLineNo">033</span><a id="line.33"></a>
+<span class="sourceLineNo">034</span><a id="line.34"> /** The location of the velocity template for this class. */</a>
+<span class="sourceLineNo">035</span><a id="line.35"> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin/velocity/HEADER.vm";</a>
+<span class="sourceLineNo">036</span><a id="line.36"></a>
+<span class="sourceLineNo">037</span><a id="line.37"> /** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */</a>
+<span class="sourceLineNo">038</span><a id="line.38"> private HeaderHtmlVelocityDelegate() {</a>
+<span class="sourceLineNo">039</span><a id="line.39"> }</a>
+<span class="sourceLineNo">040</span><a id="line.40"></a>
+<span class="sourceLineNo">041</span><a id="line.41"> /**</a>
+<span class="sourceLineNo">042</span><a id="line.42"> * For instantiating our {@link HeaderHtmlVelocityDelegate} using the {@link HeaderHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">043</span><a id="line.43"> *</a>
+<span class="sourceLineNo">044</span><a id="line.44"> * @return a {@link HeaderHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">045</span><a id="line.45"> */</a>
+<span class="sourceLineNo">046</span><a id="line.46"> public static HeaderHtmlVelocityDelegateBuilder builder() {</a>
+<span class="sourceLineNo">047</span><a id="line.47"> return new HeaderHtmlVelocityDelegateBuilder();</a>
+<span class="sourceLineNo">048</span><a id="line.48"> }</a>
+<span class="sourceLineNo">049</span><a id="line.49"></a>
+<span class="sourceLineNo">050</span><a id="line.50"> /**</a>
+<span class="sourceLineNo">051</span><a id="line.51"> * Builds the HEADER.vm velocity template to the writer passed in.</a>
+<span class="sourceLineNo">052</span><a id="line.52"> *</a>
+<span class="sourceLineNo">053</span><a id="line.53"> * @param writer any {@link Writer} that we wish to have the filled velocity template written to.</a>
+<span class="sourceLineNo">054</span><a id="line.54"> * @return the {@link Writer} that we've filled out the template into.</a>
+<span class="sourceLineNo">055</span><a id="line.55"> */</a>
+<span class="sourceLineNo">056</span><a id="line.56"> public Writer render(final Writer writer) {</a>
+<span class="sourceLineNo">057</span><a id="line.57"> final VelocityEngine ve = new VelocityEngine();</a>
+<span class="sourceLineNo">058</span><a id="line.58"> ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</a>
+<span class="sourceLineNo">059</span><a id="line.59"> ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());</a>
+<span class="sourceLineNo">060</span><a id="line.60"> ve.init();</a>
+<span class="sourceLineNo">061</span><a id="line.61"> final Template template = ve.getTemplate(TEMPLATE);</a>
+<span class="sourceLineNo">062</span><a id="line.62"> final VelocityContext context = new VelocityContext();</a>
+<span class="sourceLineNo">063</span><a id="line.63"> template.merge(context, writer);</a>
+<span class="sourceLineNo">064</span><a id="line.64"> return writer;</a>
+<span class="sourceLineNo">065</span><a id="line.65"> }</a>
+<span class="sourceLineNo">066</span><a id="line.66"></a>
+<span class="sourceLineNo">067</span><a id="line.67"> /**</a>
+<span class="sourceLineNo">068</span><a id="line.68"> * A builder class for instantiation of the {@link HeaderHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">069</span><a id="line.69"> */</a>
+<span class="sourceLineNo">070</span><a id="line.70"> public static class HeaderHtmlVelocityDelegateBuilder {</a>
+<span class="sourceLineNo">071</span><a id="line.71"></a>
+<span class="sourceLineNo">072</span><a id="line.72"> /**</a>
+<span class="sourceLineNo">073</span><a id="line.73"> * Private constructor so that we can have a proper builder pattern.</a>
+<span class="sourceLineNo">074</span><a id="line.74"> */</a>
+<span class="sourceLineNo">075</span><a id="line.75"> private HeaderHtmlVelocityDelegateBuilder() {</a>
+<span class="sourceLineNo">076</span><a id="line.76"> }</a>
+<span class="sourceLineNo">077</span><a id="line.77"></a>
+<span class="sourceLineNo">078</span><a id="line.78"> /**</a>
+<span class="sourceLineNo">079</span><a id="line.79"> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.</a>
+<span class="sourceLineNo">080</span><a id="line.80"> * @return a new {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">081</span><a id="line.81"> */</a>
+<span class="sourceLineNo">082</span><a id="line.82"> public HeaderHtmlVelocityDelegate build() {</a>
+<span class="sourceLineNo">083</span><a id="line.83"> return new HeaderHtmlVelocityDelegate();</a>
+<span class="sourceLineNo">084</span><a id="line.84"> }</a>
+<span class="sourceLineNo">085</span><a id="line.85"> }</a>
+<span class="sourceLineNo">086</span><a id="line.86">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
Added: dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html
==============================================================================
--- dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html (added)
+++ dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html Sun Jun 25 19:04:09 2023
@@ -0,0 +1,160 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
+<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
+<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">008</span><a id="line.8"> *</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">010</span><a id="line.10"> *</a>
+<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
+<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
+<span class="sourceLineNo">016</span><a id="line.16"> */</a>
+<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin.velocity;</a>
+<span class="sourceLineNo">018</span><a id="line.18"></a>
+<span class="sourceLineNo">019</span><a id="line.19">import java.io.Writer;</a>
+<span class="sourceLineNo">020</span><a id="line.20">import org.apache.velocity.Template;</a>
+<span class="sourceLineNo">021</span><a id="line.21">import org.apache.velocity.VelocityContext;</a>
+<span class="sourceLineNo">022</span><a id="line.22">import org.apache.velocity.app.VelocityEngine;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import org.apache.velocity.runtime.RuntimeConstants;</a>
+<span class="sourceLineNo">024</span><a id="line.24">import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</a>
+<span class="sourceLineNo">025</span><a id="line.25"></a>
+<span class="sourceLineNo">026</span><a id="line.26">/**</a>
+<span class="sourceLineNo">027</span><a id="line.27"> * This class' purpose is to generate the <code>HEADER.html</code> that moves along with the</a>
+<span class="sourceLineNo">028</span><a id="line.28"> * release for the sake of downloading the release from the distribution area.</a>
+<span class="sourceLineNo">029</span><a id="line.29"> *</a>
+<span class="sourceLineNo">030</span><a id="line.30"> * @since 1.3</a>
+<span class="sourceLineNo">031</span><a id="line.31"> */</a>
+<span class="sourceLineNo">032</span><a id="line.32">public class HeaderHtmlVelocityDelegate {</a>
+<span class="sourceLineNo">033</span><a id="line.33"></a>
+<span class="sourceLineNo">034</span><a id="line.34"> /** The location of the velocity template for this class. */</a>
+<span class="sourceLineNo">035</span><a id="line.35"> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin/velocity/HEADER.vm";</a>
+<span class="sourceLineNo">036</span><a id="line.36"></a>
+<span class="sourceLineNo">037</span><a id="line.37"> /** The private constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. */</a>
+<span class="sourceLineNo">038</span><a id="line.38"> private HeaderHtmlVelocityDelegate() {</a>
+<span class="sourceLineNo">039</span><a id="line.39"> }</a>
+<span class="sourceLineNo">040</span><a id="line.40"></a>
+<span class="sourceLineNo">041</span><a id="line.41"> /**</a>
+<span class="sourceLineNo">042</span><a id="line.42"> * For instantiating our {@link HeaderHtmlVelocityDelegate} using the {@link HeaderHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">043</span><a id="line.43"> *</a>
+<span class="sourceLineNo">044</span><a id="line.44"> * @return a {@link HeaderHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">045</span><a id="line.45"> */</a>
+<span class="sourceLineNo">046</span><a id="line.46"> public static HeaderHtmlVelocityDelegateBuilder builder() {</a>
+<span class="sourceLineNo">047</span><a id="line.47"> return new HeaderHtmlVelocityDelegateBuilder();</a>
+<span class="sourceLineNo">048</span><a id="line.48"> }</a>
+<span class="sourceLineNo">049</span><a id="line.49"></a>
+<span class="sourceLineNo">050</span><a id="line.50"> /**</a>
+<span class="sourceLineNo">051</span><a id="line.51"> * Builds the HEADER.vm velocity template to the writer passed in.</a>
+<span class="sourceLineNo">052</span><a id="line.52"> *</a>
+<span class="sourceLineNo">053</span><a id="line.53"> * @param writer any {@link Writer} that we wish to have the filled velocity template written to.</a>
+<span class="sourceLineNo">054</span><a id="line.54"> * @return the {@link Writer} that we've filled out the template into.</a>
+<span class="sourceLineNo">055</span><a id="line.55"> */</a>
+<span class="sourceLineNo">056</span><a id="line.56"> public Writer render(final Writer writer) {</a>
+<span class="sourceLineNo">057</span><a id="line.57"> final VelocityEngine ve = new VelocityEngine();</a>
+<span class="sourceLineNo">058</span><a id="line.58"> ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</a>
+<span class="sourceLineNo">059</span><a id="line.59"> ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());</a>
+<span class="sourceLineNo">060</span><a id="line.60"> ve.init();</a>
+<span class="sourceLineNo">061</span><a id="line.61"> final Template template = ve.getTemplate(TEMPLATE);</a>
+<span class="sourceLineNo">062</span><a id="line.62"> final VelocityContext context = new VelocityContext();</a>
+<span class="sourceLineNo">063</span><a id="line.63"> template.merge(context, writer);</a>
+<span class="sourceLineNo">064</span><a id="line.64"> return writer;</a>
+<span class="sourceLineNo">065</span><a id="line.65"> }</a>
+<span class="sourceLineNo">066</span><a id="line.66"></a>
+<span class="sourceLineNo">067</span><a id="line.67"> /**</a>
+<span class="sourceLineNo">068</span><a id="line.68"> * A builder class for instantiation of the {@link HeaderHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">069</span><a id="line.69"> */</a>
+<span class="sourceLineNo">070</span><a id="line.70"> public static class HeaderHtmlVelocityDelegateBuilder {</a>
+<span class="sourceLineNo">071</span><a id="line.71"></a>
+<span class="sourceLineNo">072</span><a id="line.72"> /**</a>
+<span class="sourceLineNo">073</span><a id="line.73"> * Private constructor so that we can have a proper builder pattern.</a>
+<span class="sourceLineNo">074</span><a id="line.74"> */</a>
+<span class="sourceLineNo">075</span><a id="line.75"> private HeaderHtmlVelocityDelegateBuilder() {</a>
+<span class="sourceLineNo">076</span><a id="line.76"> }</a>
+<span class="sourceLineNo">077</span><a id="line.77"></a>
+<span class="sourceLineNo">078</span><a id="line.78"> /**</a>
+<span class="sourceLineNo">079</span><a id="line.79"> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.</a>
+<span class="sourceLineNo">080</span><a id="line.80"> * @return a new {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">081</span><a id="line.81"> */</a>
+<span class="sourceLineNo">082</span><a id="line.82"> public HeaderHtmlVelocityDelegate build() {</a>
+<span class="sourceLineNo">083</span><a id="line.83"> return new HeaderHtmlVelocityDelegate();</a>
+<span class="sourceLineNo">084</span><a id="line.84"> }</a>
+<span class="sourceLineNo">085</span><a id="line.85"> }</a>
+<span class="sourceLineNo">086</span><a id="line.86">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
Added: dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html
==============================================================================
--- dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html (added)
+++ dev/commons/release-plugin/1.8.1-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html Sun Jun 25 19:04:09 2023
@@ -0,0 +1,235 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
+<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one or more</a>
+<span class="sourceLineNo">003</span><a id="line.3"> * contributor license agreements. See the NOTICE file distributed with</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * this work for additional information regarding copyright ownership.</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this file to You under the Apache License, Version 2.0</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you may not use this file except in compliance with</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">008</span><a id="line.8"> *</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">010</span><a id="line.10"> *</a>
+<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by applicable law or agreed to in writing, software</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the License is distributed on an "AS IS" BASIS,</a>
+<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * See the License for the specific language governing permissions and</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the License.</a>
+<span class="sourceLineNo">016</span><a id="line.16"> */</a>
+<span class="sourceLineNo">017</span><a id="line.17">package org.apache.commons.release.plugin.velocity;</a>
+<span class="sourceLineNo">018</span><a id="line.18"></a>
+<span class="sourceLineNo">019</span><a id="line.19">import java.io.Writer;</a>
+<span class="sourceLineNo">020</span><a id="line.20">import org.apache.commons.lang3.StringUtils;</a>
+<span class="sourceLineNo">021</span><a id="line.21">import org.apache.velocity.Template;</a>
+<span class="sourceLineNo">022</span><a id="line.22">import org.apache.velocity.VelocityContext;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import org.apache.velocity.app.VelocityEngine;</a>
+<span class="sourceLineNo">024</span><a id="line.24">import org.apache.velocity.runtime.RuntimeConstants;</a>
+<span class="sourceLineNo">025</span><a id="line.25">import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</a>
+<span class="sourceLineNo">026</span><a id="line.26"></a>
+<span class="sourceLineNo">027</span><a id="line.27">/**</a>
+<span class="sourceLineNo">028</span><a id="line.28"> * This class' purpose is to generate the <code>README.html</code> that moves along with the</a>
+<span class="sourceLineNo">029</span><a id="line.29"> * release for the sake of downloading the release from the distribution area.</a>
+<span class="sourceLineNo">030</span><a id="line.30"> *</a>
+<span class="sourceLineNo">031</span><a id="line.31"> * @since 1.3</a>
+<span class="sourceLineNo">032</span><a id="line.32"> */</a>
+<span class="sourceLineNo">033</span><a id="line.33">public class ReadmeHtmlVelocityDelegate {</a>
+<span class="sourceLineNo">034</span><a id="line.34"> /** The location of the velocity template for this class. */</a>
+<span class="sourceLineNo">035</span><a id="line.35"> private static final String TEMPLATE = "resources/org/apache/commons/release/plugin"</a>
+<span class="sourceLineNo">036</span><a id="line.36"> + "/velocity/README.vm";</a>
+<span class="sourceLineNo">037</span><a id="line.37"> /** This is supposed to represent the maven artifactId. */</a>
+<span class="sourceLineNo">038</span><a id="line.38"> private final String artifactId;</a>
+<span class="sourceLineNo">039</span><a id="line.39"> /** This is supposed to represent the maven version of the release. */</a>
+<span class="sourceLineNo">040</span><a id="line.40"> private final String version;</a>
+<span class="sourceLineNo">041</span><a id="line.41"> /** The url of the site that gets set into the <code>README.html</code>. */</a>
+<span class="sourceLineNo">042</span><a id="line.42"> private final String siteUrl;</a>
+<span class="sourceLineNo">043</span><a id="line.43"></a>
+<span class="sourceLineNo">044</span><a id="line.44"> /**</a>
+<span class="sourceLineNo">045</span><a id="line.45"> * The private constructor to be used by the {@link ReadmeHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">046</span><a id="line.46"> *</a>
+<span class="sourceLineNo">047</span><a id="line.47"> * @param artifactId sets the {@link ReadmeHtmlVelocityDelegate#artifactId}.</a>
+<span class="sourceLineNo">048</span><a id="line.48"> * @param version sets the {@link ReadmeHtmlVelocityDelegate#version}.</a>
+<span class="sourceLineNo">049</span><a id="line.49"> * @param siteUrl sets the {@link ReadmeHtmlVelocityDelegate#siteUrl}.</a>
+<span class="sourceLineNo">050</span><a id="line.50"> */</a>
+<span class="sourceLineNo">051</span><a id="line.51"> private ReadmeHtmlVelocityDelegate(final String artifactId, final String version, final String siteUrl) {</a>
+<span class="sourceLineNo">052</span><a id="line.52"> this.artifactId = artifactId;</a>
+<span class="sourceLineNo">053</span><a id="line.53"> this.version = version;</a>
+<span class="sourceLineNo">054</span><a id="line.54"> this.siteUrl = siteUrl;</a>
+<span class="sourceLineNo">055</span><a id="line.55"> }</a>
+<span class="sourceLineNo">056</span><a id="line.56"></a>
+<span class="sourceLineNo">057</span><a id="line.57"> /**</a>
+<span class="sourceLineNo">058</span><a id="line.58"> * Gets the {@link ReadmeHtmlVelocityDelegateBuilder} for constructing the {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">059</span><a id="line.59"> *</a>
+<span class="sourceLineNo">060</span><a id="line.60"> * @return the {@link ReadmeHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">061</span><a id="line.61"> */</a>
+<span class="sourceLineNo">062</span><a id="line.62"> public static ReadmeHtmlVelocityDelegateBuilder builder() {</a>
+<span class="sourceLineNo">063</span><a id="line.63"> return new ReadmeHtmlVelocityDelegateBuilder();</a>
+<span class="sourceLineNo">064</span><a id="line.64"> }</a>
+<span class="sourceLineNo">065</span><a id="line.65"></a>
+<span class="sourceLineNo">066</span><a id="line.66"> /**</a>
+<span class="sourceLineNo">067</span><a id="line.67"> * Renders the <code>README.vm</code> velocity template with the variables constructed with the</a>
+<span class="sourceLineNo">068</span><a id="line.68"> * {@link ReadmeHtmlVelocityDelegateBuilder}.</a>
+<span class="sourceLineNo">069</span><a id="line.69"> *</a>
+<span class="sourceLineNo">070</span><a id="line.70"> * @param writer is the {@link Writer} to which we wish to render the <code>README.vm</code> template.</a>
+<span class="sourceLineNo">071</span><a id="line.71"> * @return a reference to the {@link Writer} passed in.</a>
+<span class="sourceLineNo">072</span><a id="line.72"> */</a>
+<span class="sourceLineNo">073</span><a id="line.73"> public Writer render(final Writer writer) {</a>
+<span class="sourceLineNo">074</span><a id="line.74"> final VelocityEngine ve = new VelocityEngine();</a>
+<span class="sourceLineNo">075</span><a id="line.75"> ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</a>
+<span class="sourceLineNo">076</span><a id="line.76"> ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());</a>
+<span class="sourceLineNo">077</span><a id="line.77"> ve.init();</a>
+<span class="sourceLineNo">078</span><a id="line.78"> final Template template = ve.getTemplate(TEMPLATE);</a>
+<span class="sourceLineNo">079</span><a id="line.79"> final String[] splitArtifactId = artifactId.split("-");</a>
+<span class="sourceLineNo">080</span><a id="line.80"> final String wordCommons = "commons";</a>
+<span class="sourceLineNo">081</span><a id="line.81"> String artifactShortName = "";</a>
+<span class="sourceLineNo">082</span><a id="line.82"> if (splitArtifactId.length > 1) {</a>
+<span class="sourceLineNo">083</span><a id="line.83"> artifactShortName = splitArtifactId[1];</a>
+<span class="sourceLineNo">084</span><a id="line.84"> } else if (splitArtifactId.length == 1) {</a>
+<span class="sourceLineNo">085</span><a id="line.85"> artifactShortName = splitArtifactId[0];</a>
+<span class="sourceLineNo">086</span><a id="line.86"> }</a>
+<span class="sourceLineNo">087</span><a id="line.87"> // ".+\\d$" matches a non-empty string that terminates in a digit {0-9}.</a>
+<span class="sourceLineNo">088</span><a id="line.88"> if (artifactShortName.matches(".+\\d$")) {</a>
+<span class="sourceLineNo">089</span><a id="line.89"> artifactShortName = artifactShortName.substring(0, artifactShortName.length() - 1);</a>
+<span class="sourceLineNo">090</span><a id="line.90"> }</a>
+<span class="sourceLineNo">091</span><a id="line.91"> final String artifactIdWithFirstLetterscapitalized =</a>
+<span class="sourceLineNo">092</span><a id="line.92"> StringUtils.capitalize(wordCommons)</a>
+<span class="sourceLineNo">093</span><a id="line.93"> + "-"</a>
+<span class="sourceLineNo">094</span><a id="line.94"> + artifactShortName.toUpperCase();</a>
+<span class="sourceLineNo">095</span><a id="line.95"> final VelocityContext context = new VelocityContext();</a>
+<span class="sourceLineNo">096</span><a id="line.96"> context.internalPut("artifactIdWithFirstLetterscapitalized", artifactIdWithFirstLetterscapitalized);</a>
+<span class="sourceLineNo">097</span><a id="line.97"> context.internalPut("artifactShortName", artifactShortName.toUpperCase());</a>
+<span class="sourceLineNo">098</span><a id="line.98"> context.internalPut("artifactId", artifactId);</a>
+<span class="sourceLineNo">099</span><a id="line.99"> context.internalPut("version", version);</a>
+<span class="sourceLineNo">100</span><a id="line.100"> context.internalPut("siteUrl", siteUrl);</a>
+<span class="sourceLineNo">101</span><a id="line.101"> template.merge(context, writer);</a>
+<span class="sourceLineNo">102</span><a id="line.102"> return writer;</a>
+<span class="sourceLineNo">103</span><a id="line.103"> }</a>
+<span class="sourceLineNo">104</span><a id="line.104"></a>
+<span class="sourceLineNo">105</span><a id="line.105"> /**</a>
+<span class="sourceLineNo">106</span><a id="line.106"> * A builder class for instantiation of the {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">107</span><a id="line.107"> */</a>
+<span class="sourceLineNo">108</span><a id="line.108"> public static class ReadmeHtmlVelocityDelegateBuilder {</a>
+<span class="sourceLineNo">109</span><a id="line.109"> /** The maven artifactId to use in the <code>README.vm</code> template. */</a>
+<span class="sourceLineNo">110</span><a id="line.110"> private String artifactId;</a>
+<span class="sourceLineNo">111</span><a id="line.111"> /** The maven version to use in the <code>README.vm</code> template. */</a>
+<span class="sourceLineNo">112</span><a id="line.112"> private String version;</a>
+<span class="sourceLineNo">113</span><a id="line.113"> /** The site url to use in the <code>README.vm</code> template. */</a>
+<span class="sourceLineNo">114</span><a id="line.114"> private String siteUrl;</a>
+<span class="sourceLineNo">115</span><a id="line.115"></a>
+<span class="sourceLineNo">116</span><a id="line.116"> /**</a>
+<span class="sourceLineNo">117</span><a id="line.117"> * Private constructor for using the builder through the {@link ReadmeHtmlVelocityDelegate#builder()}</a>
+<span class="sourceLineNo">118</span><a id="line.118"> * method.</a>
+<span class="sourceLineNo">119</span><a id="line.119"> */</a>
+<span class="sourceLineNo">120</span><a id="line.120"> private ReadmeHtmlVelocityDelegateBuilder() {</a>
+<span class="sourceLineNo">121</span><a id="line.121"> }</a>
+<span class="sourceLineNo">122</span><a id="line.122"></a>
+<span class="sourceLineNo">123</span><a id="line.123"> /**</a>
+<span class="sourceLineNo">124</span><a id="line.124"> * Adds the artifactId to the {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">125</span><a id="line.125"> * @param artifactId the {@link String} representing the maven artifactId.</a>
+<span class="sourceLineNo">126</span><a id="line.126"> * @return the builder to continue building.</a>
+<span class="sourceLineNo">127</span><a id="line.127"> */</a>
+<span class="sourceLineNo">128</span><a id="line.128"> public ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {</a>
+<span class="sourceLineNo">129</span><a id="line.129"> this.artifactId = artifactId;</a>
+<span class="sourceLineNo">130</span><a id="line.130"> return this;</a>
+<span class="sourceLineNo">131</span><a id="line.131"> }</a>
+<span class="sourceLineNo">132</span><a id="line.132"></a>
+<span class="sourceLineNo">133</span><a id="line.133"> /**</a>
+<span class="sourceLineNo">134</span><a id="line.134"> * Adds the version to the {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">135</span><a id="line.135"> * @param version the maven version.</a>
+<span class="sourceLineNo">136</span><a id="line.136"> * @return the builder to continue building.</a>
+<span class="sourceLineNo">137</span><a id="line.137"> */</a>
+<span class="sourceLineNo">138</span><a id="line.138"> public ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {</a>
+<span class="sourceLineNo">139</span><a id="line.139"> this.version = version;</a>
+<span class="sourceLineNo">140</span><a id="line.140"> return this;</a>
+<span class="sourceLineNo">141</span><a id="line.141"> }</a>
+<span class="sourceLineNo">142</span><a id="line.142"></a>
+<span class="sourceLineNo">143</span><a id="line.143"> /**</a>
+<span class="sourceLineNo">144</span><a id="line.144"> * Adds the siteUrl to the {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">145</span><a id="line.145"> * @param siteUrl the site url to be used in the <code>README.html</code></a>
+<span class="sourceLineNo">146</span><a id="line.146"> * @return the builder to continue building.</a>
+<span class="sourceLineNo">147</span><a id="line.147"> */</a>
+<span class="sourceLineNo">148</span><a id="line.148"> public ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {</a>
+<span class="sourceLineNo">149</span><a id="line.149"> this.siteUrl = siteUrl;</a>
+<span class="sourceLineNo">150</span><a id="line.150"> return this;</a>
+<span class="sourceLineNo">151</span><a id="line.151"> }</a>
+<span class="sourceLineNo">152</span><a id="line.152"></a>
+<span class="sourceLineNo">153</span><a id="line.153"> /**</a>
+<span class="sourceLineNo">154</span><a id="line.154"> * Builds up the {@link ReadmeHtmlVelocityDelegate} from the previously set parameters.</a>
+<span class="sourceLineNo">155</span><a id="line.155"> * @return a new {@link ReadmeHtmlVelocityDelegate}.</a>
+<span class="sourceLineNo">156</span><a id="line.156"> */</a>
+<span class="sourceLineNo">157</span><a id="line.157"> public ReadmeHtmlVelocityDelegate build() {</a>
+<span class="sourceLineNo">158</span><a id="line.158"> return new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);</a>
+<span class="sourceLineNo">159</span><a id="line.159"> }</a>
+<span class="sourceLineNo">160</span><a id="line.160"> }</a>
+<span class="sourceLineNo">161</span><a id="line.161">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>