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