Modified:
maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/xref/org/apache/maven/plugins/javadoc/JavadocUtil.html
==============================================================================
---
maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/xref/org/apache/maven/plugins/javadoc/JavadocUtil.html
(original)
+++
maven/website/components/plugins-archives/maven-javadoc-plugin-LATEST/xref/org/apache/maven/plugins/javadoc/JavadocUtil.html
Wed Jul 17 13:36:14 2024
@@ -126,1418 +126,1442 @@
<a class="jxr_linenumber" name="L118" href="#L118">118</a>
+ <span class="jxr_string">"environment variable using -Xms:<size> and
-Xmx:<size>."</span>;
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em
class="jxr_javadoccomment"> * Method that removes the invalid directories
in the specified directories. <b>Note</b>: All elements in</em>
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em
class="jxr_javadoccomment"> * <code>dirs</code> could be an
absolute or relative against the project's base directory
<code>String</code> path.</em>
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em
class="jxr_javadoccomment"> * @param project the current Maven project not
null</em>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> * @param dirs the collection of
<code>String</code> directories path that will be validated.</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment"> * @return a List of valid
<code>String</code> directories absolute paths.</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Collection<Path> pruneDirs(MavenProject project, Collection<String>
dirs) {
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong
class="jxr_keyword">final</strong> Path projectBasedir =
project.getBasedir().toPath();
-<a class="jxr_linenumber" name="L130" href="#L130">130</a>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
Set<Path> pruned = <strong class="jxr_keyword">new</strong>
LinkedHashSet<>(dirs.size());
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong
class="jxr_keyword">for</strong> (String dir : dirs) {
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong
class="jxr_keyword">if</strong> (dir == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<strong class="jxr_keyword">continue</strong>;
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
-<a class="jxr_linenumber" name="L136" href="#L136">136</a>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> Path
directory = projectBasedir.resolve(dir);
-<a class="jxr_linenumber" name="L138" href="#L138">138</a>
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong
class="jxr_keyword">if</strong> (Files.isDirectory(directory)) {
-<a class="jxr_linenumber" name="L140" href="#L140">140</a>
pruned.add(directory.toAbsolutePath());
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
-<a class="jxr_linenumber" name="L143" href="#L143">143</a>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong
class="jxr_keyword">return</strong> pruned;
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em
class="jxr_javadoccomment"> * Method that removes invalid classpath
elements in the specified paths.</em>
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em
class="jxr_javadoccomment"> * <b>Note</b>: All elements in
{@code paths} could be absolute or relative against the project's base
directory.</em>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment"> * When pruning classpath elements, you can
optionally include files in the result, otherwise only directories are</em>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em
class="jxr_javadoccomment"> * permitted.</em>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment"> * @param project the current Maven project not
null</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> * @param paths the collection of paths that
will be validated</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> * @param includeFiles whether to include files
in the result as well</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em
class="jxr_javadoccomment"> * @return a list of valid classpath elements as
absolute paths</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Collection<Path> prunePaths(MavenProject project,
Collection<String> paths, <strong class="jxr_keyword">boolean</strong>
includeFiles) {
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong
class="jxr_keyword">final</strong> Path projectBasedir =
project.getBasedir().toPath();
+<a class="jxr_linenumber" name="L133" href="#L133">133</a>
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>
Set<Path> pruned = <strong class="jxr_keyword">new</strong>
LinkedHashSet<>(paths.size());
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong
class="jxr_keyword">for</strong> (String path : paths) {
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong
class="jxr_keyword">if</strong> (path == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L137" href="#L137">137</a>
<strong class="jxr_keyword">continue</strong>;
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
+<a class="jxr_linenumber" name="L139" href="#L139">139</a>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> Path
resolvedPath = projectBasedir.resolve(path);
+<a class="jxr_linenumber" name="L141" href="#L141">141</a>
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong
class="jxr_keyword">if</strong> (Files.isDirectory(resolvedPath) ||
includeFiles && Files.isRegularFile(resolvedPath)) {
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>
pruned.add(resolvedPath.toAbsolutePath());
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
<a class="jxr_linenumber" name="L146" href="#L146">146</a>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * Method that removes the invalid files in the
specified files. <b>Note</b>: All elements in
<code>files</code></em>
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> * should be an absolute
<code>String</code> path.</em>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> * @param files the list of
<code>String</code> files paths that will be validated.</em>
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment"> * @return a List of valid
<code>File</code> objects.</em>
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String>
pruneFiles(Collection<String> files) {
-<a class="jxr_linenumber" name="L155" href="#L155">155</a>
List<String> pruned = <strong class="jxr_keyword">new</strong>
ArrayList<>(files.size());
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong
class="jxr_keyword">for</strong> (String f : files) {
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong
class="jxr_keyword">if</strong> (!shouldPruneFile(f, pruned)) {
-<a class="jxr_linenumber" name="L158" href="#L158">158</a>
pruned.add(f);
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> }
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong
class="jxr_keyword">return</strong> pruned;
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
+<a class="jxr_linenumber" name="L149" href="#L149">149</a>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> * Method that removes the invalid classpath
directories in the specified directories.</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment"> * <b>Note</b>: All elements in
{@code dirs} could be absolute or relative against the project's base
directory.</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em
class="jxr_javadoccomment"> * @param project the current Maven project not
null</em>
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment"> * @param dirs the collection of directories
that will be validated</em>
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * @return a list of valid claspath elements as
absolute paths</em>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
Collection<Path> pruneDirs(MavenProject project, Collection<String>
dirs) {
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong
class="jxr_keyword">return</strong> prunePaths(project, dirs, false);
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong
class="jxr_keyword">return</strong> pruned;
-<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
-<a class="jxr_linenumber" name="L164" href="#L164">164</a>
-<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> * Determine whether a file should be excluded
from the provided list of paths, based on whether it exists and is</em>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * already present in the list.</em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * @param f The files.</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> * @param pruned The list of pruned files..</em>
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> * @return true if the file could be pruned
false otherwise.</em>
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">boolean</strong> shouldPruneFile(String f,
List<String> pruned) {
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong
class="jxr_keyword">if</strong> (f != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong
class="jxr_keyword">if</strong> (Files.isRegularFile(Paths.get(f)) &&
!pruned.contains(f)) {
-<a class="jxr_linenumber" name="L176" href="#L176">176</a>
<strong class="jxr_keyword">return</strong> false;
-<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> * Method that removes the invalid files in the
specified files. <b>Note</b>: All elements in
<code>files</code></em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment"> * should be an absolute
<code>String</code> path.</em>
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> * @param files the list of
<code>String</code> files paths that will be validated.</em>
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * @return a List of valid
<code>File</code> objects.</em>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String>
pruneFiles(Collection<String> files) {
+<a class="jxr_linenumber" name="L170" href="#L170">170</a>
List<String> pruned = <strong class="jxr_keyword">new</strong>
ArrayList<>(files.size());
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong
class="jxr_keyword">for</strong> (String f : files) {
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong
class="jxr_keyword">if</strong> (!shouldPruneFile(f, pruned)) {
+<a class="jxr_linenumber" name="L173" href="#L173">173</a>
pruned.add(f);
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> }
+<a class="jxr_linenumber" name="L176" href="#L176">176</a>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong
class="jxr_keyword">return</strong> pruned;
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
-<a class="jxr_linenumber" name="L182" href="#L182">182</a>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> * Method that gets all the source files to be
excluded from the javadoc on the given source paths.</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * @param sourcePaths the path to the source
files</em>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> * @param excludedPackages the package names to
be excluded in the javadoc</em>
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment"> * @return a List of the packages to be excluded
in the generated javadoc</em>
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String> getExcludedPackages(
-<a class="jxr_linenumber" name="L191" href="#L191">191</a>
Collection<Path> sourcePaths, Collection<String> excludedPackages) {
-<a class="jxr_linenumber" name="L192" href="#L192">192</a>
List<String> excludedNames = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong
class="jxr_keyword">for</strong> (Path sourcePath : sourcePaths) {
-<a class="jxr_linenumber" name="L194" href="#L194">194</a>
excludedNames.addAll(getExcludedPackages(sourcePath, excludedPackages));
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> }
-<a class="jxr_linenumber" name="L196" href="#L196">196</a>
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong
class="jxr_keyword">return</strong> excludedNames;
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
-<a class="jxr_linenumber" name="L199" href="#L199">199</a>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * Convenience method to wrap a command line
option-argument in single quotes (i.e. <code>'</code>). Intended
for values which</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> * may contain whitespace. <br></em>
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment"> * Line feeds (i.e. <code>\n</code>)
are replaced with spaces, and single quotes are backslash escaped.</em>
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em
class="jxr_javadoccomment"> * @param value the option-argument</em>
-<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em
class="jxr_javadoccomment"> * @return quoted option-argument</em>
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> String quotedArgument(String value) {
-<a class="jxr_linenumber" name="L209" href="#L209">209</a> String arg
= value;
-<a class="jxr_linenumber" name="L210" href="#L210">210</a>
-<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong
class="jxr_keyword">if</strong> (arg != <strong
class="jxr_keyword">null</strong> && !arg.isEmpty()) {
-<a class="jxr_linenumber" name="L212" href="#L212">212</a> arg =
arg.replace(<span class="jxr_string">"'"</span>, <span
class="jxr_string">"\\'"</span>);
-<a class="jxr_linenumber" name="L213" href="#L213">213</a> arg =
<span class="jxr_string">"'"</span> + arg + <span class="jxr_string">"'"</span>;
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> * Determine whether a file should be excluded
from the provided list of paths, based on whether it exists and is</em>
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> * already present in the list.</em>
+<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> * @param f The files.</em>
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> * @param pruned The list of pruned files..</em>
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * @return true if the file could be pruned
false otherwise.</em>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong>
<strong class="jxr_keyword">boolean</strong> shouldPruneFile(String f,
List<String> pruned) {
+<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong
class="jxr_keyword">if</strong> (f != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong
class="jxr_keyword">if</strong> (Files.isRegularFile(Paths.get(f)) &&
!pruned.contains(f)) {
+<a class="jxr_linenumber" name="L191" href="#L191">191</a>
<strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> }
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> }
+<a class="jxr_linenumber" name="L194" href="#L194">194</a>
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
+<a class="jxr_linenumber" name="L197" href="#L197">197</a>
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * Method that gets all the source files to be
excluded from the javadoc on the given source paths.</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * @param sourcePaths the path to the source
files</em>
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> * @param excludedPackages the package names to
be excluded in the javadoc</em>
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment"> * @return a List of the packages to be excluded
in the generated javadoc</em>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String> getExcludedPackages(
+<a class="jxr_linenumber" name="L206" href="#L206">206</a>
Collection<Path> sourcePaths, Collection<String> excludedPackages) {
+<a class="jxr_linenumber" name="L207" href="#L207">207</a>
List<String> excludedNames = <strong class="jxr_keyword">new</strong>
ArrayList<>();
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong
class="jxr_keyword">for</strong> (Path sourcePath : sourcePaths) {
+<a class="jxr_linenumber" name="L209" href="#L209">209</a>
excludedNames.addAll(getExcludedPackages(sourcePath, excludedPackages));
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> }
+<a class="jxr_linenumber" name="L211" href="#L211">211</a>
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong
class="jxr_keyword">return</strong> excludedNames;
+<a class="jxr_linenumber" name="L213" href="#L213">213</a> }
<a class="jxr_linenumber" name="L214" href="#L214">214</a>
-<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em
class="jxr_comment">// To prevent javadoc error</em>
-<a class="jxr_linenumber" name="L216" href="#L216">216</a> arg =
arg.replace(<span class="jxr_string">"\n"</span>, <span class="jxr_string">"
"</span>);
-<a class="jxr_linenumber" name="L217" href="#L217">217</a> }
-<a class="jxr_linenumber" name="L218" href="#L218">218</a>
-<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong
class="jxr_keyword">return</strong> arg;
-<a class="jxr_linenumber" name="L220" href="#L220">220</a> }
-<a class="jxr_linenumber" name="L221" href="#L221">221</a>
-<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em
class="jxr_javadoccomment"> * Convenience method to format a path argument
so that it is properly interpreted by the javadoc tool. Intended for</em>
-<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em
class="jxr_javadoccomment"> * path values which may contain
whitespaces.</em>
-<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em
class="jxr_javadoccomment"> * @param value the argument value.</em>
-<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em
class="jxr_javadoccomment"> * @return path argument with quote</em>
-<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> String quotedPathArgument(String value) {
-<a class="jxr_linenumber" name="L230" href="#L230">230</a> String path
= value;
-<a class="jxr_linenumber" name="L231" href="#L231">231</a>
-<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong
class="jxr_keyword">if</strong> (path != <strong
class="jxr_keyword">null</strong> && !path.isEmpty()) {
-<a class="jxr_linenumber" name="L233" href="#L233">233</a> path =
path.replace('\\', '/');
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong
class="jxr_keyword">if</strong> (path.contains(<span
class="jxr_string">"'"</span>)) {
-<a class="jxr_linenumber" name="L235" href="#L235">235</a>
StringBuilder pathBuilder = <strong class="jxr_keyword">new</strong>
StringBuilder();
-<a class="jxr_linenumber" name="L236" href="#L236">236</a>
pathBuilder.append('\'');
-<a class="jxr_linenumber" name="L237" href="#L237">237</a>
String[] split = path.split(<span class="jxr_string">"'"</span>);
-<a class="jxr_linenumber" name="L238" href="#L238">238</a>
-<a class="jxr_linenumber" name="L239" href="#L239">239</a>
<strong class="jxr_keyword">for</strong> (<strong
class="jxr_keyword">int</strong> i = 0; i < split.length; i++) {
-<a class="jxr_linenumber" name="L240" href="#L240">240</a>
<strong class="jxr_keyword">if</strong> (i != split.length - 1) {
-<a class="jxr_linenumber" name="L241" href="#L241">241</a>
pathBuilder.append(split[i]).append(<span
class="jxr_string">"\\'"</span>);
-<a class="jxr_linenumber" name="L242" href="#L242">242</a>
} <strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L243" href="#L243">243</a>
pathBuilder.append(split[i]);
-<a class="jxr_linenumber" name="L244" href="#L244">244</a>
}
-<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
-<a class="jxr_linenumber" name="L246" href="#L246">246</a>
pathBuilder.append('\'');
-<a class="jxr_linenumber" name="L247" href="#L247">247</a>
path = pathBuilder.toString();
-<a class="jxr_linenumber" name="L248" href="#L248">248</a> }
<strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L249" href="#L249">249</a>
path = <span class="jxr_string">"'"</span> + path + <span
class="jxr_string">"'"</span>;
-<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
-<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
-<a class="jxr_linenumber" name="L252" href="#L252">252</a>
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong
class="jxr_keyword">return</strong> path;
-<a class="jxr_linenumber" name="L254" href="#L254">254</a> }
-<a class="jxr_linenumber" name="L255" href="#L255">255</a>
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em
class="jxr_javadoccomment"> * Convenience method that copy all
<code>doc-files</code> directories from
<code>javadocDir</code> to the</em>
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> * <code>outputDirectory</code>.</em>
-<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em
class="jxr_javadoccomment"> * @param outputDirectory the output
directory</em>
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em
class="jxr_javadoccomment"> * @param javadocDir the javadoc directory</em>
-<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em
class="jxr_javadoccomment"> * @param excludedocfilessubdir the
excludedocfilessubdir parameter</em>
-<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em
class="jxr_javadoccomment"> * @throws IOException if any</em>
-<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_javadoccomment"> * @since 2.5</em>
-<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong>
copyJavadocResources(File outputDirectory, File javadocDir, String
excludedocfilessubdir)
-<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong
class="jxr_keyword">throws</strong> IOException {
-<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong
class="jxr_keyword">if</strong> (!javadocDir.isDirectory()) {
-<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong
class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L270" href="#L270">270</a> }
-<a class="jxr_linenumber" name="L271" href="#L271">271</a>
-<a class="jxr_linenumber" name="L272" href="#L272">272</a>
List<String> excludes = <strong class="jxr_keyword">new</strong>
ArrayList<>(Arrays.asList(FileUtils.getDefaultExcludes()));
-<a class="jxr_linenumber" name="L273" href="#L273">273</a>
-<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong
class="jxr_keyword">if</strong> (excludedocfilessubdir != <strong
class="jxr_keyword">null</strong> && !excludedocfilessubdir.isEmpty()) {
-<a class="jxr_linenumber" name="L275" href="#L275">275</a>
StringTokenizer st = <strong class="jxr_keyword">new</strong>
StringTokenizer(excludedocfilessubdir, <span class="jxr_string">":"</span>);
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> String
current;
-<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong
class="jxr_keyword">while</strong> (st.hasMoreTokens()) {
-<a class="jxr_linenumber" name="L278" href="#L278">278</a>
current = st.nextToken();
-<a class="jxr_linenumber" name="L279" href="#L279">279</a>
excludes.add(<span class="jxr_string">"**/"</span> + current + <span
class="jxr_string">"/**"</span>);
-<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
-<a class="jxr_linenumber" name="L282" href="#L282">282</a>
-<a class="jxr_linenumber" name="L283" href="#L283">283</a>
List<String> docFiles = FileUtils.getDirectoryNames(
-<a class="jxr_linenumber" name="L284" href="#L284">284</a>
javadocDir, <span class="jxr_string">"resources,**/doc-files"</span>,
String.join(<span class="jxr_string">","</span>, excludes), false, <strong
class="jxr_keyword">true</strong>);
-<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong
class="jxr_keyword">for</strong> (String docFile : docFiles) {
-<a class="jxr_linenumber" name="L286" href="#L286">286</a> File
docFileOutput = <strong class="jxr_keyword">new</strong> File(outputDirectory,
docFile);
-<a class="jxr_linenumber" name="L287" href="#L287">287</a>
FileUtils.mkdir(docFileOutput.getAbsolutePath());
-<a class="jxr_linenumber" name="L288" href="#L288">288</a>
FileUtils.copyDirectoryStructure(<strong class="jxr_keyword">new</strong>
File(javadocDir, docFile), docFileOutput);
-<a class="jxr_linenumber" name="L289" href="#L289">289</a>
List<String> files = FileUtils.getFileAndDirectoryNames(
-<a class="jxr_linenumber" name="L290" href="#L290">290</a>
docFileOutput, String.join(<span class="jxr_string">","</span>, excludes),
<strong class="jxr_keyword">null</strong>, <strong
class="jxr_keyword">true</strong>, <strong class="jxr_keyword">true</strong>,
<strong class="jxr_keyword">true</strong>, <strong
class="jxr_keyword">true</strong>);
-<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong
class="jxr_keyword">for</strong> (String filename : files) {
-<a class="jxr_linenumber" name="L292" href="#L292">292</a>
File file = <strong class="jxr_keyword">new</strong> File(filename);
-<a class="jxr_linenumber" name="L293" href="#L293">293</a>
-<a class="jxr_linenumber" name="L294" href="#L294">294</a>
<strong class="jxr_keyword">if</strong> (file.isDirectory()) {
-<a class="jxr_linenumber" name="L295" href="#L295">295</a>
FileUtils.deleteDirectory(file);
-<a class="jxr_linenumber" name="L296" href="#L296">296</a> }
<strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L297" href="#L297">297</a>
file.delete();
-<a class="jxr_linenumber" name="L298" href="#L298">298</a> }
-<a class="jxr_linenumber" name="L299" href="#L299">299</a> }
-<a class="jxr_linenumber" name="L300" href="#L300">300</a> }
-<a class="jxr_linenumber" name="L301" href="#L301">301</a> }
-<a class="jxr_linenumber" name="L302" href="#L302">302</a>
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em
class="jxr_javadoccomment"> * Method that gets the files or classes that
would be included in the javadocs using the subpackages parameter.</em>
-<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em
class="jxr_javadoccomment"> * @param sourceDirectory the directory where
the source files are located</em>
-<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em
class="jxr_javadoccomment"> * @param fileList the list of all relative
files found in the sourceDirectory</em>
-<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em
class="jxr_javadoccomment"> * @param excludePackages package names to be
excluded in the javadoc</em>
-<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em
class="jxr_javadoccomment"> * @return a StringBuilder that contains the
appended file names of the files to be included in the javadoc</em>
-<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String> getIncludedFiles(
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> File
sourceDirectory, String[] fileList, Collection<String> excludePackages) {
-<a class="jxr_linenumber" name="L313" href="#L313">313</a>
List<String> files = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L314" href="#L314">314</a>
-<a class="jxr_linenumber" name="L315" href="#L315">315</a>
List<Pattern> excludePackagePatterns = <strong
class="jxr_keyword">new</strong> ArrayList<>(excludePackages.size());
-<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong
class="jxr_keyword">for</strong> (String excludePackage : excludePackages) {
-<a class="jxr_linenumber" name="L317" href="#L317">317</a>
excludePackagePatterns.add(Pattern.compile(excludePackage
-<a class="jxr_linenumber" name="L318" href="#L318">318</a>
.replace('.', File.separatorChar)
-<a class="jxr_linenumber" name="L319" href="#L319">319</a>
.replace(<span class="jxr_string">"\\"</span>, <span
class="jxr_string">"\\\\"</span>)
-<a class="jxr_linenumber" name="L320" href="#L320">320</a>
.replace(<span class="jxr_string">"*"</span>, <span
class="jxr_string">".+"</span>)
-<a class="jxr_linenumber" name="L321" href="#L321">321</a>
.concat(<span
class="jxr_string">"[\\\\/][^\\\\/]+\\.java"</span>)));
-<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
-<a class="jxr_linenumber" name="L323" href="#L323">323</a>
-<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong
class="jxr_keyword">for</strong> (String file : fileList) {
-<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong
class="jxr_keyword">boolean</strong> excluded = false;
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong
class="jxr_keyword">for</strong> (Pattern excludePackagePattern :
excludePackagePatterns) {
-<a class="jxr_linenumber" name="L327" href="#L327">327</a>
<strong class="jxr_keyword">if</strong>
(excludePackagePattern.matcher(file).matches()) {
-<a class="jxr_linenumber" name="L328" href="#L328">328</a>
excluded = <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L329" href="#L329">329</a>
<strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> }
-<a class="jxr_linenumber" name="L331" href="#L331">331</a> }
-<a class="jxr_linenumber" name="L332" href="#L332">332</a>
-<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong
class="jxr_keyword">if</strong> (!excluded) {
-<a class="jxr_linenumber" name="L334" href="#L334">334</a>
files.add(file.replace('\\', '/'));
-<a class="jxr_linenumber" name="L335" href="#L335">335</a> }
-<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
-<a class="jxr_linenumber" name="L337" href="#L337">337</a>
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong
class="jxr_keyword">return</strong> files;
-<a class="jxr_linenumber" name="L339" href="#L339">339</a> }
-<a class="jxr_linenumber" name="L340" href="#L340">340</a>
-<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em
class="jxr_javadoccomment"> * Method that gets the complete package names
(including subpackages) of the packages that were defined in the</em>
-<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em
class="jxr_javadoccomment"> * excludePackageNames parameter.</em>
-<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em
class="jxr_javadoccomment"> * @param sourceDirectory the directory where
the source files are located</em>
-<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em
class="jxr_javadoccomment"> * @param excludePackagenames package names to
be excluded in the javadoc</em>
-<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em
class="jxr_javadoccomment"> * @return a List of the packagenames to be
excluded</em>
-<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> Collection<String>
getExcludedPackages(
-<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong
class="jxr_keyword">final</strong> Path sourceDirectory,
Collection<String> excludePackagenames) {
-<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong
class="jxr_keyword">final</strong> String regexFileSeparator =
File.separator.replace(<span class="jxr_string">"\\"</span>, <span
class="jxr_string">"\\\\"</span>);
+<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em
class="jxr_javadoccomment"> * Convenience method to wrap a command line
option-argument in single quotes (i.e. <code>'</code>). Intended
for values which</em>
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em
class="jxr_javadoccomment"> * may contain whitespace. <br></em>
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment"> * Line feeds (i.e. <code>\n</code>)
are replaced with spaces, and single quotes are backslash escaped.</em>
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em
class="jxr_javadoccomment"> * @param value the option-argument</em>
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em
class="jxr_javadoccomment"> * @return quoted option-argument</em>
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> String quotedArgument(String value) {
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> String arg
= value;
+<a class="jxr_linenumber" name="L225" href="#L225">225</a>
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong
class="jxr_keyword">if</strong> (arg != <strong
class="jxr_keyword">null</strong> && !arg.isEmpty()) {
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> arg =
arg.replace(<span class="jxr_string">"'"</span>, <span
class="jxr_string">"\\'"</span>);
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> arg =
<span class="jxr_string">"'"</span> + arg + <span class="jxr_string">"'"</span>;
+<a class="jxr_linenumber" name="L229" href="#L229">229</a>
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em
class="jxr_comment">// To prevent javadoc error</em>
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> arg =
arg.replace(<span class="jxr_string">"\n"</span>, <span class="jxr_string">"
"</span>);
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> }
+<a class="jxr_linenumber" name="L233" href="#L233">233</a>
+<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong
class="jxr_keyword">return</strong> arg;
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> }
+<a class="jxr_linenumber" name="L236" href="#L236">236</a>
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment"> * Convenience method to format a path argument
so that it is properly interpreted by the javadoc tool. Intended for</em>
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> * path values which may contain
whitespaces.</em>
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> * @param value the argument value.</em>
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * @return path argument with quote</em>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> String quotedPathArgument(String value) {
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> String path
= value;
+<a class="jxr_linenumber" name="L246" href="#L246">246</a>
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong
class="jxr_keyword">if</strong> (path != <strong
class="jxr_keyword">null</strong> && !path.isEmpty()) {
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> path =
path.replace('\\', '/');
+<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong
class="jxr_keyword">if</strong> (path.contains(<span
class="jxr_string">"'"</span>)) {
+<a class="jxr_linenumber" name="L250" href="#L250">250</a>
StringBuilder pathBuilder = <strong class="jxr_keyword">new</strong>
StringBuilder();
+<a class="jxr_linenumber" name="L251" href="#L251">251</a>
pathBuilder.append('\'');
+<a class="jxr_linenumber" name="L252" href="#L252">252</a>
String[] split = path.split(<span class="jxr_string">"'"</span>);
+<a class="jxr_linenumber" name="L253" href="#L253">253</a>
+<a class="jxr_linenumber" name="L254" href="#L254">254</a>
<strong class="jxr_keyword">for</strong> (<strong
class="jxr_keyword">int</strong> i = 0; i < split.length; i++) {
+<a class="jxr_linenumber" name="L255" href="#L255">255</a>
<strong class="jxr_keyword">if</strong> (i != split.length - 1) {
+<a class="jxr_linenumber" name="L256" href="#L256">256</a>
pathBuilder.append(split[i]).append(<span
class="jxr_string">"\\'"</span>);
+<a class="jxr_linenumber" name="L257" href="#L257">257</a>
} <strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L258" href="#L258">258</a>
pathBuilder.append(split[i]);
+<a class="jxr_linenumber" name="L259" href="#L259">259</a>
}
+<a class="jxr_linenumber" name="L260" href="#L260">260</a> }
+<a class="jxr_linenumber" name="L261" href="#L261">261</a>
pathBuilder.append('\'');
+<a class="jxr_linenumber" name="L262" href="#L262">262</a>
path = pathBuilder.toString();
+<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
<strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L264" href="#L264">264</a>
path = <span class="jxr_string">"'"</span> + path + <span
class="jxr_string">"'"</span>;
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
+<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
+<a class="jxr_linenumber" name="L267" href="#L267">267</a>
+<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong
class="jxr_keyword">return</strong> path;
+<a class="jxr_linenumber" name="L269" href="#L269">269</a> }
+<a class="jxr_linenumber" name="L270" href="#L270">270</a>
+<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> * Convenience method that copy all
<code>doc-files</code> directories from
<code>javadocDir</code> to the</em>
+<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em
class="jxr_javadoccomment"> * <code>outputDirectory</code>.</em>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em
class="jxr_javadoccomment"> * @param outputDirectory the output
directory</em>
+<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em
class="jxr_javadoccomment"> * @param javadocDir the javadoc directory</em>
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em
class="jxr_javadoccomment"> * @param excludedocfilessubdir the
excludedocfilessubdir parameter</em>
+<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em
class="jxr_javadoccomment"> * @throws IOException if any</em>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment"> * @since 2.5</em>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong>
copyJavadocResources(File outputDirectory, File javadocDir, String
excludedocfilessubdir)
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong
class="jxr_keyword">throws</strong> IOException {
+<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong
class="jxr_keyword">if</strong> (!javadocDir.isDirectory()) {
+<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong
class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>
+<a class="jxr_linenumber" name="L287" href="#L287">287</a>
List<String> excludes = <strong class="jxr_keyword">new</strong>
ArrayList<>(Arrays.asList(FileUtils.getDefaultExcludes()));
+<a class="jxr_linenumber" name="L288" href="#L288">288</a>
+<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong
class="jxr_keyword">if</strong> (excludedocfilessubdir != <strong
class="jxr_keyword">null</strong> && !excludedocfilessubdir.isEmpty()) {
+<a class="jxr_linenumber" name="L290" href="#L290">290</a>
StringTokenizer st = <strong class="jxr_keyword">new</strong>
StringTokenizer(excludedocfilessubdir, <span class="jxr_string">":"</span>);
+<a class="jxr_linenumber" name="L291" href="#L291">291</a> String
current;
+<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong
class="jxr_keyword">while</strong> (st.hasMoreTokens()) {
+<a class="jxr_linenumber" name="L293" href="#L293">293</a>
current = st.nextToken();
+<a class="jxr_linenumber" name="L294" href="#L294">294</a>
excludes.add(<span class="jxr_string">"**/"</span> + current + <span
class="jxr_string">"/**"</span>);
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
+<a class="jxr_linenumber" name="L296" href="#L296">296</a> }
+<a class="jxr_linenumber" name="L297" href="#L297">297</a>
+<a class="jxr_linenumber" name="L298" href="#L298">298</a>
List<String> docFiles = FileUtils.getDirectoryNames(
+<a class="jxr_linenumber" name="L299" href="#L299">299</a>
javadocDir, <span class="jxr_string">"resources,**/doc-files"</span>,
String.join(<span class="jxr_string">","</span>, excludes), false, <strong
class="jxr_keyword">true</strong>);
+<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong
class="jxr_keyword">for</strong> (String docFile : docFiles) {
+<a class="jxr_linenumber" name="L301" href="#L301">301</a> File
docFileOutput = <strong class="jxr_keyword">new</strong> File(outputDirectory,
docFile);
+<a class="jxr_linenumber" name="L302" href="#L302">302</a>
FileUtils.mkdir(docFileOutput.getAbsolutePath());
+<a class="jxr_linenumber" name="L303" href="#L303">303</a>
FileUtils.copyDirectoryStructure(<strong class="jxr_keyword">new</strong>
File(javadocDir, docFile), docFileOutput);
+<a class="jxr_linenumber" name="L304" href="#L304">304</a>
List<String> files = FileUtils.getFileAndDirectoryNames(
+<a class="jxr_linenumber" name="L305" href="#L305">305</a>
docFileOutput, String.join(<span class="jxr_string">","</span>, excludes),
<strong class="jxr_keyword">null</strong>, <strong
class="jxr_keyword">true</strong>, <strong class="jxr_keyword">true</strong>,
<strong class="jxr_keyword">true</strong>, <strong
class="jxr_keyword">true</strong>);
+<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong
class="jxr_keyword">for</strong> (String filename : files) {
+<a class="jxr_linenumber" name="L307" href="#L307">307</a>
File file = <strong class="jxr_keyword">new</strong> File(filename);
+<a class="jxr_linenumber" name="L308" href="#L308">308</a>
+<a class="jxr_linenumber" name="L309" href="#L309">309</a>
<strong class="jxr_keyword">if</strong> (file.isDirectory()) {
+<a class="jxr_linenumber" name="L310" href="#L310">310</a>
FileUtils.deleteDirectory(file);
+<a class="jxr_linenumber" name="L311" href="#L311">311</a> }
<strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L312" href="#L312">312</a>
file.delete();
+<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
+<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
+<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
+<a class="jxr_linenumber" name="L316" href="#L316">316</a> }
+<a class="jxr_linenumber" name="L317" href="#L317">317</a>
+<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em
class="jxr_javadoccomment"> * Method that gets the files or classes that
would be included in the javadocs using the subpackages parameter.</em>
+<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em
class="jxr_javadoccomment"> * @param sourceDirectory the directory where
the source files are located</em>
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em
class="jxr_javadoccomment"> * @param fileList the list of all relative
files found in the sourceDirectory</em>
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em
class="jxr_javadoccomment"> * @param excludePackages package names to be
excluded in the javadoc</em>
+<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em
class="jxr_javadoccomment"> * @return a StringBuilder that contains the
appended file names of the files to be included in the javadoc</em>
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String> getIncludedFiles(
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> File
sourceDirectory, String[] fileList, Collection<String> excludePackages) {
+<a class="jxr_linenumber" name="L328" href="#L328">328</a>
List<String> files = <strong class="jxr_keyword">new</strong>
ArrayList<>();
+<a class="jxr_linenumber" name="L329" href="#L329">329</a>
+<a class="jxr_linenumber" name="L330" href="#L330">330</a>
List<Pattern> excludePackagePatterns = <strong
class="jxr_keyword">new</strong> ArrayList<>(excludePackages.size());
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong
class="jxr_keyword">for</strong> (String excludePackage : excludePackages) {
+<a class="jxr_linenumber" name="L332" href="#L332">332</a>
excludePackagePatterns.add(Pattern.compile(excludePackage
+<a class="jxr_linenumber" name="L333" href="#L333">333</a>
.replace('.', File.separatorChar)
+<a class="jxr_linenumber" name="L334" href="#L334">334</a>
.replace(<span class="jxr_string">"\\"</span>, <span
class="jxr_string">"\\\\"</span>)
+<a class="jxr_linenumber" name="L335" href="#L335">335</a>
.replace(<span class="jxr_string">"*"</span>, <span
class="jxr_string">".+"</span>)
+<a class="jxr_linenumber" name="L336" href="#L336">336</a>
.concat(<span
class="jxr_string">"[\\\\/][^\\\\/]+\\.java"</span>)));
+<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
+<a class="jxr_linenumber" name="L338" href="#L338">338</a>
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong
class="jxr_keyword">for</strong> (String file : fileList) {
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong
class="jxr_keyword">boolean</strong> excluded = false;
+<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong
class="jxr_keyword">for</strong> (Pattern excludePackagePattern :
excludePackagePatterns) {
+<a class="jxr_linenumber" name="L342" href="#L342">342</a>
<strong class="jxr_keyword">if</strong>
(excludePackagePattern.matcher(file).matches()) {
+<a class="jxr_linenumber" name="L343" href="#L343">343</a>
excluded = <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L344" href="#L344">344</a>
<strong class="jxr_keyword">break</strong>;
+<a class="jxr_linenumber" name="L345" href="#L345">345</a> }
+<a class="jxr_linenumber" name="L346" href="#L346">346</a> }
+<a class="jxr_linenumber" name="L347" href="#L347">347</a>
+<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong
class="jxr_keyword">if</strong> (!excluded) {
+<a class="jxr_linenumber" name="L349" href="#L349">349</a>
files.add(file.replace('\\', '/'));
+<a class="jxr_linenumber" name="L350" href="#L350">350</a> }
+<a class="jxr_linenumber" name="L351" href="#L351">351</a> }
<a class="jxr_linenumber" name="L352" href="#L352">352</a>
-<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong
class="jxr_keyword">final</strong> Collection<String> fileList = <strong
class="jxr_keyword">new</strong> ArrayList<>();
-<a class="jxr_linenumber" name="L354" href="#L354">354</a>
-<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong
class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L356" href="#L356">356</a>
Files.walkFileTree(sourceDirectory, <strong class="jxr_keyword">new</strong>
SimpleFileVisitor<Path>() {
-<a class="jxr_linenumber" name="L357" href="#L357">357</a>
@Override
-<a class="jxr_linenumber" name="L358" href="#L358">358</a>
<strong class="jxr_keyword">public</strong> FileVisitResult visitFile(Path
file, BasicFileAttributes attrs) <strong class="jxr_keyword">throws</strong>
IOException {
-<a class="jxr_linenumber" name="L359" href="#L359">359</a>
<strong class="jxr_keyword">if</strong>
(file.getFileName().toString().endsWith(<span
class="jxr_string">".java"</span>)) {
-<a class="jxr_linenumber" name="L360" href="#L360">360</a>
fileList.add(
-<a class="jxr_linenumber" name="L361" href="#L361">361</a>
sourceDirectory.relativize(file.getParent()).toString());
-<a class="jxr_linenumber" name="L362" href="#L362">362</a>
}
-<a class="jxr_linenumber" name="L363" href="#L363">363</a>
<strong class="jxr_keyword">return</strong> FileVisitResult.CONTINUE;
-<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> });
-<a class="jxr_linenumber" name="L366" href="#L366">366</a> } <strong
class="jxr_keyword">catch</strong> (IOException e) {
-<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em
class="jxr_comment">// noop</em>
-<a class="jxr_linenumber" name="L368" href="#L368">368</a> }
+<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong
class="jxr_keyword">return</strong> files;
+<a class="jxr_linenumber" name="L354" href="#L354">354</a> }
+<a class="jxr_linenumber" name="L355" href="#L355">355</a>
+<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em
class="jxr_javadoccomment"> * Method that gets the complete package names
(including subpackages) of the packages that were defined in the</em>
+<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em
class="jxr_javadoccomment"> * excludePackageNames parameter.</em>
+<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em
class="jxr_javadoccomment"> * @param sourceDirectory the directory where
the source files are located</em>
+<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em
class="jxr_javadoccomment"> * @param excludePackagenames package names to
be excluded in the javadoc</em>
+<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em
class="jxr_javadoccomment"> * @return a List of the packagenames to be
excluded</em>
+<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> Collection<String>
getExcludedPackages(
+<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong
class="jxr_keyword">final</strong> Path sourceDirectory,
Collection<String> excludePackagenames) {
+<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong
class="jxr_keyword">final</strong> String regexFileSeparator =
File.separator.replace(<span class="jxr_string">"\\"</span>, <span
class="jxr_string">"\\\\"</span>);
+<a class="jxr_linenumber" name="L367" href="#L367">367</a>
+<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong
class="jxr_keyword">final</strong> Collection<String> fileList = <strong
class="jxr_keyword">new</strong> ArrayList<>();
<a class="jxr_linenumber" name="L369" href="#L369">369</a>
-<a class="jxr_linenumber" name="L370" href="#L370">370</a>
List<String> files = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong
class="jxr_keyword">for</strong> (String excludePackagename :
excludePackagenames) {
-<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_comment">// Usage of wildcard was bad specified and bad implemented,
i.e. using String.contains()</em>
-<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em
class="jxr_comment">// without respecting surrounding context</em>
-<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em
class="jxr_comment">// Following implementation should match requirements as
defined in the examples:</em>
-<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em
class="jxr_comment">// - A wildcard at the beginning should match one or more
directories</em>
-<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em
class="jxr_comment">// - Any other wildcard must match exactly one
directory</em>
-<a class="jxr_linenumber" name="L377" href="#L377">377</a> Pattern
p = Pattern.compile(excludePackagename
-<a class="jxr_linenumber" name="L378" href="#L378">378</a>
.replace(<span class="jxr_string">"."</span>, regexFileSeparator)
-<a class="jxr_linenumber" name="L379" href="#L379">379</a>
.replaceFirst(<span class="jxr_string">"^\\*"</span>, <span
class="jxr_string">".+"</span>)
-<a class="jxr_linenumber" name="L380" href="#L380">380</a>
.replace(<span class="jxr_string">"*"</span>, <span
class="jxr_string">"[^"</span> + regexFileSeparator + <span
class="jxr_string">"]+"</span>));
-<a class="jxr_linenumber" name="L381" href="#L381">381</a>
-<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong
class="jxr_keyword">for</strong> (String aFileList : fileList) {
-<a class="jxr_linenumber" name="L383" href="#L383">383</a>
<strong class="jxr_keyword">if</strong> (p.matcher(aFileList).matches()) {
-<a class="jxr_linenumber" name="L384" href="#L384">384</a>
files.add(aFileList.replace(File.separatorChar, '.'));
-<a class="jxr_linenumber" name="L385" href="#L385">385</a> }
-<a class="jxr_linenumber" name="L386" href="#L386">386</a> }
-<a class="jxr_linenumber" name="L387" href="#L387">387</a> }
-<a class="jxr_linenumber" name="L388" href="#L388">388</a>
-<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong
class="jxr_keyword">return</strong> files;
-<a class="jxr_linenumber" name="L390" href="#L390">390</a> }
-<a class="jxr_linenumber" name="L391" href="#L391">391</a>
-<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em
class="jxr_javadoccomment"> * Convenience method that gets the files to be
included in the javadoc.</em>
-<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em
class="jxr_javadoccomment"> * @param sourceDirectory the directory where
the source files are located</em>
-<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em
class="jxr_javadoccomment"> * @param sourceFileIncludes files to
include</em>
-<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em
class="jxr_javadoccomment"> * @param sourceFileExcludes files to
exclude</em>
-<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em
class="jxr_javadoccomment"> * @param excludePackages packages to be
excluded from the javadocs</em>
-<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em
class="jxr_javadoccomment"> * @return the files from which javadoc should
be generated</em>
-<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String> getFilesFromSource(
-<a class="jxr_linenumber" name="L402" href="#L402">402</a> File
sourceDirectory,
-<a class="jxr_linenumber" name="L403" href="#L403">403</a>
List<String> sourceFileIncludes,
-<a class="jxr_linenumber" name="L404" href="#L404">404</a>
List<String> sourceFileExcludes,
-<a class="jxr_linenumber" name="L405" href="#L405">405</a>
Collection<String> excludePackages) {
-<a class="jxr_linenumber" name="L406" href="#L406">406</a>
DirectoryScanner ds = <strong class="jxr_keyword">new</strong>
DirectoryScanner();
-<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong
class="jxr_keyword">if</strong> (sourceFileIncludes == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L408" href="#L408">408</a>
sourceFileIncludes = Collections.singletonList(<span
class="jxr_string">"**/*.java"</span>);
-<a class="jxr_linenumber" name="L409" href="#L409">409</a> }
-<a class="jxr_linenumber" name="L410" href="#L410">410</a>
ds.setIncludes(sourceFileIncludes.toArray(<strong
class="jxr_keyword">new</strong> String[sourceFileIncludes.size()]));
-<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong
class="jxr_keyword">if</strong> (sourceFileExcludes != <strong
class="jxr_keyword">null</strong> && sourceFileExcludes.size() > 0) {
-<a class="jxr_linenumber" name="L412" href="#L412">412</a>
ds.setExcludes(sourceFileExcludes.toArray(<strong
class="jxr_keyword">new</strong> String[sourceFileExcludes.size()]));
-<a class="jxr_linenumber" name="L413" href="#L413">413</a> }
-<a class="jxr_linenumber" name="L414" href="#L414">414</a>
ds.setBasedir(sourceDirectory);
-<a class="jxr_linenumber" name="L415" href="#L415">415</a> ds.scan();
-<a class="jxr_linenumber" name="L416" href="#L416">416</a>
-<a class="jxr_linenumber" name="L417" href="#L417">417</a> String[]
fileList = ds.getIncludedFiles();
-<a class="jxr_linenumber" name="L418" href="#L418">418</a>
-<a class="jxr_linenumber" name="L419" href="#L419">419</a>
List<String> files = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong
class="jxr_keyword">if</strong> (fileList.length != 0) {
-<a class="jxr_linenumber" name="L421" href="#L421">421</a>
files.addAll(getIncludedFiles(sourceDirectory, fileList, excludePackages));
-<a class="jxr_linenumber" name="L422" href="#L422">422</a> }
-<a class="jxr_linenumber" name="L423" href="#L423">423</a>
-<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong
class="jxr_keyword">return</strong> files;
-<a class="jxr_linenumber" name="L425" href="#L425">425</a> }
-<a class="jxr_linenumber" name="L426" href="#L426">426</a>
-<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em
class="jxr_javadoccomment"> * Call the Javadoc tool and parse its output to
find its version, i.e.:</em>
-<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em
class="jxr_javadoccomment"> * javadoc.exe( or.sh ) - J - version</em>
-<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em
class="jxr_javadoccomment"> * @param javadocExe not null file</em>
-<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em
class="jxr_javadoccomment"> * @return the javadoc version as float</em>
-<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em
class="jxr_javadoccomment"> * @throws IOException if javadocExe is null,
doesn't exist or is not a file</em>
-<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em
class="jxr_javadoccomment"> * @throws CommandLineException if any</em>
-<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em
class="jxr_javadoccomment"> * @throws IllegalArgumentException if no output
was found in the command line</em>
-<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment"> * @throws PatternSyntaxException if the output
contains a syntax error in the regular-expression pattern.</em>
-<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em
class="jxr_javadoccomment"> * @see #extractJavadocVersion(String)</em>
-<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> JavaVersion getJavadocVersion(File
javadocExe)
-<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong
class="jxr_keyword">throws</strong> IOException, CommandLineException,
IllegalArgumentException {
-<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong
class="jxr_keyword">if</strong> ((javadocExe == <strong
class="jxr_keyword">null</strong>) || (!javadocExe.exists()) ||
(!javadocExe.isFile())) {
-<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
IOException(<span class="jxr_string">"The javadoc executable '"</span> +
javadocExe + <span class="jxr_string">"' doesn't exist or is not a file.
"</span>);
-<a class="jxr_linenumber" name="L446" href="#L446">446</a> }
-<a class="jxr_linenumber" name="L447" href="#L447">447</a>
-<a class="jxr_linenumber" name="L448" href="#L448">448</a> Commandline
cmd = <strong class="jxr_keyword">new</strong> Commandline();
-<a class="jxr_linenumber" name="L449" href="#L449">449</a>
cmd.setExecutable(javadocExe.getAbsolutePath());
-<a class="jxr_linenumber" name="L450" href="#L450">450</a>
cmd.setWorkingDirectory(javadocExe.getParentFile());
-<a class="jxr_linenumber" name="L451" href="#L451">451</a>
cmd.createArg().setValue(<span class="jxr_string">"-J-version"</span>);
-<a class="jxr_linenumber" name="L452" href="#L452">452</a>
-<a class="jxr_linenumber" name="L453" href="#L453">453</a>
CommandLineUtils.StringStreamConsumer out = <strong
class="jxr_keyword">new</strong> JavadocOutputStreamConsumer();
-<a class="jxr_linenumber" name="L454" href="#L454">454</a>
CommandLineUtils.StringStreamConsumer err = <strong
class="jxr_keyword">new</strong> JavadocOutputStreamConsumer();
-<a class="jxr_linenumber" name="L455" href="#L455">455</a>
-<a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong
class="jxr_keyword">int</strong> exitCode =
CommandLineUtils.executeCommandLine(cmd, out, err);
-<a class="jxr_linenumber" name="L457" href="#L457">457</a> String
errOutput = err.getOutput(); <em class="jxr_comment">// non-null</em>
-<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong
class="jxr_keyword">if</strong> (exitCode != 0) {
-<a class="jxr_linenumber" name="L459" href="#L459">459</a>
StringBuilder msg = <strong class="jxr_keyword">new</strong>
StringBuilder(<span class="jxr_string">"Exit code: "</span> + exitCode + <span
class="jxr_string">" - "</span> + errOutput);
-<a class="jxr_linenumber" name="L460" href="#L460">460</a>
msg.append('\n');
-<a class="jxr_linenumber" name="L461" href="#L461">461</a>
msg.append(<span class="jxr_string">"Command line
was:"</span>).append(CommandLineUtils.toString(cmd.getCommandline()));
-<a class="jxr_linenumber" name="L462" href="#L462">462</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
CommandLineException(msg.toString());
-<a class="jxr_linenumber" name="L463" href="#L463">463</a> }
-<a class="jxr_linenumber" name="L464" href="#L464">464</a>
-<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong
class="jxr_keyword">if</strong> (!errOutput.isEmpty()) {
-<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong
class="jxr_keyword">return</strong>
JavaVersion.parse(extractJavadocVersion(errOutput));
-<a class="jxr_linenumber" name="L467" href="#L467">467</a> } <strong
class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L468" href="#L468">468</a> String
outOutput = out.getOutput(); <em class="jxr_comment">// non-null</em>
-<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong
class="jxr_keyword">if</strong> (!outOutput.isEmpty()) {
-<a class="jxr_linenumber" name="L470" href="#L470">470</a>
<strong class="jxr_keyword">return</strong>
JavaVersion.parse(extractJavadocVersion(outOutput));
-<a class="jxr_linenumber" name="L471" href="#L471">471</a> }
-<a class="jxr_linenumber" name="L472" href="#L472">472</a> }
-<a class="jxr_linenumber" name="L473" href="#L473">473</a>
-<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
IllegalArgumentException(<span class="jxr_string">"No output found from the
command line 'javadoc -J-version'"</span>);
-<a class="jxr_linenumber" name="L475" href="#L475">475</a> }
-<a class="jxr_linenumber" name="L476" href="#L476">476</a>
-<a class="jxr_linenumber" name="L477" href="#L477">477</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
Pattern EXTRACT_JAVADOC_VERSION_PATTERN =
-<a class="jxr_linenumber" name="L478" href="#L478">478</a>
Pattern.compile(<span
class="jxr_string">"(?s).*?[^a-zA-Z](([0-9]+\\.?[0-9]*)(\\.[0-9]+)?).*"</span>);
+<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong
class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L371" href="#L371">371</a>
Files.walkFileTree(sourceDirectory, <strong class="jxr_keyword">new</strong>
SimpleFileVisitor<Path>() {
+<a class="jxr_linenumber" name="L372" href="#L372">372</a>
@Override
+<a class="jxr_linenumber" name="L373" href="#L373">373</a>
<strong class="jxr_keyword">public</strong> FileVisitResult visitFile(Path
file, BasicFileAttributes attrs) <strong class="jxr_keyword">throws</strong>
IOException {
+<a class="jxr_linenumber" name="L374" href="#L374">374</a>
<strong class="jxr_keyword">if</strong>
(file.getFileName().toString().endsWith(<span
class="jxr_string">".java"</span>)) {
+<a class="jxr_linenumber" name="L375" href="#L375">375</a>
fileList.add(
+<a class="jxr_linenumber" name="L376" href="#L376">376</a>
sourceDirectory.relativize(file.getParent()).toString());
+<a class="jxr_linenumber" name="L377" href="#L377">377</a>
}
+<a class="jxr_linenumber" name="L378" href="#L378">378</a>
<strong class="jxr_keyword">return</strong> FileVisitResult.CONTINUE;
+<a class="jxr_linenumber" name="L379" href="#L379">379</a> }
+<a class="jxr_linenumber" name="L380" href="#L380">380</a> });
+<a class="jxr_linenumber" name="L381" href="#L381">381</a> } <strong
class="jxr_keyword">catch</strong> (IOException e) {
+<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em
class="jxr_comment">// noop</em>
+<a class="jxr_linenumber" name="L383" href="#L383">383</a> }
+<a class="jxr_linenumber" name="L384" href="#L384">384</a>
+<a class="jxr_linenumber" name="L385" href="#L385">385</a>
List<String> files = <strong class="jxr_keyword">new</strong>
ArrayList<>();
+<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong
class="jxr_keyword">for</strong> (String excludePackagename :
excludePackagenames) {
+<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em
class="jxr_comment">// Usage of wildcard was bad specified and bad implemented,
i.e. using String.contains()</em>
+<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em
class="jxr_comment">// without respecting surrounding context</em>
+<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em
class="jxr_comment">// Following implementation should match requirements as
defined in the examples:</em>
+<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em
class="jxr_comment">// - A wildcard at the beginning should match one or more
directories</em>
+<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em
class="jxr_comment">// - Any other wildcard must match exactly one
directory</em>
+<a class="jxr_linenumber" name="L392" href="#L392">392</a> Pattern
p = Pattern.compile(excludePackagename
+<a class="jxr_linenumber" name="L393" href="#L393">393</a>
.replace(<span class="jxr_string">"."</span>, regexFileSeparator)
+<a class="jxr_linenumber" name="L394" href="#L394">394</a>
.replaceFirst(<span class="jxr_string">"^\\*"</span>, <span
class="jxr_string">".+"</span>)
+<a class="jxr_linenumber" name="L395" href="#L395">395</a>
.replace(<span class="jxr_string">"*"</span>, <span
class="jxr_string">"[^"</span> + regexFileSeparator + <span
class="jxr_string">"]+"</span>));
+<a class="jxr_linenumber" name="L396" href="#L396">396</a>
+<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong
class="jxr_keyword">for</strong> (String aFileList : fileList) {
+<a class="jxr_linenumber" name="L398" href="#L398">398</a>
<strong class="jxr_keyword">if</strong> (p.matcher(aFileList).matches()) {
+<a class="jxr_linenumber" name="L399" href="#L399">399</a>
files.add(aFileList.replace(File.separatorChar, '.'));
+<a class="jxr_linenumber" name="L400" href="#L400">400</a> }
+<a class="jxr_linenumber" name="L401" href="#L401">401</a> }
+<a class="jxr_linenumber" name="L402" href="#L402">402</a> }
+<a class="jxr_linenumber" name="L403" href="#L403">403</a>
+<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong
class="jxr_keyword">return</strong> files;
+<a class="jxr_linenumber" name="L405" href="#L405">405</a> }
+<a class="jxr_linenumber" name="L406" href="#L406">406</a>
+<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em
class="jxr_javadoccomment"> * Convenience method that gets the files to be
included in the javadoc.</em>
+<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em
class="jxr_javadoccomment"> * @param sourceDirectory the directory where
the source files are located</em>
+<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em
class="jxr_javadoccomment"> * @param sourceFileIncludes files to
include</em>
+<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em
class="jxr_javadoccomment"> * @param sourceFileExcludes files to
exclude</em>
+<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em
class="jxr_javadoccomment"> * @param excludePackages packages to be
excluded from the javadocs</em>
+<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em
class="jxr_javadoccomment"> * @return the files from which javadoc should
be generated</em>
+<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">static</strong> List<String> getFilesFromSource(
+<a class="jxr_linenumber" name="L417" href="#L417">417</a> File
sourceDirectory,
+<a class="jxr_linenumber" name="L418" href="#L418">418</a>
List<String> sourceFileIncludes,
+<a class="jxr_linenumber" name="L419" href="#L419">419</a>
List<String> sourceFileExcludes,
+<a class="jxr_linenumber" name="L420" href="#L420">420</a>
Collection<String> excludePackages) {
+<a class="jxr_linenumber" name="L421" href="#L421">421</a>
DirectoryScanner ds = <strong class="jxr_keyword">new</strong>
DirectoryScanner();
+<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong
class="jxr_keyword">if</strong> (sourceFileIncludes == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L423" href="#L423">423</a>
sourceFileIncludes = Collections.singletonList(<span
class="jxr_string">"**/*.java"</span>);
+<a class="jxr_linenumber" name="L424" href="#L424">424</a> }
+<a class="jxr_linenumber" name="L425" href="#L425">425</a>
ds.setIncludes(sourceFileIncludes.toArray(<strong
class="jxr_keyword">new</strong> String[sourceFileIncludes.size()]));
+<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong
class="jxr_keyword">if</strong> (sourceFileExcludes != <strong
class="jxr_keyword">null</strong> && sourceFileExcludes.size() > 0) {
+<a class="jxr_linenumber" name="L427" href="#L427">427</a>
ds.setExcludes(sourceFileExcludes.toArray(<strong
class="jxr_keyword">new</strong> String[sourceFileExcludes.size()]));
+<a class="jxr_linenumber" name="L428" href="#L428">428</a> }
+<a class="jxr_linenumber" name="L429" href="#L429">429</a>
ds.setBasedir(sourceDirectory);
+<a class="jxr_linenumber" name="L430" href="#L430">430</a> ds.scan();
+<a class="jxr_linenumber" name="L431" href="#L431">431</a>
+<a class="jxr_linenumber" name="L432" href="#L432">432</a> String[]
fileList = ds.getIncludedFiles();
+<a class="jxr_linenumber" name="L433" href="#L433">433</a>
+<a class="jxr_linenumber" name="L434" href="#L434">434</a>
List<String> files = <strong class="jxr_keyword">new</strong>
ArrayList<>();
+<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong
class="jxr_keyword">if</strong> (fileList.length != 0) {
+<a class="jxr_linenumber" name="L436" href="#L436">436</a>
files.addAll(getIncludedFiles(sourceDirectory, fileList, excludePackages));
+<a class="jxr_linenumber" name="L437" href="#L437">437</a> }
+<a class="jxr_linenumber" name="L438" href="#L438">438</a>
+<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong
class="jxr_keyword">return</strong> files;
+<a class="jxr_linenumber" name="L440" href="#L440">440</a> }
+<a class="jxr_linenumber" name="L441" href="#L441">441</a>
+<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em
class="jxr_javadoccomment"> * Call the Javadoc tool and parse its output to
find its version, i.e.:</em>
+<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em
class="jxr_javadoccomment"> * <pre></em>
+<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em
class="jxr_javadoccomment"> * javadoc.exe( or.sh ) - J - version</em>
[... 2136 lines stripped ...]
