Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html Sat Apr 20 14:51:39 2024 @@ -1,98 +1,103 @@ <!DOCTYPE HTML> <html lang="en"> <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> +<body class="source-page"> <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> +<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 <code>HEADER.html</code> 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>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html Sat Apr 20 14:51:39 2024 @@ -1,98 +1,103 @@ <!DOCTYPE HTML> <html lang="en"> <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> +<body class="source-page"> <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> +<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 <code>HEADER.html</code> 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> Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html Sat Apr 20 14:51:39 2024 @@ -1,173 +1,178 @@ <!DOCTYPE HTML> <html lang="en"> <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> +<body class="source-page"> <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> +<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 <code>README.html</code> 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 <code>README.html</code>. */</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 <code>README.vm</code> 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 <code>README.vm</code> 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 > 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 <code>README.vm</code> 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 <code>README.vm</code> 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 <code>README.vm</code> 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 <code>README.html</code></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>
