Added: 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html
==============================================================================
--- 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html
 (added)
+++ 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html
 Sun Nov  3 20:07:40 2024
@@ -0,0 +1,280 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: 
org.apache.commons.release.plugin.mojos, class: CommonsStagingCleanupMojo">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" 
href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the 
Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor 
license agreements.  See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for 
additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses 
this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); 
you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License.  You 
may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> *      
http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required 
by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under 
the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT 
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License 
for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under 
the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package 
org.apache.commons.release.plugin.mojos;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import 
java.io.File;</span>
+<span class="source-line-no">020</span><span id="line-20">import 
java.util.Arrays;</span>
+<span class="source-line-no">021</span><span id="line-21">import 
java.util.List;</span>
+<span class="source-line-no">022</span><span id="line-22"></span>
+<span class="source-line-no">023</span><span id="line-23">import 
org.apache.commons.lang3.StringUtils;</span>
+<span class="source-line-no">024</span><span id="line-24">import 
org.apache.commons.release.plugin.SharedFunctions;</span>
+<span class="source-line-no">025</span><span id="line-25">import 
org.apache.maven.plugin.AbstractMojo;</span>
+<span class="source-line-no">026</span><span id="line-26">import 
org.apache.maven.plugin.MojoExecutionException;</span>
+<span class="source-line-no">027</span><span id="line-27">import 
org.apache.maven.plugin.MojoFailureException;</span>
+<span class="source-line-no">028</span><span id="line-28">import 
org.apache.maven.plugins.annotations.Component;</span>
+<span class="source-line-no">029</span><span id="line-29">import 
org.apache.maven.plugins.annotations.LifecyclePhase;</span>
+<span class="source-line-no">030</span><span id="line-30">import 
org.apache.maven.plugins.annotations.Mojo;</span>
+<span class="source-line-no">031</span><span id="line-31">import 
org.apache.maven.plugins.annotations.Parameter;</span>
+<span class="source-line-no">032</span><span id="line-32">import 
org.apache.maven.project.MavenProject;</span>
+<span class="source-line-no">033</span><span id="line-33">import 
org.apache.maven.scm.ScmException;</span>
+<span class="source-line-no">034</span><span id="line-34">import 
org.apache.maven.scm.ScmFileSet;</span>
+<span class="source-line-no">035</span><span id="line-35">import 
org.apache.maven.scm.command.checkin.CheckInScmResult;</span>
+<span class="source-line-no">036</span><span id="line-36">import 
org.apache.maven.scm.command.checkout.CheckOutScmResult;</span>
+<span class="source-line-no">037</span><span id="line-37">import 
org.apache.maven.scm.command.remove.RemoveScmResult;</span>
+<span class="source-line-no">038</span><span id="line-38">import 
org.apache.maven.scm.manager.BasicScmManager;</span>
+<span class="source-line-no">039</span><span id="line-39">import 
org.apache.maven.scm.manager.ScmManager;</span>
+<span class="source-line-no">040</span><span id="line-40">import 
org.apache.maven.scm.provider.ScmProvider;</span>
+<span class="source-line-no">041</span><span id="line-41">import 
org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;</span>
+<span class="source-line-no">042</span><span id="line-42">import 
org.apache.maven.scm.provider.svn.svnexe.SvnExeScmProvider;</span>
+<span class="source-line-no">043</span><span id="line-43">import 
org.apache.maven.scm.repository.ScmRepository;</span>
+<span class="source-line-no">044</span><span id="line-44">import 
org.apache.maven.settings.Settings;</span>
+<span class="source-line-no">045</span><span id="line-45">import 
org.apache.maven.settings.crypto.SettingsDecrypter;</span>
+<span class="source-line-no">046</span><span id="line-46"></span>
+<span class="source-line-no">047</span><span id="line-47">/**</span>
+<span class="source-line-no">048</span><span id="line-48"> * This class checks 
out the dev distribution location, checks whether anything exists in the</span>
+<span class="source-line-no">049</span><span id="line-49"> * distribution 
location, and if it is non-empty it deletes all the resources there.</span>
+<span class="source-line-no">050</span><span id="line-50"> *</span>
+<span class="source-line-no">051</span><span id="line-51"> * @since 1.6</span>
+<span class="source-line-no">052</span><span id="line-52"> */</span>
+<span class="source-line-no">053</span><span id="line-53">@Mojo(name = 
"clean-staging",</span>
+<span class="source-line-no">054</span><span id="line-54">        defaultPhase 
= LifecyclePhase.POST_CLEAN,</span>
+<span class="source-line-no">055</span><span id="line-55">        threadSafe = 
true,</span>
+<span class="source-line-no">056</span><span id="line-56">        aggregator = 
true)</span>
+<span class="source-line-no">057</span><span id="line-57">public class 
CommonsStagingCleanupMojo extends AbstractMojo {</span>
+<span class="source-line-no">058</span><span id="line-58"></span>
+<span class="source-line-no">059</span><span id="line-59">    /**</span>
+<span class="source-line-no">060</span><span id="line-60">     * The {@link 
MavenProject} object is essentially the context of the maven build at</span>
+<span class="source-line-no">061</span><span id="line-61">     * a given 
time.</span>
+<span class="source-line-no">062</span><span id="line-62">     */</span>
+<span class="source-line-no">063</span><span id="line-63">    
@Parameter(defaultValue = "${project}", required = true)</span>
+<span class="source-line-no">064</span><span id="line-64">    private 
MavenProject project;</span>
+<span class="source-line-no">065</span><span id="line-65"></span>
+<span class="source-line-no">066</span><span id="line-66">    /**</span>
+<span class="source-line-no">067</span><span id="line-67">     * The main 
working directory for the plugin, namely 
&lt;code&gt;target/commons-release-plugin&lt;/code&gt;, but</span>
+<span class="source-line-no">068</span><span id="line-68">     * that assumes 
that we're using the default maven 
&lt;code&gt;${project.build.directory}&lt;/code&gt;.</span>
+<span class="source-line-no">069</span><span id="line-69">     */</span>
+<span class="source-line-no">070</span><span id="line-70">    
@Parameter(defaultValue = "${project.build.directory}/commons-release-plugin", 
property = "commons.outputDirectory")</span>
+<span class="source-line-no">071</span><span id="line-71">    private File 
workingDirectory;</span>
+<span class="source-line-no">072</span><span id="line-72"></span>
+<span class="source-line-no">073</span><span id="line-73">    /**</span>
+<span class="source-line-no">074</span><span id="line-74">     * The location 
to which to checkout the dist subversion repository under our working 
directory, which</span>
+<span class="source-line-no">075</span><span id="line-75">     * was given 
above. We then do an SVN delete on all the directories in this 
repository.</span>
+<span class="source-line-no">076</span><span id="line-76">     */</span>
+<span class="source-line-no">077</span><span id="line-77">    
@Parameter(defaultValue = 
"${project.build.directory}/commons-release-plugin/scm-cleanup",</span>
+<span class="source-line-no">078</span><span id="line-78">            property 
= "commons.distCleanupDirectory")</span>
+<span class="source-line-no">079</span><span id="line-79">    private File 
distCleanupDirectory;</span>
+<span class="source-line-no">080</span><span id="line-80"></span>
+<span class="source-line-no">081</span><span id="line-81">    /**</span>
+<span class="source-line-no">082</span><span id="line-82">     * A boolean 
that determines whether or not we actually commit the files up to the 
subversion repository.</span>
+<span class="source-line-no">083</span><span id="line-83">     * If this is 
set to {@code true}, we do all but make the commits. We do checkout the 
repository in question</span>
+<span class="source-line-no">084</span><span id="line-84">     * though.</span>
+<span class="source-line-no">085</span><span id="line-85">     */</span>
+<span class="source-line-no">086</span><span id="line-86">    
@Parameter(property = "commons.release.dryRun", defaultValue = "false")</span>
+<span class="source-line-no">087</span><span id="line-87">    private Boolean 
dryRun;</span>
+<span class="source-line-no">088</span><span id="line-88"></span>
+<span class="source-line-no">089</span><span id="line-89">    /**</span>
+<span class="source-line-no">090</span><span id="line-90">     * The url of 
the subversion repository to which we wish the artifacts to be staged. 
Typically this would need to</span>
+<span class="source-line-no">091</span><span id="line-91">     * be of the 
form: 
&lt;code&gt;scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#&lt;/code&gt;.
 Note. that</span>
+<span class="source-line-no">092</span><span id="line-92">     * the prefix to 
the substring &lt;code&gt;https&lt;/code&gt; is a requirement.</span>
+<span class="source-line-no">093</span><span id="line-93">     */</span>
+<span class="source-line-no">094</span><span id="line-94">    
@Parameter(defaultValue = "", property = "commons.distSvnStagingUrl")</span>
+<span class="source-line-no">095</span><span id="line-95">    private String 
distSvnStagingUrl;</span>
+<span class="source-line-no">096</span><span id="line-96"></span>
+<span class="source-line-no">097</span><span id="line-97">    /**</span>
+<span class="source-line-no">098</span><span id="line-98">     * A parameter 
to generally avoid running unless it is specifically turned on by the consuming 
module.</span>
+<span class="source-line-no">099</span><span id="line-99">     */</span>
+<span class="source-line-no">100</span><span id="line-100">    
@Parameter(defaultValue = "false", property = 
"commons.release.isDistModule")</span>
+<span class="source-line-no">101</span><span id="line-101">    private Boolean 
isDistModule;</span>
+<span class="source-line-no">102</span><span id="line-102"></span>
+<span class="source-line-no">103</span><span id="line-103">    /**</span>
+<span class="source-line-no">104</span><span id="line-104">     * The ID of 
the server (specified in settings.xml) which should be used for dist 
authentication.</span>
+<span class="source-line-no">105</span><span id="line-105">     * This will be 
used in preference to {@link #username}/{@link #password}.</span>
+<span class="source-line-no">106</span><span id="line-106">     */</span>
+<span class="source-line-no">107</span><span id="line-107">    
@Parameter(property = "commons.distServer")</span>
+<span class="source-line-no">108</span><span id="line-108">    private String 
distServer;</span>
+<span class="source-line-no">109</span><span id="line-109"></span>
+<span class="source-line-no">110</span><span id="line-110">    /**</span>
+<span class="source-line-no">111</span><span id="line-111">     * The username 
for the distribution subversion repository. This is typically your Apache 
id.</span>
+<span class="source-line-no">112</span><span id="line-112">     */</span>
+<span class="source-line-no">113</span><span id="line-113">    
@Parameter(property = "user.name")</span>
+<span class="source-line-no">114</span><span id="line-114">    private String 
username;</span>
+<span class="source-line-no">115</span><span id="line-115"></span>
+<span class="source-line-no">116</span><span id="line-116">    /**</span>
+<span class="source-line-no">117</span><span id="line-117">     * The password 
associated with {@link CommonsDistributionStagingMojo#username}.</span>
+<span class="source-line-no">118</span><span id="line-118">     */</span>
+<span class="source-line-no">119</span><span id="line-119">    
@Parameter(property = "user.password")</span>
+<span class="source-line-no">120</span><span id="line-120">    private String 
password;</span>
+<span class="source-line-no">121</span><span id="line-121"></span>
+<span class="source-line-no">122</span><span id="line-122">    /**</span>
+<span class="source-line-no">123</span><span id="line-123">     * Maven {@link 
Settings}.</span>
+<span class="source-line-no">124</span><span id="line-124">     */</span>
+<span class="source-line-no">125</span><span id="line-125">    
@Parameter(defaultValue = "${settings}", readonly = true, required = 
true)</span>
+<span class="source-line-no">126</span><span id="line-126">    private 
Settings settings;</span>
+<span class="source-line-no">127</span><span id="line-127"></span>
+<span class="source-line-no">128</span><span id="line-128">    /**</span>
+<span class="source-line-no">129</span><span id="line-129">     * Maven {@link 
SettingsDecrypter} component.</span>
+<span class="source-line-no">130</span><span id="line-130">     */</span>
+<span class="source-line-no">131</span><span id="line-131">    
@Component</span>
+<span class="source-line-no">132</span><span id="line-132">    private 
SettingsDecrypter settingsDecrypter;</span>
+<span class="source-line-no">133</span><span id="line-133"></span>
+<span class="source-line-no">134</span><span id="line-134">    @Override</span>
+<span class="source-line-no">135</span><span id="line-135">    public void 
execute() throws MojoExecutionException, MojoFailureException {</span>
+<span class="source-line-no">136</span><span id="line-136">        if 
(!isDistModule) {</span>
+<span class="source-line-no">137</span><span id="line-137">            
getLog().info("This module is marked as a non distribution "</span>
+<span class="source-line-no">138</span><span id="line-138">                    
+ "or assembly module, and the plugin will not run.");</span>
+<span class="source-line-no">139</span><span id="line-139">            
return;</span>
+<span class="source-line-no">140</span><span id="line-140">        }</span>
+<span class="source-line-no">141</span><span id="line-141">        if 
(StringUtils.isEmpty(distSvnStagingUrl)) {</span>
+<span class="source-line-no">142</span><span id="line-142">            
getLog().warn("commons.distSvnStagingUrl is not set, the commons-release-plugin 
will not run.");</span>
+<span class="source-line-no">143</span><span id="line-143">            
return;</span>
+<span class="source-line-no">144</span><span id="line-144">        }</span>
+<span class="source-line-no">145</span><span id="line-145">        if 
(!workingDirectory.exists()) {</span>
+<span class="source-line-no">146</span><span id="line-146">            
SharedFunctions.initDirectory(getLog(), workingDirectory);</span>
+<span class="source-line-no">147</span><span id="line-147">        }</span>
+<span class="source-line-no">148</span><span id="line-148">        try {</span>
+<span class="source-line-no">149</span><span id="line-149">            final 
ScmManager scmManager = new BasicScmManager();</span>
+<span class="source-line-no">150</span><span id="line-150">            
scmManager.setScmProvider("svn", new SvnExeScmProvider());</span>
+<span class="source-line-no">151</span><span id="line-151">            final 
ScmRepository repository = 
scmManager.makeScmRepository(distSvnStagingUrl);</span>
+<span class="source-line-no">152</span><span id="line-152">            final 
ScmProvider provider = scmManager.getProviderByRepository(repository);</span>
+<span class="source-line-no">153</span><span id="line-153">            final 
SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) 
repository</span>
+<span class="source-line-no">154</span><span id="line-154">                    
.getProviderRepository();</span>
+<span class="source-line-no">155</span><span id="line-155">            
SharedFunctions.setAuthentication(</span>
+<span class="source-line-no">156</span><span id="line-156">                    
providerRepository,</span>
+<span class="source-line-no">157</span><span id="line-157">                    
distServer,</span>
+<span class="source-line-no">158</span><span id="line-158">                    
settings,</span>
+<span class="source-line-no">159</span><span id="line-159">                    
settingsDecrypter,</span>
+<span class="source-line-no">160</span><span id="line-160">                    
username,</span>
+<span class="source-line-no">161</span><span id="line-161">                    
password</span>
+<span class="source-line-no">162</span><span id="line-162">            
);</span>
+<span class="source-line-no">163</span><span id="line-163">            
getLog().info("Checking out dist from: " + distSvnStagingUrl);</span>
+<span class="source-line-no">164</span><span id="line-164">            final 
ScmFileSet scmFileSet = new ScmFileSet(distCleanupDirectory);</span>
+<span class="source-line-no">165</span><span id="line-165">            final 
CheckOutScmResult checkOutResult = provider.checkOut(repository, 
scmFileSet);</span>
+<span class="source-line-no">166</span><span id="line-166">            if 
(!checkOutResult.isSuccess()) {</span>
+<span class="source-line-no">167</span><span id="line-167">                
throw new MojoExecutionException("Failed to checkout files from SCM: "</span>
+<span class="source-line-no">168</span><span id="line-168">                    
    + checkOutResult.getProviderMessage() + " [" + 
checkOutResult.getCommandOutput() + "]");</span>
+<span class="source-line-no">169</span><span id="line-169">            }</span>
+<span class="source-line-no">170</span><span id="line-170">            final 
List&lt;File&gt; filesToRemove = 
Arrays.asList(distCleanupDirectory.listFiles());</span>
+<span class="source-line-no">171</span><span id="line-171">            if 
(filesToRemove.size() == 1) {</span>
+<span class="source-line-no">172</span><span id="line-172">                
getLog().info("No files to delete");</span>
+<span class="source-line-no">173</span><span id="line-173">                
return;</span>
+<span class="source-line-no">174</span><span id="line-174">            }</span>
+<span class="source-line-no">175</span><span id="line-175">            if 
(!dryRun) {</span>
+<span class="source-line-no">176</span><span id="line-176">                
final ScmFileSet fileSet = new ScmFileSet(distCleanupDirectory, 
filesToRemove);</span>
+<span class="source-line-no">177</span><span id="line-177">                
final RemoveScmResult removeScmResult = provider.remove(repository, 
fileSet,</span>
+<span class="source-line-no">178</span><span id="line-178">                    
    "Cleaning up staging area");</span>
+<span class="source-line-no">179</span><span id="line-179">                if 
(!removeScmResult.isSuccess()) {</span>
+<span class="source-line-no">180</span><span id="line-180">                    
throw new MojoFailureException("Failed to remove files from SCM: "</span>
+<span class="source-line-no">181</span><span id="line-181">                    
        + removeScmResult.getProviderMessage()</span>
+<span class="source-line-no">182</span><span id="line-182">                    
        + " [" + removeScmResult.getCommandOutput() + "]");</span>
+<span class="source-line-no">183</span><span id="line-183">                
}</span>
+<span class="source-line-no">184</span><span id="line-184">                
getLog().info("Cleaning distribution area for: " + 
project.getArtifactId());</span>
+<span class="source-line-no">185</span><span id="line-185">                
final CheckInScmResult checkInResult = provider.checkIn(</span>
+<span class="source-line-no">186</span><span id="line-186">                    
    repository,</span>
+<span class="source-line-no">187</span><span id="line-187">                    
    fileSet,</span>
+<span class="source-line-no">188</span><span id="line-188">                    
    "Cleaning distribution area for: " + project.getArtifactId()</span>
+<span class="source-line-no">189</span><span id="line-189">                
);</span>
+<span class="source-line-no">190</span><span id="line-190">                if 
(!checkInResult.isSuccess()) {</span>
+<span class="source-line-no">191</span><span id="line-191">                    
throw new MojoFailureException("Failed to commit files: " + 
removeScmResult.getProviderMessage()</span>
+<span class="source-line-no">192</span><span id="line-192">                    
        + " [" + removeScmResult.getCommandOutput() + "]");</span>
+<span class="source-line-no">193</span><span id="line-193">                
}</span>
+<span class="source-line-no">194</span><span id="line-194">            } else 
{</span>
+<span class="source-line-no">195</span><span id="line-195">                
getLog().info("Would have attempted to delete files from: " + 
distSvnStagingUrl);</span>
+<span class="source-line-no">196</span><span id="line-196">            }</span>
+<span class="source-line-no">197</span><span id="line-197">        } catch 
(final ScmException e) {</span>
+<span class="source-line-no">198</span><span id="line-198">            throw 
new MojoFailureException(e.getMessage());</span>
+<span class="source-line-no">199</span><span id="line-199">        }</span>
+<span class="source-line-no">200</span><span id="line-200"></span>
+<span class="source-line-no">201</span><span id="line-201">    }</span>
+<span class="source-line-no">202</span><span id="line-202">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>

Added: 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html
==============================================================================
--- 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html
 (added)
+++ 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html
 Sun Nov  3 20:07:40 2024
@@ -0,0 +1,165 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: 
org.apache.commons.release.plugin.velocity, class: HeaderHtmlVelocityDelegate, 
class: HeaderHtmlVelocityDelegateBuilder">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" 
href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the 
Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor 
license agreements.  See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for 
additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses 
this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); 
you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License.  You 
may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> *      
http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required 
by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under 
the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT 
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License 
for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under 
the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package 
org.apache.commons.release.plugin.velocity;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import 
java.io.Writer;</span>
+<span class="source-line-no">020</span><span id="line-20"></span>
+<span class="source-line-no">021</span><span id="line-21">import 
org.apache.velocity.Template;</span>
+<span class="source-line-no">022</span><span id="line-22">import 
org.apache.velocity.VelocityContext;</span>
+<span class="source-line-no">023</span><span id="line-23">import 
org.apache.velocity.app.VelocityEngine;</span>
+<span class="source-line-no">024</span><span id="line-24">import 
org.apache.velocity.runtime.RuntimeConstants;</span>
+<span class="source-line-no">025</span><span id="line-25">import 
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</span>
+<span class="source-line-no">026</span><span id="line-26"></span>
+<span class="source-line-no">027</span><span id="line-27">/**</span>
+<span class="source-line-no">028</span><span id="line-28"> * This class' 
purpose is to generate the &lt;code&gt;HEADER.html&lt;/code&gt; that moves 
along with the</span>
+<span class="source-line-no">029</span><span id="line-29"> * release for the 
sake of downloading the release from the distribution area.</span>
+<span class="source-line-no">030</span><span id="line-30"> *</span>
+<span class="source-line-no">031</span><span id="line-31"> * @since 1.3</span>
+<span class="source-line-no">032</span><span id="line-32"> */</span>
+<span class="source-line-no">033</span><span id="line-33">public class 
HeaderHtmlVelocityDelegate {</span>
+<span class="source-line-no">034</span><span id="line-34"></span>
+<span class="source-line-no">035</span><span id="line-35">    /** The location 
of the velocity template for this class. */</span>
+<span class="source-line-no">036</span><span id="line-36">    private static 
final String TEMPLATE = 
"resources/org/apache/commons/release/plugin/velocity/HEADER.vm";</span>
+<span class="source-line-no">037</span><span id="line-37"></span>
+<span class="source-line-no">038</span><span id="line-38">    /** The private 
constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. 
*/</span>
+<span class="source-line-no">039</span><span id="line-39">    private 
HeaderHtmlVelocityDelegate() {</span>
+<span class="source-line-no">040</span><span id="line-40">    }</span>
+<span class="source-line-no">041</span><span id="line-41"></span>
+<span class="source-line-no">042</span><span id="line-42">    /**</span>
+<span class="source-line-no">043</span><span id="line-43">     * For 
instantiating our {@link HeaderHtmlVelocityDelegate} using the {@link 
HeaderHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">044</span><span id="line-44">     *</span>
+<span class="source-line-no">045</span><span id="line-45">     * @return a 
{@link HeaderHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">046</span><span id="line-46">     */</span>
+<span class="source-line-no">047</span><span id="line-47">    public static 
HeaderHtmlVelocityDelegateBuilder builder() {</span>
+<span class="source-line-no">048</span><span id="line-48">        return new 
HeaderHtmlVelocityDelegateBuilder();</span>
+<span class="source-line-no">049</span><span id="line-49">    }</span>
+<span class="source-line-no">050</span><span id="line-50"></span>
+<span class="source-line-no">051</span><span id="line-51">    /**</span>
+<span class="source-line-no">052</span><span id="line-52">     * Builds the 
HEADER.vm velocity template to the writer passed in.</span>
+<span class="source-line-no">053</span><span id="line-53">     *</span>
+<span class="source-line-no">054</span><span id="line-54">     * @param writer 
any {@link Writer} that we wish to have the filled velocity template written 
to.</span>
+<span class="source-line-no">055</span><span id="line-55">     * @return the 
{@link Writer} that we've filled out the template into.</span>
+<span class="source-line-no">056</span><span id="line-56">     */</span>
+<span class="source-line-no">057</span><span id="line-57">    public Writer 
render(final Writer writer) {</span>
+<span class="source-line-no">058</span><span id="line-58">        final 
VelocityEngine ve = new VelocityEngine();</span>
+<span class="source-line-no">059</span><span id="line-59">        
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</span>
+<span class="source-line-no">060</span><span id="line-60">        
ve.setProperty("classpath.resource.loader.class", 
ClasspathResourceLoader.class.getName());</span>
+<span class="source-line-no">061</span><span id="line-61">        
ve.init();</span>
+<span class="source-line-no">062</span><span id="line-62">        final 
Template template = ve.getTemplate(TEMPLATE);</span>
+<span class="source-line-no">063</span><span id="line-63">        final 
VelocityContext context = new VelocityContext();</span>
+<span class="source-line-no">064</span><span id="line-64">        
template.merge(context, writer);</span>
+<span class="source-line-no">065</span><span id="line-65">        return 
writer;</span>
+<span class="source-line-no">066</span><span id="line-66">    }</span>
+<span class="source-line-no">067</span><span id="line-67"></span>
+<span class="source-line-no">068</span><span id="line-68">    /**</span>
+<span class="source-line-no">069</span><span id="line-69">     * A builder 
class for instantiation of the {@link HeaderHtmlVelocityDelegate}.</span>
+<span class="source-line-no">070</span><span id="line-70">     */</span>
+<span class="source-line-no">071</span><span id="line-71">    public static 
class HeaderHtmlVelocityDelegateBuilder {</span>
+<span class="source-line-no">072</span><span id="line-72"></span>
+<span class="source-line-no">073</span><span id="line-73">        /**</span>
+<span class="source-line-no">074</span><span id="line-74">         * Private 
constructor so that we can have a proper builder pattern.</span>
+<span class="source-line-no">075</span><span id="line-75">         */</span>
+<span class="source-line-no">076</span><span id="line-76">        private 
HeaderHtmlVelocityDelegateBuilder() {</span>
+<span class="source-line-no">077</span><span id="line-77">        }</span>
+<span class="source-line-no">078</span><span id="line-78"></span>
+<span class="source-line-no">079</span><span id="line-79">        /**</span>
+<span class="source-line-no">080</span><span id="line-80">         * Builds up 
the {@link ReadmeHtmlVelocityDelegate} from the previously set 
parameters.</span>
+<span class="source-line-no">081</span><span id="line-81">         * @return a 
new {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">082</span><span id="line-82">         */</span>
+<span class="source-line-no">083</span><span id="line-83">        public 
HeaderHtmlVelocityDelegate build() {</span>
+<span class="source-line-no">084</span><span id="line-84">            return 
new HeaderHtmlVelocityDelegate();</span>
+<span class="source-line-no">085</span><span id="line-85">        }</span>
+<span class="source-line-no">086</span><span id="line-86">    }</span>
+<span class="source-line-no">087</span><span id="line-87">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>

Added: 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html
==============================================================================
--- 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html
 (added)
+++ 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html
 Sun Nov  3 20:07:40 2024
@@ -0,0 +1,165 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: 
org.apache.commons.release.plugin.velocity, class: HeaderHtmlVelocityDelegate">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" 
href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the 
Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor 
license agreements.  See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for 
additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses 
this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); 
you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License.  You 
may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> *      
http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required 
by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under 
the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT 
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License 
for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under 
the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package 
org.apache.commons.release.plugin.velocity;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import 
java.io.Writer;</span>
+<span class="source-line-no">020</span><span id="line-20"></span>
+<span class="source-line-no">021</span><span id="line-21">import 
org.apache.velocity.Template;</span>
+<span class="source-line-no">022</span><span id="line-22">import 
org.apache.velocity.VelocityContext;</span>
+<span class="source-line-no">023</span><span id="line-23">import 
org.apache.velocity.app.VelocityEngine;</span>
+<span class="source-line-no">024</span><span id="line-24">import 
org.apache.velocity.runtime.RuntimeConstants;</span>
+<span class="source-line-no">025</span><span id="line-25">import 
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</span>
+<span class="source-line-no">026</span><span id="line-26"></span>
+<span class="source-line-no">027</span><span id="line-27">/**</span>
+<span class="source-line-no">028</span><span id="line-28"> * This class' 
purpose is to generate the &lt;code&gt;HEADER.html&lt;/code&gt; that moves 
along with the</span>
+<span class="source-line-no">029</span><span id="line-29"> * release for the 
sake of downloading the release from the distribution area.</span>
+<span class="source-line-no">030</span><span id="line-30"> *</span>
+<span class="source-line-no">031</span><span id="line-31"> * @since 1.3</span>
+<span class="source-line-no">032</span><span id="line-32"> */</span>
+<span class="source-line-no">033</span><span id="line-33">public class 
HeaderHtmlVelocityDelegate {</span>
+<span class="source-line-no">034</span><span id="line-34"></span>
+<span class="source-line-no">035</span><span id="line-35">    /** The location 
of the velocity template for this class. */</span>
+<span class="source-line-no">036</span><span id="line-36">    private static 
final String TEMPLATE = 
"resources/org/apache/commons/release/plugin/velocity/HEADER.vm";</span>
+<span class="source-line-no">037</span><span id="line-37"></span>
+<span class="source-line-no">038</span><span id="line-38">    /** The private 
constructor to be used by the {@link HeaderHtmlVelocityDelegateBuilder}. 
*/</span>
+<span class="source-line-no">039</span><span id="line-39">    private 
HeaderHtmlVelocityDelegate() {</span>
+<span class="source-line-no">040</span><span id="line-40">    }</span>
+<span class="source-line-no">041</span><span id="line-41"></span>
+<span class="source-line-no">042</span><span id="line-42">    /**</span>
+<span class="source-line-no">043</span><span id="line-43">     * For 
instantiating our {@link HeaderHtmlVelocityDelegate} using the {@link 
HeaderHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">044</span><span id="line-44">     *</span>
+<span class="source-line-no">045</span><span id="line-45">     * @return a 
{@link HeaderHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">046</span><span id="line-46">     */</span>
+<span class="source-line-no">047</span><span id="line-47">    public static 
HeaderHtmlVelocityDelegateBuilder builder() {</span>
+<span class="source-line-no">048</span><span id="line-48">        return new 
HeaderHtmlVelocityDelegateBuilder();</span>
+<span class="source-line-no">049</span><span id="line-49">    }</span>
+<span class="source-line-no">050</span><span id="line-50"></span>
+<span class="source-line-no">051</span><span id="line-51">    /**</span>
+<span class="source-line-no">052</span><span id="line-52">     * Builds the 
HEADER.vm velocity template to the writer passed in.</span>
+<span class="source-line-no">053</span><span id="line-53">     *</span>
+<span class="source-line-no">054</span><span id="line-54">     * @param writer 
any {@link Writer} that we wish to have the filled velocity template written 
to.</span>
+<span class="source-line-no">055</span><span id="line-55">     * @return the 
{@link Writer} that we've filled out the template into.</span>
+<span class="source-line-no">056</span><span id="line-56">     */</span>
+<span class="source-line-no">057</span><span id="line-57">    public Writer 
render(final Writer writer) {</span>
+<span class="source-line-no">058</span><span id="line-58">        final 
VelocityEngine ve = new VelocityEngine();</span>
+<span class="source-line-no">059</span><span id="line-59">        
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</span>
+<span class="source-line-no">060</span><span id="line-60">        
ve.setProperty("classpath.resource.loader.class", 
ClasspathResourceLoader.class.getName());</span>
+<span class="source-line-no">061</span><span id="line-61">        
ve.init();</span>
+<span class="source-line-no">062</span><span id="line-62">        final 
Template template = ve.getTemplate(TEMPLATE);</span>
+<span class="source-line-no">063</span><span id="line-63">        final 
VelocityContext context = new VelocityContext();</span>
+<span class="source-line-no">064</span><span id="line-64">        
template.merge(context, writer);</span>
+<span class="source-line-no">065</span><span id="line-65">        return 
writer;</span>
+<span class="source-line-no">066</span><span id="line-66">    }</span>
+<span class="source-line-no">067</span><span id="line-67"></span>
+<span class="source-line-no">068</span><span id="line-68">    /**</span>
+<span class="source-line-no">069</span><span id="line-69">     * A builder 
class for instantiation of the {@link HeaderHtmlVelocityDelegate}.</span>
+<span class="source-line-no">070</span><span id="line-70">     */</span>
+<span class="source-line-no">071</span><span id="line-71">    public static 
class HeaderHtmlVelocityDelegateBuilder {</span>
+<span class="source-line-no">072</span><span id="line-72"></span>
+<span class="source-line-no">073</span><span id="line-73">        /**</span>
+<span class="source-line-no">074</span><span id="line-74">         * Private 
constructor so that we can have a proper builder pattern.</span>
+<span class="source-line-no">075</span><span id="line-75">         */</span>
+<span class="source-line-no">076</span><span id="line-76">        private 
HeaderHtmlVelocityDelegateBuilder() {</span>
+<span class="source-line-no">077</span><span id="line-77">        }</span>
+<span class="source-line-no">078</span><span id="line-78"></span>
+<span class="source-line-no">079</span><span id="line-79">        /**</span>
+<span class="source-line-no">080</span><span id="line-80">         * Builds up 
the {@link ReadmeHtmlVelocityDelegate} from the previously set 
parameters.</span>
+<span class="source-line-no">081</span><span id="line-81">         * @return a 
new {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">082</span><span id="line-82">         */</span>
+<span class="source-line-no">083</span><span id="line-83">        public 
HeaderHtmlVelocityDelegate build() {</span>
+<span class="source-line-no">084</span><span id="line-84">            return 
new HeaderHtmlVelocityDelegate();</span>
+<span class="source-line-no">085</span><span id="line-85">        }</span>
+<span class="source-line-no">086</span><span id="line-86">    }</span>
+<span class="source-line-no">087</span><span id="line-87">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>

Added: 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html
==============================================================================
--- 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html
 (added)
+++ 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html
 Sun Nov  3 20:07:40 2024
@@ -0,0 +1,240 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: 
org.apache.commons.release.plugin.velocity, class: ReadmeHtmlVelocityDelegate, 
class: ReadmeHtmlVelocityDelegateBuilder">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" 
href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the 
Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor 
license agreements.  See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for 
additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses 
this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); 
you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License.  You 
may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> *      
http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required 
by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under 
the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT 
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License 
for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under 
the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package 
org.apache.commons.release.plugin.velocity;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import 
java.io.Writer;</span>
+<span class="source-line-no">020</span><span id="line-20"></span>
+<span class="source-line-no">021</span><span id="line-21">import 
org.apache.commons.lang3.StringUtils;</span>
+<span class="source-line-no">022</span><span id="line-22">import 
org.apache.velocity.Template;</span>
+<span class="source-line-no">023</span><span id="line-23">import 
org.apache.velocity.VelocityContext;</span>
+<span class="source-line-no">024</span><span id="line-24">import 
org.apache.velocity.app.VelocityEngine;</span>
+<span class="source-line-no">025</span><span id="line-25">import 
org.apache.velocity.runtime.RuntimeConstants;</span>
+<span class="source-line-no">026</span><span id="line-26">import 
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</span>
+<span class="source-line-no">027</span><span id="line-27"></span>
+<span class="source-line-no">028</span><span id="line-28">/**</span>
+<span class="source-line-no">029</span><span id="line-29"> * This class' 
purpose is to generate the &lt;code&gt;README.html&lt;/code&gt; that moves 
along with the</span>
+<span class="source-line-no">030</span><span id="line-30"> * release for the 
sake of downloading the release from the distribution area.</span>
+<span class="source-line-no">031</span><span id="line-31"> *</span>
+<span class="source-line-no">032</span><span id="line-32"> * @since 1.3</span>
+<span class="source-line-no">033</span><span id="line-33"> */</span>
+<span class="source-line-no">034</span><span id="line-34">public class 
ReadmeHtmlVelocityDelegate {</span>
+<span class="source-line-no">035</span><span id="line-35">    /** The location 
of the velocity template for this class. */</span>
+<span class="source-line-no">036</span><span id="line-36">    private static 
final String TEMPLATE = "resources/org/apache/commons/release/plugin"</span>
+<span class="source-line-no">037</span><span id="line-37">                     
                    + "/velocity/README.vm";</span>
+<span class="source-line-no">038</span><span id="line-38">    /** This is 
supposed to represent the maven artifactId. */</span>
+<span class="source-line-no">039</span><span id="line-39">    private final 
String artifactId;</span>
+<span class="source-line-no">040</span><span id="line-40">    /** This is 
supposed to represent the maven version of the release. */</span>
+<span class="source-line-no">041</span><span id="line-41">    private final 
String version;</span>
+<span class="source-line-no">042</span><span id="line-42">    /** The url of 
the site that gets set into the &lt;code&gt;README.html&lt;/code&gt;. */</span>
+<span class="source-line-no">043</span><span id="line-43">    private final 
String siteUrl;</span>
+<span class="source-line-no">044</span><span id="line-44"></span>
+<span class="source-line-no">045</span><span id="line-45">    /**</span>
+<span class="source-line-no">046</span><span id="line-46">     * The private 
constructor to be used by the {@link ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">047</span><span id="line-47">     *</span>
+<span class="source-line-no">048</span><span id="line-48">     * @param 
artifactId sets the {@link ReadmeHtmlVelocityDelegate#artifactId}.</span>
+<span class="source-line-no">049</span><span id="line-49">     * @param 
version sets the {@link ReadmeHtmlVelocityDelegate#version}.</span>
+<span class="source-line-no">050</span><span id="line-50">     * @param 
siteUrl sets the {@link ReadmeHtmlVelocityDelegate#siteUrl}.</span>
+<span class="source-line-no">051</span><span id="line-51">     */</span>
+<span class="source-line-no">052</span><span id="line-52">    private 
ReadmeHtmlVelocityDelegate(final String artifactId, final String version, final 
String siteUrl) {</span>
+<span class="source-line-no">053</span><span id="line-53">        
this.artifactId = artifactId;</span>
+<span class="source-line-no">054</span><span id="line-54">        this.version 
= version;</span>
+<span class="source-line-no">055</span><span id="line-55">        this.siteUrl 
= siteUrl;</span>
+<span class="source-line-no">056</span><span id="line-56">    }</span>
+<span class="source-line-no">057</span><span id="line-57"></span>
+<span class="source-line-no">058</span><span id="line-58">    /**</span>
+<span class="source-line-no">059</span><span id="line-59">     * Gets the 
{@link ReadmeHtmlVelocityDelegateBuilder} for constructing the {@link 
ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">060</span><span id="line-60">     *</span>
+<span class="source-line-no">061</span><span id="line-61">     * @return the 
{@link ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">062</span><span id="line-62">     */</span>
+<span class="source-line-no">063</span><span id="line-63">    public static 
ReadmeHtmlVelocityDelegateBuilder builder() {</span>
+<span class="source-line-no">064</span><span id="line-64">        return new 
ReadmeHtmlVelocityDelegateBuilder();</span>
+<span class="source-line-no">065</span><span id="line-65">    }</span>
+<span class="source-line-no">066</span><span id="line-66"></span>
+<span class="source-line-no">067</span><span id="line-67">    /**</span>
+<span class="source-line-no">068</span><span id="line-68">     * Renders the 
&lt;code&gt;README.vm&lt;/code&gt; velocity template with the variables 
constructed with the</span>
+<span class="source-line-no">069</span><span id="line-69">     * {@link 
ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">070</span><span id="line-70">     *</span>
+<span class="source-line-no">071</span><span id="line-71">     * @param writer 
is the {@link Writer} to which we wish to render the 
&lt;code&gt;README.vm&lt;/code&gt; template.</span>
+<span class="source-line-no">072</span><span id="line-72">     * @return a 
reference to the {@link Writer} passed in.</span>
+<span class="source-line-no">073</span><span id="line-73">     */</span>
+<span class="source-line-no">074</span><span id="line-74">    public Writer 
render(final Writer writer) {</span>
+<span class="source-line-no">075</span><span id="line-75">        final 
VelocityEngine ve = new VelocityEngine();</span>
+<span class="source-line-no">076</span><span id="line-76">        
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</span>
+<span class="source-line-no">077</span><span id="line-77">        
ve.setProperty("classpath.resource.loader.class", 
ClasspathResourceLoader.class.getName());</span>
+<span class="source-line-no">078</span><span id="line-78">        
ve.init();</span>
+<span class="source-line-no">079</span><span id="line-79">        final 
Template template = ve.getTemplate(TEMPLATE);</span>
+<span class="source-line-no">080</span><span id="line-80">        final 
String[] splitArtifactId = artifactId.split("-");</span>
+<span class="source-line-no">081</span><span id="line-81">        final String 
wordCommons = "commons";</span>
+<span class="source-line-no">082</span><span id="line-82">        String 
artifactShortName = "";</span>
+<span class="source-line-no">083</span><span id="line-83">        if 
(splitArtifactId.length &gt; 1) {</span>
+<span class="source-line-no">084</span><span id="line-84">            
artifactShortName = splitArtifactId[1];</span>
+<span class="source-line-no">085</span><span id="line-85">        } else if 
(splitArtifactId.length == 1) {</span>
+<span class="source-line-no">086</span><span id="line-86">            
artifactShortName = splitArtifactId[0];</span>
+<span class="source-line-no">087</span><span id="line-87">        }</span>
+<span class="source-line-no">088</span><span id="line-88">        // ".+\\d$" 
matches a non-empty string that terminates in a digit {0-9}.</span>
+<span class="source-line-no">089</span><span id="line-89">        if 
(artifactShortName.matches(".+\\d$")) {</span>
+<span class="source-line-no">090</span><span id="line-90">            
artifactShortName = artifactShortName.substring(0, artifactShortName.length() - 
1);</span>
+<span class="source-line-no">091</span><span id="line-91">        }</span>
+<span class="source-line-no">092</span><span id="line-92">        final String 
artifactIdWithFirstLetterscapitalized =</span>
+<span class="source-line-no">093</span><span id="line-93">                
StringUtils.capitalize(wordCommons)</span>
+<span class="source-line-no">094</span><span id="line-94">                     
   + "-"</span>
+<span class="source-line-no">095</span><span id="line-95">                     
   + artifactShortName.toUpperCase();</span>
+<span class="source-line-no">096</span><span id="line-96">        final 
VelocityContext context = new VelocityContext();</span>
+<span class="source-line-no">097</span><span id="line-97">        
context.internalPut("artifactIdWithFirstLetterscapitalized", 
artifactIdWithFirstLetterscapitalized);</span>
+<span class="source-line-no">098</span><span id="line-98">        
context.internalPut("artifactShortName", 
artifactShortName.toUpperCase());</span>
+<span class="source-line-no">099</span><span id="line-99">        
context.internalPut("artifactId", artifactId);</span>
+<span class="source-line-no">100</span><span id="line-100">        
context.internalPut("version", version);</span>
+<span class="source-line-no">101</span><span id="line-101">        
context.internalPut("siteUrl", siteUrl);</span>
+<span class="source-line-no">102</span><span id="line-102">        
template.merge(context, writer);</span>
+<span class="source-line-no">103</span><span id="line-103">        return 
writer;</span>
+<span class="source-line-no">104</span><span id="line-104">    }</span>
+<span class="source-line-no">105</span><span id="line-105"></span>
+<span class="source-line-no">106</span><span id="line-106">    /**</span>
+<span class="source-line-no">107</span><span id="line-107">     * A builder 
class for instantiation of the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">108</span><span id="line-108">     */</span>
+<span class="source-line-no">109</span><span id="line-109">    public static 
class ReadmeHtmlVelocityDelegateBuilder {</span>
+<span class="source-line-no">110</span><span id="line-110">        /** The 
maven artifactId to use in the &lt;code&gt;README.vm&lt;/code&gt; template. 
*/</span>
+<span class="source-line-no">111</span><span id="line-111">        private 
String artifactId;</span>
+<span class="source-line-no">112</span><span id="line-112">        /** The 
maven version to use in the &lt;code&gt;README.vm&lt;/code&gt; template. 
*/</span>
+<span class="source-line-no">113</span><span id="line-113">        private 
String version;</span>
+<span class="source-line-no">114</span><span id="line-114">        /** The 
site url to use in the &lt;code&gt;README.vm&lt;/code&gt; template. */</span>
+<span class="source-line-no">115</span><span id="line-115">        private 
String siteUrl;</span>
+<span class="source-line-no">116</span><span id="line-116"></span>
+<span class="source-line-no">117</span><span id="line-117">        /**</span>
+<span class="source-line-no">118</span><span id="line-118">         * Private 
constructor for using the builder through the {@link 
ReadmeHtmlVelocityDelegate#builder()}</span>
+<span class="source-line-no">119</span><span id="line-119">         * 
method.</span>
+<span class="source-line-no">120</span><span id="line-120">         */</span>
+<span class="source-line-no">121</span><span id="line-121">        private 
ReadmeHtmlVelocityDelegateBuilder() {</span>
+<span class="source-line-no">122</span><span id="line-122">        }</span>
+<span class="source-line-no">123</span><span id="line-123"></span>
+<span class="source-line-no">124</span><span id="line-124">        /**</span>
+<span class="source-line-no">125</span><span id="line-125">         * Adds the 
artifactId to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">126</span><span id="line-126">         * @param 
artifactId the {@link String} representing the maven artifactId.</span>
+<span class="source-line-no">127</span><span id="line-127">         * @return 
the builder to continue building.</span>
+<span class="source-line-no">128</span><span id="line-128">         */</span>
+<span class="source-line-no">129</span><span id="line-129">        public 
ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) 
{</span>
+<span class="source-line-no">130</span><span id="line-130">            
this.artifactId = artifactId;</span>
+<span class="source-line-no">131</span><span id="line-131">            return 
this;</span>
+<span class="source-line-no">132</span><span id="line-132">        }</span>
+<span class="source-line-no">133</span><span id="line-133"></span>
+<span class="source-line-no">134</span><span id="line-134">        /**</span>
+<span class="source-line-no">135</span><span id="line-135">         * Adds the 
version to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">136</span><span id="line-136">         * @param 
version the maven version.</span>
+<span class="source-line-no">137</span><span id="line-137">         * @return 
the builder to continue building.</span>
+<span class="source-line-no">138</span><span id="line-138">         */</span>
+<span class="source-line-no">139</span><span id="line-139">        public 
ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {</span>
+<span class="source-line-no">140</span><span id="line-140">            
this.version = version;</span>
+<span class="source-line-no">141</span><span id="line-141">            return 
this;</span>
+<span class="source-line-no">142</span><span id="line-142">        }</span>
+<span class="source-line-no">143</span><span id="line-143"></span>
+<span class="source-line-no">144</span><span id="line-144">        /**</span>
+<span class="source-line-no">145</span><span id="line-145">         * Adds the 
siteUrl to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">146</span><span id="line-146">         * @param 
siteUrl the site url to be used in the 
&lt;code&gt;README.html&lt;/code&gt;</span>
+<span class="source-line-no">147</span><span id="line-147">         * @return 
the builder to continue building.</span>
+<span class="source-line-no">148</span><span id="line-148">         */</span>
+<span class="source-line-no">149</span><span id="line-149">        public 
ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {</span>
+<span class="source-line-no">150</span><span id="line-150">            
this.siteUrl = siteUrl;</span>
+<span class="source-line-no">151</span><span id="line-151">            return 
this;</span>
+<span class="source-line-no">152</span><span id="line-152">        }</span>
+<span class="source-line-no">153</span><span id="line-153"></span>
+<span class="source-line-no">154</span><span id="line-154">        /**</span>
+<span class="source-line-no">155</span><span id="line-155">         * Builds 
up the {@link ReadmeHtmlVelocityDelegate} from the previously set 
parameters.</span>
+<span class="source-line-no">156</span><span id="line-156">         * @return 
a new {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">157</span><span id="line-157">         */</span>
+<span class="source-line-no">158</span><span id="line-158">        public 
ReadmeHtmlVelocityDelegate build() {</span>
+<span class="source-line-no">159</span><span id="line-159">            return 
new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, 
this.siteUrl);</span>
+<span class="source-line-no">160</span><span id="line-160">        }</span>
+<span class="source-line-no">161</span><span id="line-161">    }</span>
+<span class="source-line-no">162</span><span id="line-162">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>

