Modified: maven/website/components/plugin-tools-archives/plugin-tools-LATEST/xref/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.html ============================================================================== --- maven/website/components/plugin-tools-archives/plugin-tools-LATEST/xref/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.html (original) +++ maven/website/components/plugin-tools-archives/plugin-tools-LATEST/xref/org/apache/maven/plugin/plugin/AbstractGeneratorMojo.html Sat Mar 30 02:00:43 2024 @@ -31,84 +31,85 @@ <a class="jxr_linenumber" name="L23" href="#L23">23</a> <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * Abstract class for this Plugin.</em> -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:ja...@maven.org"; target="alexandria_uri">mailto:ja...@maven.org</a>">Jason van Zyl</a></em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractGeneratorMojo" href="../../../../../org/apache/maven/plugin/plugin/AbstractGeneratorMojo.html#AbstractGeneratorMojo">AbstractGeneratorMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * The project currently being built.</em> -<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> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">protected</strong> MavenProject project; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> -<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"> * The goal prefix that will appear before the ":".</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> @Parameter -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">protected</strong> String goalPrefix; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Set this to "true" to skip invoking any goals or reports of the plugin.</em> -<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"> * @since 2.8</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> @Parameter(defaultValue = <span class="jxr_string">"false"</span>, property = <span class="jxr_string">"maven.plugin.skip"</span>) -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * Maven plugin packaging types. Default is single "maven-plugin".</em> -<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"> * @since 3.3</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Parameter -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> List<String> packagingTypes = Collections.singletonList(<span class="jxr_string">"maven-plugin"</span>); -<a class="jxr_linenumber" name="L63" href="#L63">63</a> -<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> <em class="jxr_javadoccomment"> * System/OS line separator: used to format console messages.</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LS = System.lineSeparator(); -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> generate() <strong class="jxr_keyword">throws</strong> MojoExecutionException; -<a class="jxr_linenumber" name="L70" href="#L70">70</a> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> @Override -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (!packagingTypes.contains(project.getPackaging())) { -<a class="jxr_linenumber" name="L74" href="#L74">74</a> getLog().info(<span class="jxr_string">"Unsupported packaging type "</span> + project.getPackaging() + <span class="jxr_string">", execution skipped"</span>); -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L76" href="#L76">76</a> } -<a class="jxr_linenumber" name="L77" href="#L77">77</a> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (skip) { -<a class="jxr_linenumber" name="L79" href="#L79">79</a> getLog().warn(<span class="jxr_string">"Execution skipped"</span>); -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L81" href="#L81">81</a> } -<a class="jxr_linenumber" name="L82" href="#L82">82</a> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> (goalPrefix == <strong class="jxr_keyword">null</strong> || goalPrefix.isEmpty()) { -<a class="jxr_linenumber" name="L84" href="#L84">84</a> goalPrefix = getDefaultGoalPrefix(project); -<a class="jxr_linenumber" name="L85" href="#L85">85</a> } -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (goalPrefix == <strong class="jxr_keyword">null</strong> || goalPrefix.isEmpty()) { -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"You need to specify a goalPrefix as it can not be correctly computed"</span>); -<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> generate(); -<a class="jxr_linenumber" name="L91" href="#L91">91</a> } -<a class="jxr_linenumber" name="L92" href="#L92">92</a> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">static</strong> String getDefaultGoalPrefix(MavenProject project) { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> String artifactId = project.getArtifactId(); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> (artifactId.endsWith(<span class="jxr_string">"-maven-plugin"</span>)) { -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">return</strong> artifactId.substring(0, artifactId.length() - <span class="jxr_string">"-maven-plugin"</span>.length()); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (artifactId.startsWith(<span class="jxr_string">"maven-"</span>) && artifactId.endsWith(<span class="jxr_string">"-plugin"</span>)) { -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> artifactId.substring(<span class="jxr_string">"maven-"</span>.length(), artifactId.length() - <span class="jxr_string">"-plugin"</span>.length()); -<a class="jxr_linenumber" name="L99" href="#L99">99</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; -<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="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Abstract class for this Plugin.</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:ja...@maven.org"; target="alexandria_uri">mailto:ja...@maven.org</a>">Jason van Zyl</a></em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractGeneratorMojo" href="../../../../../org/apache/maven/plugin/plugin/AbstractGeneratorMojo.html#AbstractGeneratorMojo">AbstractGeneratorMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo { +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * The project currently being built.</em> +<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> @Component +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">protected</strong> MavenProject project; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> +<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"> * The goal prefix that will appear before the ":".</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> @Parameter +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">protected</strong> String goalPrefix; +<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"> * Set this to "true" to skip invoking any goals or reports of the plugin.</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * @since 2.8</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> @Parameter(defaultValue = <span class="jxr_string">"false"</span>, property = <span class="jxr_string">"maven.plugin.skip"</span>) +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Maven plugin packaging types. Default is single "maven-plugin".</em> +<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"> * @since 3.3</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Parameter +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> List<String> packagingTypes = Collections.singletonList(<span class="jxr_string">"maven-plugin"</span>); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * System/OS line separator: used to format console messages.</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LS = System.lineSeparator(); +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> generate() <strong class="jxr_keyword">throws</strong> MojoExecutionException; +<a class="jxr_linenumber" name="L71" href="#L71">71</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> @Override +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">if</strong> (!packagingTypes.contains(project.getPackaging())) { +<a class="jxr_linenumber" name="L75" href="#L75">75</a> getLog().info(<span class="jxr_string">"Unsupported packaging type "</span> + project.getPackaging() + <span class="jxr_string">", execution skipped"</span>); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">return</strong>; +<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> <strong class="jxr_keyword">if</strong> (skip) { +<a class="jxr_linenumber" name="L80" href="#L80">80</a> getLog().warn(<span class="jxr_string">"Execution skipped"</span>); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } +<a class="jxr_linenumber" name="L83" href="#L83">83</a> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (goalPrefix == <strong class="jxr_keyword">null</strong> || goalPrefix.isEmpty()) { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> goalPrefix = getDefaultGoalPrefix(project); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> } +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> (goalPrefix == <strong class="jxr_keyword">null</strong> || goalPrefix.isEmpty()) { +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"You need to specify a goalPrefix as it can not be correctly computed"</span>); +<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> generate(); +<a class="jxr_linenumber" name="L92" href="#L92">92</a> } +<a class="jxr_linenumber" name="L93" href="#L93">93</a> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">static</strong> String getDefaultGoalPrefix(MavenProject project) { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> String artifactId = project.getArtifactId(); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (artifactId.endsWith(<span class="jxr_string">"-maven-plugin"</span>)) { +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> artifactId.substring(0, artifactId.length() - <span class="jxr_string">"-maven-plugin"</span>.length()); +<a class="jxr_linenumber" name="L98" href="#L98">98</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (artifactId.startsWith(<span class="jxr_string">"maven-"</span>) && artifactId.endsWith(<span class="jxr_string">"-plugin"</span>)) { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> artifactId.substring(<span class="jxr_string">"maven-"</span>.length(), artifactId.length() - <span class="jxr_string">"-plugin"</span>.length()); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<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> } </pre> <hr/> <div id="footer">Copyright © 2004–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div>
