Modified: maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-api/xref/org/apache/maven/tools/plugin/util/PluginUtils.html ============================================================================== --- maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-api/xref/org/apache/maven/tools/plugin/util/PluginUtils.html (original) +++ maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-api/xref/org/apache/maven/tools/plugin/util/PluginUtils.html Sat Mar 30 02:00:43 2024 @@ -31,143 +31,130 @@ <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.net.URL; <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.net.URLClassLoader; <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Collections; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Comparator; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.DependencyResolutionRequiredException; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.MojoDescriptor; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.Parameter; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.DirectoryScanner; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Convenience methods to play with Maven plugins.</em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @author jdcasey</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="PluginUtils" href="../../../../../../org/apache/maven/tools/plugin/util/PluginUtils.html#PluginUtils">PluginUtils</a> { -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <a name="PluginUtils" href="../../../../../../org/apache/maven/tools/plugin/util/PluginUtils.html#PluginUtils">PluginUtils</a>() { -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// nop</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> } -<a class="jxr_linenumber" name="L49" href="#L49">49</a> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param basedir not null</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @param include not null</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @return list of included files with default SCM excluded files</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String[] findSources(String basedir, String include) { -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">return</strong> PluginUtils.findSources(basedir, include, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L57" href="#L57">57</a> } -<a class="jxr_linenumber" name="L58" href="#L58">58</a> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param basedir not null</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param include not null</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @param exclude could be null</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @return list of included files</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String[] findSources(String basedir, String include, String exclude) { -<a class="jxr_linenumber" name="L66" href="#L66">66</a> DirectoryScanner scanner = <strong class="jxr_keyword">new</strong> DirectoryScanner(); -<a class="jxr_linenumber" name="L67" href="#L67">67</a> scanner.setBasedir(basedir); -<a class="jxr_linenumber" name="L68" href="#L68">68</a> scanner.setIncludes(<strong class="jxr_keyword">new</strong> String[] {include}); -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">if</strong> (!(exclude == <strong class="jxr_keyword">null</strong> || exclude.isEmpty())) { -<a class="jxr_linenumber" name="L70" href="#L70">70</a> scanner.setExcludes(<strong class="jxr_keyword">new</strong> String[] {exclude, StringUtils.join(FileUtils.getDefaultExcludes(), <span class="jxr_string">","</span>)}); -<a class="jxr_linenumber" name="L71" href="#L71">71</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L72" href="#L72">72</a> scanner.setExcludes(FileUtils.getDefaultExcludes()); -<a class="jxr_linenumber" name="L73" href="#L73">73</a> } -<a class="jxr_linenumber" name="L74" href="#L74">74</a> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> scanner.scan(); -<a class="jxr_linenumber" name="L76" href="#L76">76</a> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> scanner.getIncludedFiles(); -<a class="jxr_linenumber" name="L78" href="#L78">78</a> } -<a class="jxr_linenumber" name="L79" href="#L79">79</a> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Sorts the specified mojo descriptors by goal name.</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @param mojoDescriptors The mojo descriptors to sort, may be <code>null</code>.</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @see MojoDescriptor#getGoal()</em> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> sortMojos(List<MojoDescriptor> mojoDescriptors) { -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> (mojoDescriptors != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L88" href="#L88">88</a> Collections.sort(mojoDescriptors, <strong class="jxr_keyword">new</strong> Comparator<MojoDescriptor>() { -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> @Override -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compare(MojoDescriptor mojo0, MojoDescriptor mojo1) { -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">return</strong> mojo0.getGoal().compareToIgnoreCase(mojo1.getGoal()); -<a class="jxr_linenumber" name="L93" href="#L93">93</a> } -<a class="jxr_linenumber" name="L94" href="#L94">94</a> }); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> } -<a class="jxr_linenumber" name="L96" href="#L96">96</a> } -<a class="jxr_linenumber" name="L97" href="#L97">97</a> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * Sorts the specified mojo parameters by name.</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param parameters The mojo parameters to sort, may be <code>null</code>.</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @see Parameter#getName()</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @since 2.4.4</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> sortMojoParameters(List<Parameter> parameters) { -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (parameters != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L107" href="#L107">107</a> Collections.sort(parameters, <strong class="jxr_keyword">new</strong> Comparator<Parameter>() { -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Override -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compare(Parameter parameter1, Parameter parameter2) { -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">return</strong> parameter1.getName().compareToIgnoreCase(parameter2.getName()); -<a class="jxr_linenumber" name="L112" href="#L112">112</a> } -<a class="jxr_linenumber" name="L113" href="#L113">113</a> }); -<a class="jxr_linenumber" name="L114" href="#L114">114</a> } -<a class="jxr_linenumber" name="L115" href="#L115">115</a> } +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Comparator; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.DependencyResolutionRequiredException; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.MojoDescriptor; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.Parameter; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.DirectoryScanner; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * Convenience methods to play with Maven plugins.</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @author jdcasey</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="PluginUtils" href="../../../../../../org/apache/maven/tools/plugin/util/PluginUtils.html#PluginUtils">PluginUtils</a> { +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> <a name="PluginUtils" href="../../../../../../org/apache/maven/tools/plugin/util/PluginUtils.html#PluginUtils">PluginUtils</a>() { +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_comment">// nop</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> } +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @param basedir not null</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * @param include not null</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @return list of included files with default SCM excluded files</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String[] findSources(String basedir, String include) { +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong> PluginUtils.findSources(basedir, include, <strong class="jxr_keyword">null</strong>); +<a class="jxr_linenumber" name="L56" href="#L56">56</a> } +<a class="jxr_linenumber" name="L57" href="#L57">57</a> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param basedir not null</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param include not null</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param exclude could be null</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @return list of included files</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String[] findSources(String basedir, String include, String exclude) { +<a class="jxr_linenumber" name="L65" href="#L65">65</a> DirectoryScanner scanner = <strong class="jxr_keyword">new</strong> DirectoryScanner(); +<a class="jxr_linenumber" name="L66" href="#L66">66</a> scanner.setBasedir(basedir); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> scanner.setIncludes(<strong class="jxr_keyword">new</strong> String[] {include}); +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">if</strong> (!(exclude == <strong class="jxr_keyword">null</strong> || exclude.isEmpty())) { +<a class="jxr_linenumber" name="L69" href="#L69">69</a> scanner.setExcludes(<strong class="jxr_keyword">new</strong> String[] {exclude, StringUtils.join(FileUtils.getDefaultExcludes(), <span class="jxr_string">","</span>)}); +<a class="jxr_linenumber" name="L70" href="#L70">70</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L71" href="#L71">71</a> scanner.setExcludes(FileUtils.getDefaultExcludes()); +<a class="jxr_linenumber" name="L72" href="#L72">72</a> } +<a class="jxr_linenumber" name="L73" href="#L73">73</a> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> scanner.scan(); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">return</strong> scanner.getIncludedFiles(); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> } +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Sorts the specified mojo descriptors by goal name.</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @param mojoDescriptors The mojo descriptors to sort, may be <code>null</code>.</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @see MojoDescriptor#getGoal()</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> sortMojos(List<MojoDescriptor> mojoDescriptors) { +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (mojoDescriptors != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L87" href="#L87">87</a> mojoDescriptors.sort(Comparator.comparing(MojoDescriptor::getGoal)); +<a class="jxr_linenumber" name="L88" href="#L88">88</a> } +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * Sorts the specified mojo parameters by name.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param parameters The mojo parameters to sort, may be <code>null</code>.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @see Parameter#getName()</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @since 2.4.4</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> sortMojoParameters(List<Parameter> parameters) { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">if</strong> (parameters != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L100" href="#L100">100</a> parameters.sort(Comparator.comparing(Parameter::getName)); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> } +<a class="jxr_linenumber" name="L102" href="#L102">102</a> } +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @param mojoClassName a fully qualified Mojo implementation class name, not null</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @param project a MavenProject instance, could be null</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the Mojo class implements <code>MavenReport</code>,</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * <code>false</code> otherwise.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if any</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @since 3.10.0</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isMavenReport(String mojoClassName, MavenProject project) <strong class="jxr_keyword">throws</strong> IllegalArgumentException { +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (mojoClassName == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"mojo implementation should be declared"</span>); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> } <a class="jxr_linenumber" name="L116" href="#L116">116</a> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @param mojoClassName a fully qualified Mojo implementation class name, not null</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @param project a MavenProject instance, could be null</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the Mojo class implements <code>MavenReport</code>,</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * <code>false</code> otherwise.</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if any</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * @since 3.10.0</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isMavenReport(String mojoClassName, MavenProject project) <strong class="jxr_keyword">throws</strong> IllegalArgumentException { -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">if</strong> (mojoClassName == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"mojo implementation should be declared"</span>); -<a class="jxr_linenumber" name="L128" href="#L128">128</a> } -<a class="jxr_linenumber" name="L129" href="#L129">129</a> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (project != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> List<String> classPathStrings; -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L134" href="#L134">134</a> classPathStrings = project.getCompileClasspathElements(); -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">if</strong> (project.getExecutionProject() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L136" href="#L136">136</a> classPathStrings.addAll(project.getExecutionProject().getCompileClasspathElements()); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> } -<a class="jxr_linenumber" name="L138" href="#L138">138</a> } <strong class="jxr_keyword">catch</strong> (DependencyResolutionRequiredException e) { -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(e); -<a class="jxr_linenumber" name="L140" href="#L140">140</a> } -<a class="jxr_linenumber" name="L141" href="#L141">141</a> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> List<URL> urls = <strong class="jxr_keyword">new</strong> ArrayList<>(classPathStrings.size()); -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">for</strong> (String classPathString : classPathStrings) { -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L145" href="#L145">145</a> urls.add(<strong class="jxr_keyword">new</strong> File(classPathString).toURL()); -<a class="jxr_linenumber" name="L146" href="#L146">146</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) { -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(e); -<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> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> classLoader = <strong class="jxr_keyword">new</strong> URLClassLoader(urls.toArray(<strong class="jxr_keyword">new</strong> URL[urls.size()]), classLoader); -<a class="jxr_linenumber" name="L152" href="#L152">152</a> } -<a class="jxr_linenumber" name="L153" href="#L153">153</a> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L155" href="#L155">155</a> Class<?> clazz = Class.forName(mojoClassName, false, classLoader); -<a class="jxr_linenumber" name="L156" href="#L156">156</a> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">return</strong> MavenReport.<strong class="jxr_keyword">class</strong>.isAssignableFrom(clazz); -<a class="jxr_linenumber" name="L158" href="#L158">158</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException e) { -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong> 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> } +<a class="jxr_linenumber" name="L117" href="#L117">117</a> ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> (project != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> List<String> classPathStrings; +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L121" href="#L121">121</a> classPathStrings = project.getCompileClasspathElements(); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">if</strong> (project.getExecutionProject() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L123" href="#L123">123</a> classPathStrings.addAll(project.getExecutionProject().getCompileClasspathElements()); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> } +<a class="jxr_linenumber" name="L125" href="#L125">125</a> } <strong class="jxr_keyword">catch</strong> (DependencyResolutionRequiredException e) { +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(e); +<a class="jxr_linenumber" name="L127" href="#L127">127</a> } +<a class="jxr_linenumber" name="L128" href="#L128">128</a> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> List<URL> urls = <strong class="jxr_keyword">new</strong> ArrayList<>(classPathStrings.size()); +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">for</strong> (String classPathString : classPathStrings) { +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> urls.add(<strong class="jxr_keyword">new</strong> File(classPathString).toURL()); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(e); +<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> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> classLoader = <strong class="jxr_keyword">new</strong> URLClassLoader(urls.toArray(<strong class="jxr_keyword">new</strong> URL[urls.size()]), classLoader); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> Class<?> clazz = Class.forName(mojoClassName, false, classLoader); +<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> MavenReport.<strong class="jxr_keyword">class</strong>.isAssignableFrom(clazz); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException e) { +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> } +<a class="jxr_linenumber" name="L149" href="#L149">149</a> } </pre> <hr/> <div id="footer">Copyright © 2004–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-generators/apidocs/member-search-index.zip ============================================================================== Binary files - no diff available. Modified: maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-generators/apidocs/org/apache/maven/tools/plugin/generator/GeneratorUtils.html ============================================================================== --- maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-generators/apidocs/org/apache/maven/tools/plugin/generator/GeneratorUtils.html (original) +++ maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-generators/apidocs/org/apache/maven/tools/plugin/generator/GeneratorUtils.html Sat Mar 30 02:00:43 2024 @@ -131,7 +131,7 @@ $('.navPadding').css('padding-top', $('. <ul class="blockList"> <li class="blockList"> <hr> -<pre>public final class <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.55">GeneratorUtils</a> +<pre>public final class <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.56">GeneratorUtils</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> <div class="block">Convenience methods to play with Maven plugins.</div> <dl> @@ -241,7 +241,7 @@ extends <a href="https://docs.oracle.com <ul class="blockList"> <li class="blockList"> <h4>writeDependencies</h4> -<pre class="methodSignature">public static void <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.64">writeDependencies</a>​(org.codehaus.plexus.util.xml.XMLWriter w, +<pre class="methodSignature">public static void <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.65">writeDependencies</a>​(org.codehaus.plexus.util.xml.XMLWriter w, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -256,7 +256,7 @@ extends <a href="https://docs.oracle.com <ul class="blockList"> <li class="blockList"> <h4>element</h4> -<pre class="methodSignature">public static void <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.90">element</a>​(org.codehaus.plexus.util.xml.XMLWriter w, +<pre class="methodSignature">public static void <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.91">element</a>​(org.codehaus.plexus.util.xml.XMLWriter w, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> value)</pre> <dl> @@ -273,7 +273,7 @@ extends <a href="https://docs.oracle.com <ul class="blockList"> <li class="blockList"> <h4>toComponentDependencies</h4> -<pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.codehaus.plexus.component.repository.ComponentDependency> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.106">toComponentDependencies</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><org.apache.maven.artifact.Artifact> artifacts)</pre> +<pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><org.codehaus.plexus.component.repository.ComponentDependency> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.107">toComponentDependencies</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><org.apache.maven.artifact.Artifact> artifacts)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>artifacts</code> - not null collection of <code>Artifact</code></dd> @@ -289,7 +289,7 @@ extends <a href="https://docs.oracle.com <li class="blockList"> <h4>makeHtmlValid</h4> <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> -public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.229">makeHtmlValid</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</pre> +public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.230">makeHtmlValid</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Redundant for java extractor</div> </div> @@ -309,7 +309,7 @@ public static <a href="https://docs <li class="blockList"> <h4>toText</h4> <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> -public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.286">toText</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> html)</pre> +public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.287">toText</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> html)</pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> <div class="deprecationComment">Replaced by <a href="HtmlToPlainTextConverter.html" title="class in org.apache.maven.tools.plugin.generator"><code>HtmlToPlainTextConverter</code></a></div> </div> @@ -340,7 +340,7 @@ public static <a href="https://docs <ul class="blockList"> <li class="blockList"> <h4>discoverPackageName</h4> -<pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.509">discoverPackageName</a>​(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)</pre> +<pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.510">discoverPackageName</a>​(org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)</pre> <div class="block">Find the best package name, based on the number of hits of actual Mojo classes.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -357,7 +357,7 @@ public static <a href="https://docs <li class="blockList"> <h4>isMavenReport</h4> <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> -public static boolean <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.556">isMavenReport</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> impl, +public static boolean <a href="../../../../../../src-html/org/apache/maven/tools/plugin/generator/GeneratorUtils.html#line.557">isMavenReport</a>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> impl, org.apache.maven.project.MavenProject project) throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></pre> <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> Modified: maven/website/components/plugin-tools-archives/plugin-tools-LATEST/maven-plugin-tools-generators/apidocs/package-search-index.zip ============================================================================== Binary files - no diff available.