Added: 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
==============================================================================
--- 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
 (added)
+++ 
dev/commons/release-plugin/1.8.3-RC1/site/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
 Sun Nov  3 20:07:40 2024
@@ -0,0 +1,240 @@
+<!DOCTYPE HTML>
+<html lang>
+<head>
+<!-- Generated by javadoc (17) -->
+<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package: 
org.apache.commons.release.plugin.velocity, class: ReadmeHtmlVelocityDelegate">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
+<link rel="stylesheet" type="text/css" 
href="../../../../../../../stylesheet.css" title="Style">
+</head>
+<body class="source-page">
+<main role="main">
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the 
Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor 
license agreements.  See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for 
additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses 
this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License"); 
you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License.  You 
may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> *      
http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required 
by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under 
the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT 
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License 
for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under 
the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package 
org.apache.commons.release.plugin.velocity;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import 
java.io.Writer;</span>
+<span class="source-line-no">020</span><span id="line-20"></span>
+<span class="source-line-no">021</span><span id="line-21">import 
org.apache.commons.lang3.StringUtils;</span>
+<span class="source-line-no">022</span><span id="line-22">import 
org.apache.velocity.Template;</span>
+<span class="source-line-no">023</span><span id="line-23">import 
org.apache.velocity.VelocityContext;</span>
+<span class="source-line-no">024</span><span id="line-24">import 
org.apache.velocity.app.VelocityEngine;</span>
+<span class="source-line-no">025</span><span id="line-25">import 
org.apache.velocity.runtime.RuntimeConstants;</span>
+<span class="source-line-no">026</span><span id="line-26">import 
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</span>
+<span class="source-line-no">027</span><span id="line-27"></span>
+<span class="source-line-no">028</span><span id="line-28">/**</span>
+<span class="source-line-no">029</span><span id="line-29"> * This class' 
purpose is to generate the &lt;code&gt;README.html&lt;/code&gt; that moves 
along with the</span>
+<span class="source-line-no">030</span><span id="line-30"> * release for the 
sake of downloading the release from the distribution area.</span>
+<span class="source-line-no">031</span><span id="line-31"> *</span>
+<span class="source-line-no">032</span><span id="line-32"> * @since 1.3</span>
+<span class="source-line-no">033</span><span id="line-33"> */</span>
+<span class="source-line-no">034</span><span id="line-34">public class 
ReadmeHtmlVelocityDelegate {</span>
+<span class="source-line-no">035</span><span id="line-35">    /** The location 
of the velocity template for this class. */</span>
+<span class="source-line-no">036</span><span id="line-36">    private static 
final String TEMPLATE = "resources/org/apache/commons/release/plugin"</span>
+<span class="source-line-no">037</span><span id="line-37">                     
                    + "/velocity/README.vm";</span>
+<span class="source-line-no">038</span><span id="line-38">    /** This is 
supposed to represent the maven artifactId. */</span>
+<span class="source-line-no">039</span><span id="line-39">    private final 
String artifactId;</span>
+<span class="source-line-no">040</span><span id="line-40">    /** This is 
supposed to represent the maven version of the release. */</span>
+<span class="source-line-no">041</span><span id="line-41">    private final 
String version;</span>
+<span class="source-line-no">042</span><span id="line-42">    /** The url of 
the site that gets set into the &lt;code&gt;README.html&lt;/code&gt;. */</span>
+<span class="source-line-no">043</span><span id="line-43">    private final 
String siteUrl;</span>
+<span class="source-line-no">044</span><span id="line-44"></span>
+<span class="source-line-no">045</span><span id="line-45">    /**</span>
+<span class="source-line-no">046</span><span id="line-46">     * The private 
constructor to be used by the {@link ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">047</span><span id="line-47">     *</span>
+<span class="source-line-no">048</span><span id="line-48">     * @param 
artifactId sets the {@link ReadmeHtmlVelocityDelegate#artifactId}.</span>
+<span class="source-line-no">049</span><span id="line-49">     * @param 
version sets the {@link ReadmeHtmlVelocityDelegate#version}.</span>
+<span class="source-line-no">050</span><span id="line-50">     * @param 
siteUrl sets the {@link ReadmeHtmlVelocityDelegate#siteUrl}.</span>
+<span class="source-line-no">051</span><span id="line-51">     */</span>
+<span class="source-line-no">052</span><span id="line-52">    private 
ReadmeHtmlVelocityDelegate(final String artifactId, final String version, final 
String siteUrl) {</span>
+<span class="source-line-no">053</span><span id="line-53">        
this.artifactId = artifactId;</span>
+<span class="source-line-no">054</span><span id="line-54">        this.version 
= version;</span>
+<span class="source-line-no">055</span><span id="line-55">        this.siteUrl 
= siteUrl;</span>
+<span class="source-line-no">056</span><span id="line-56">    }</span>
+<span class="source-line-no">057</span><span id="line-57"></span>
+<span class="source-line-no">058</span><span id="line-58">    /**</span>
+<span class="source-line-no">059</span><span id="line-59">     * Gets the 
{@link ReadmeHtmlVelocityDelegateBuilder} for constructing the {@link 
ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">060</span><span id="line-60">     *</span>
+<span class="source-line-no">061</span><span id="line-61">     * @return the 
{@link ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">062</span><span id="line-62">     */</span>
+<span class="source-line-no">063</span><span id="line-63">    public static 
ReadmeHtmlVelocityDelegateBuilder builder() {</span>
+<span class="source-line-no">064</span><span id="line-64">        return new 
ReadmeHtmlVelocityDelegateBuilder();</span>
+<span class="source-line-no">065</span><span id="line-65">    }</span>
+<span class="source-line-no">066</span><span id="line-66"></span>
+<span class="source-line-no">067</span><span id="line-67">    /**</span>
+<span class="source-line-no">068</span><span id="line-68">     * Renders the 
&lt;code&gt;README.vm&lt;/code&gt; velocity template with the variables 
constructed with the</span>
+<span class="source-line-no">069</span><span id="line-69">     * {@link 
ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">070</span><span id="line-70">     *</span>
+<span class="source-line-no">071</span><span id="line-71">     * @param writer 
is the {@link Writer} to which we wish to render the 
&lt;code&gt;README.vm&lt;/code&gt; template.</span>
+<span class="source-line-no">072</span><span id="line-72">     * @return a 
reference to the {@link Writer} passed in.</span>
+<span class="source-line-no">073</span><span id="line-73">     */</span>
+<span class="source-line-no">074</span><span id="line-74">    public Writer 
render(final Writer writer) {</span>
+<span class="source-line-no">075</span><span id="line-75">        final 
VelocityEngine ve = new VelocityEngine();</span>
+<span class="source-line-no">076</span><span id="line-76">        
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</span>
+<span class="source-line-no">077</span><span id="line-77">        
ve.setProperty("classpath.resource.loader.class", 
ClasspathResourceLoader.class.getName());</span>
+<span class="source-line-no">078</span><span id="line-78">        
ve.init();</span>
+<span class="source-line-no">079</span><span id="line-79">        final 
Template template = ve.getTemplate(TEMPLATE);</span>
+<span class="source-line-no">080</span><span id="line-80">        final 
String[] splitArtifactId = artifactId.split("-");</span>
+<span class="source-line-no">081</span><span id="line-81">        final String 
wordCommons = "commons";</span>
+<span class="source-line-no">082</span><span id="line-82">        String 
artifactShortName = "";</span>
+<span class="source-line-no">083</span><span id="line-83">        if 
(splitArtifactId.length &gt; 1) {</span>
+<span class="source-line-no">084</span><span id="line-84">            
artifactShortName = splitArtifactId[1];</span>
+<span class="source-line-no">085</span><span id="line-85">        } else if 
(splitArtifactId.length == 1) {</span>
+<span class="source-line-no">086</span><span id="line-86">            
artifactShortName = splitArtifactId[0];</span>
+<span class="source-line-no">087</span><span id="line-87">        }</span>
+<span class="source-line-no">088</span><span id="line-88">        // ".+\\d$" 
matches a non-empty string that terminates in a digit {0-9}.</span>
+<span class="source-line-no">089</span><span id="line-89">        if 
(artifactShortName.matches(".+\\d$")) {</span>
+<span class="source-line-no">090</span><span id="line-90">            
artifactShortName = artifactShortName.substring(0, artifactShortName.length() - 
1);</span>
+<span class="source-line-no">091</span><span id="line-91">        }</span>
+<span class="source-line-no">092</span><span id="line-92">        final String 
artifactIdWithFirstLetterscapitalized =</span>
+<span class="source-line-no">093</span><span id="line-93">                
StringUtils.capitalize(wordCommons)</span>
+<span class="source-line-no">094</span><span id="line-94">                     
   + "-"</span>
+<span class="source-line-no">095</span><span id="line-95">                     
   + artifactShortName.toUpperCase();</span>
+<span class="source-line-no">096</span><span id="line-96">        final 
VelocityContext context = new VelocityContext();</span>
+<span class="source-line-no">097</span><span id="line-97">        
context.internalPut("artifactIdWithFirstLetterscapitalized", 
artifactIdWithFirstLetterscapitalized);</span>
+<span class="source-line-no">098</span><span id="line-98">        
context.internalPut("artifactShortName", 
artifactShortName.toUpperCase());</span>
+<span class="source-line-no">099</span><span id="line-99">        
context.internalPut("artifactId", artifactId);</span>
+<span class="source-line-no">100</span><span id="line-100">        
context.internalPut("version", version);</span>
+<span class="source-line-no">101</span><span id="line-101">        
context.internalPut("siteUrl", siteUrl);</span>
+<span class="source-line-no">102</span><span id="line-102">        
template.merge(context, writer);</span>
+<span class="source-line-no">103</span><span id="line-103">        return 
writer;</span>
+<span class="source-line-no">104</span><span id="line-104">    }</span>
+<span class="source-line-no">105</span><span id="line-105"></span>
+<span class="source-line-no">106</span><span id="line-106">    /**</span>
+<span class="source-line-no">107</span><span id="line-107">     * A builder 
class for instantiation of the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">108</span><span id="line-108">     */</span>
+<span class="source-line-no">109</span><span id="line-109">    public static 
class ReadmeHtmlVelocityDelegateBuilder {</span>
+<span class="source-line-no">110</span><span id="line-110">        /** The 
maven artifactId to use in the &lt;code&gt;README.vm&lt;/code&gt; template. 
*/</span>
+<span class="source-line-no">111</span><span id="line-111">        private 
String artifactId;</span>
+<span class="source-line-no">112</span><span id="line-112">        /** The 
maven version to use in the &lt;code&gt;README.vm&lt;/code&gt; template. 
*/</span>
+<span class="source-line-no">113</span><span id="line-113">        private 
String version;</span>
+<span class="source-line-no">114</span><span id="line-114">        /** The 
site url to use in the &lt;code&gt;README.vm&lt;/code&gt; template. */</span>
+<span class="source-line-no">115</span><span id="line-115">        private 
String siteUrl;</span>
+<span class="source-line-no">116</span><span id="line-116"></span>
+<span class="source-line-no">117</span><span id="line-117">        /**</span>
+<span class="source-line-no">118</span><span id="line-118">         * Private 
constructor for using the builder through the {@link 
ReadmeHtmlVelocityDelegate#builder()}</span>
+<span class="source-line-no">119</span><span id="line-119">         * 
method.</span>
+<span class="source-line-no">120</span><span id="line-120">         */</span>
+<span class="source-line-no">121</span><span id="line-121">        private 
ReadmeHtmlVelocityDelegateBuilder() {</span>
+<span class="source-line-no">122</span><span id="line-122">        }</span>
+<span class="source-line-no">123</span><span id="line-123"></span>
+<span class="source-line-no">124</span><span id="line-124">        /**</span>
+<span class="source-line-no">125</span><span id="line-125">         * Adds the 
artifactId to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">126</span><span id="line-126">         * @param 
artifactId the {@link String} representing the maven artifactId.</span>
+<span class="source-line-no">127</span><span id="line-127">         * @return 
the builder to continue building.</span>
+<span class="source-line-no">128</span><span id="line-128">         */</span>
+<span class="source-line-no">129</span><span id="line-129">        public 
ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) 
{</span>
+<span class="source-line-no">130</span><span id="line-130">            
this.artifactId = artifactId;</span>
+<span class="source-line-no">131</span><span id="line-131">            return 
this;</span>
+<span class="source-line-no">132</span><span id="line-132">        }</span>
+<span class="source-line-no">133</span><span id="line-133"></span>
+<span class="source-line-no">134</span><span id="line-134">        /**</span>
+<span class="source-line-no">135</span><span id="line-135">         * Adds the 
version to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">136</span><span id="line-136">         * @param 
version the maven version.</span>
+<span class="source-line-no">137</span><span id="line-137">         * @return 
the builder to continue building.</span>
+<span class="source-line-no">138</span><span id="line-138">         */</span>
+<span class="source-line-no">139</span><span id="line-139">        public 
ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {</span>
+<span class="source-line-no">140</span><span id="line-140">            
this.version = version;</span>
+<span class="source-line-no">141</span><span id="line-141">            return 
this;</span>
+<span class="source-line-no">142</span><span id="line-142">        }</span>
+<span class="source-line-no">143</span><span id="line-143"></span>
+<span class="source-line-no">144</span><span id="line-144">        /**</span>
+<span class="source-line-no">145</span><span id="line-145">         * Adds the 
siteUrl to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">146</span><span id="line-146">         * @param 
siteUrl the site url to be used in the 
&lt;code&gt;README.html&lt;/code&gt;</span>
+<span class="source-line-no">147</span><span id="line-147">         * @return 
the builder to continue building.</span>
+<span class="source-line-no">148</span><span id="line-148">         */</span>
+<span class="source-line-no">149</span><span id="line-149">        public 
ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {</span>
+<span class="source-line-no">150</span><span id="line-150">            
this.siteUrl = siteUrl;</span>
+<span class="source-line-no">151</span><span id="line-151">            return 
this;</span>
+<span class="source-line-no">152</span><span id="line-152">        }</span>
+<span class="source-line-no">153</span><span id="line-153"></span>
+<span class="source-line-no">154</span><span id="line-154">        /**</span>
+<span class="source-line-no">155</span><span id="line-155">         * Builds 
up the {@link ReadmeHtmlVelocityDelegate} from the previously set 
parameters.</span>
+<span class="source-line-no">156</span><span id="line-156">         * @return 
a new {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">157</span><span id="line-157">         */</span>
+<span class="source-line-no">158</span><span id="line-158">        public 
ReadmeHtmlVelocityDelegate build() {</span>
+<span class="source-line-no">159</span><span id="line-159">            return 
new ReadmeHtmlVelocityDelegate(this.artifactId, this.version, 
this.siteUrl);</span>
+<span class="source-line-no">160</span><span id="line-160">        }</span>
+<span class="source-line-no">161</span><span id="line-161">    }</span>
+<span class="source-line-no">162</span><span id="line-162">}</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>


Reply via email to