Modified: maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AbstractEffectiveMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AbstractEffectiveMojo.html (original) +++ maven/website/components/plugins-archives/maven-help-plugin-LATEST/xref/org/apache/maven/plugins/help/AbstractEffectiveMojo.html Sun Jun 2 15:20:18 2024 @@ -1,159 +1,159 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> -<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> -<title>AbstractEffectiveMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/AbstractEffectiveMojo.html">View Javadoc</a></div><pre> -<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; -<a class="jxr_linenumber" name="L20" href="#L20">20</a> -<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> javax.xml.XMLConstants; -<a class="jxr_linenumber" name="L22" href="#L22">22</a> -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.StringReader; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.Writer; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Collections; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Properties; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.Set; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XMLWriter; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlWriterUtil; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.jdom2.Document; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.jdom2.JDOMException; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.jdom2.input.SAXBuilder; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.jdom2.output.Format; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.jdom2.output.XMLOutputter; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> -<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> <em class="jxr_javadoccomment"> * Base class with common utilities to write effective Pom/settings.</em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractEffectiveMojo" href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html#AbstractEffectiveMojo">AbstractEffectiveMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> { -<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"> * Utility method to write an XML content in a given file.</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> <em class="jxr_javadoccomment"> * @param output is the wanted output file.</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @param content contains the XML content to be written to the file.</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @throws IOException if any</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @see AbstractHelpMojo#writeFile(File, String) if encoding is null.</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeXmlFile(File output, String content) <strong class="jxr_keyword">throws</strong> IOException { -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">if</strong> (output == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> } -<a class="jxr_linenumber" name="L63" href="#L63">63</a> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> output.getParentFile().mkdirs(); -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">try</strong> (Writer out = WriterFactory.newXmlWriter(output)) { -<a class="jxr_linenumber" name="L66" href="#L66">66</a> out.write(content); -<a class="jxr_linenumber" name="L67" href="#L67">67</a> } -<a class="jxr_linenumber" name="L68" href="#L68">68</a> } -<a class="jxr_linenumber" name="L69" href="#L69">69</a> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Write comments in the Effective POM/settings header.</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @param writer not null</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeHeader(XMLWriter writer) { -<a class="jxr_linenumber" name="L76" href="#L76">76</a> XmlWriterUtil.writeCommentLineBreak(writer); -<a class="jxr_linenumber" name="L77" href="#L77">77</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L78" href="#L78">78</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">"Generated by Maven Help Plugin"</span>); -<a class="jxr_linenumber" name="L79" href="#L79">79</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">"See: https://maven.apache.org/plugins/maven-help-plugin/";</span>); -<a class="jxr_linenumber" name="L80" href="#L80">80</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L81" href="#L81">81</a> XmlWriterUtil.writeCommentLineBreak(writer); -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * Write comments in a normalize way.</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * @param writer not null</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @param comment not null</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeComment(XMLWriter writer, String comment) { -<a class="jxr_linenumber" name="L91" href="#L91">91</a> XmlWriterUtil.writeCommentLineBreak(writer); -<a class="jxr_linenumber" name="L92" href="#L92">92</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L93" href="#L93">93</a> XmlWriterUtil.writeComment(writer, comment); -<a class="jxr_linenumber" name="L94" href="#L94">94</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> XmlWriterUtil.writeCommentLineBreak(writer); -<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"> * @param effectiveModel not null</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @param encoding not null</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param omitDeclaration whether the XML declaration should be omitted from the effective pom</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @return pretty format of the xml or the original {@code effectiveModel} if an error occurred.</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> String prettyFormat(String effectiveModel, String encoding, <strong class="jxr_keyword">boolean</strong> omitDeclaration) { -<a class="jxr_linenumber" name="L105" href="#L105">105</a> SAXBuilder builder = <strong class="jxr_keyword">new</strong> SAXBuilder(); -<a class="jxr_linenumber" name="L106" href="#L106">106</a> builder.setProperty(XMLConstants.ACCESS_EXTERNAL_DTD, <span class="jxr_string">""</span>); -<a class="jxr_linenumber" name="L107" href="#L107">107</a> builder.setProperty(XMLConstants.ACCESS_EXTERNAL_SCHEMA, <span class="jxr_string">""</span>); -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L109" href="#L109">109</a> Document effectiveDocument = builder.build(<strong class="jxr_keyword">new</strong> StringReader(effectiveModel)); -<a class="jxr_linenumber" name="L110" href="#L110">110</a> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); -<a class="jxr_linenumber" name="L112" href="#L112">112</a> Format format = Format.getPrettyFormat(); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (encoding != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_comment">// This is a design flaw in JDOM, no NPE on null arguments, but null is not prohibited</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> format.setEncoding(encoding); -<a class="jxr_linenumber" name="L116" href="#L116">116</a> } -<a class="jxr_linenumber" name="L117" href="#L117">117</a> format.setLineSeparator(System.lineSeparator()); -<a class="jxr_linenumber" name="L118" href="#L118">118</a> format.setOmitDeclaration(omitDeclaration); -<a class="jxr_linenumber" name="L119" href="#L119">119</a> XMLOutputter out = <strong class="jxr_keyword">new</strong> XMLOutputter(format); -<a class="jxr_linenumber" name="L120" href="#L120">120</a> out.output(effectiveDocument, w); -<a class="jxr_linenumber" name="L121" href="#L121">121</a> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong> w.toString(); -<a class="jxr_linenumber" name="L123" href="#L123">123</a> } <strong class="jxr_keyword">catch</strong> (JDOMException | IOException e) { -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> effectiveModel; -<a class="jxr_linenumber" name="L125" href="#L125">125</a> } -<a class="jxr_linenumber" name="L126" href="#L126">126</a> } -<a class="jxr_linenumber" name="L127" href="#L127">127</a> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Properties which provides a sorted keySet().</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">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> SortedProperties <strong class="jxr_keyword">extends</strong> Properties { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/** serialVersionUID */</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = -8985316072702233744L; -<a class="jxr_linenumber" name="L134" href="#L134">134</a> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> @SuppressWarnings({<span class="jxr_string">"rawtypes"</span>, <span class="jxr_string">"unchecked"</span>}) -<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Override -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">public</strong> Set<Object> keySet() { -<a class="jxr_linenumber" name="L139" href="#L139">139</a> Set<Object> keynames = <strong class="jxr_keyword">super</strong>.keySet(); -<a class="jxr_linenumber" name="L140" href="#L140">140</a> List list = <strong class="jxr_keyword">new</strong> ArrayList(keynames); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> Collections.sort(list); -<a class="jxr_linenumber" name="L142" href="#L142">142</a> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> LinkedHashSet<>(list); -<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> } -</pre> -<hr/> -<div id="footer">Copyright © 2001–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> -</body> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>AbstractEffectiveMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/help/AbstractEffectiveMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.help; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> javax.xml.XMLConstants; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.StringReader; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.Writer; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XMLWriter; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlWriterUtil; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.jdom2.Document; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.jdom2.JDOMException; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.jdom2.input.SAXBuilder; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.jdom2.output.Format; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.jdom2.output.XMLOutputter; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<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> <em class="jxr_javadoccomment"> * Base class with common utilities to write effective Pom/settings.</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractEffectiveMojo" href="../../../../../org/apache/maven/plugins/help/AbstractEffectiveMojo.html#AbstractEffectiveMojo">AbstractEffectiveMojo</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractHelpMojo" href="../../../../../org/apache/maven/plugins/help/AbstractHelpMojo.html#AbstractHelpMojo">AbstractHelpMojo</a> { +<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"> * Utility method to write an XML content in a given file.</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> <em class="jxr_javadoccomment"> * @param output is the wanted output file.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * @param content contains the XML content to be written to the file.</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @throws IOException if any</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @see AbstractHelpMojo#writeFile(File, String) if encoding is null.</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeXmlFile(File output, String content) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">if</strong> (output == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L62" href="#L62">62</a> } +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> output.getParentFile().mkdirs(); +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">try</strong> (Writer out = WriterFactory.newXmlWriter(output)) { +<a class="jxr_linenumber" name="L66" href="#L66">66</a> out.write(content); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> } +<a class="jxr_linenumber" name="L68" href="#L68">68</a> } +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Write comments in the Effective POM/settings header.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @param writer not null</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeHeader(XMLWriter writer) { +<a class="jxr_linenumber" name="L76" href="#L76">76</a> XmlWriterUtil.writeCommentLineBreak(writer); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">"Generated by Maven Help Plugin"</span>); +<a class="jxr_linenumber" name="L79" href="#L79">79</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">"See: https://maven.apache.org/plugins/maven-help-plugin/";</span>); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> XmlWriterUtil.writeCommentLineBreak(writer); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * Write comments in a normalize way.</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * @param writer not null</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @param comment not null</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> writeComment(XMLWriter writer, String comment) { +<a class="jxr_linenumber" name="L91" href="#L91">91</a> XmlWriterUtil.writeCommentLineBreak(writer); +<a class="jxr_linenumber" name="L92" href="#L92">92</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); +<a class="jxr_linenumber" name="L93" href="#L93">93</a> XmlWriterUtil.writeComment(writer, comment); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> XmlWriterUtil.writeComment(writer, <span class="jxr_string">" "</span>); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> XmlWriterUtil.writeCommentLineBreak(writer); +<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"> * @param effectiveModel not null</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @param encoding not null</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param omitDeclaration whether the XML declaration should be omitted from the effective pom</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @return pretty format of the xml or the original {@code effectiveModel} if an error occurred.</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> String prettyFormat(String effectiveModel, String encoding, <strong class="jxr_keyword">boolean</strong> omitDeclaration) { +<a class="jxr_linenumber" name="L105" href="#L105">105</a> SAXBuilder builder = <strong class="jxr_keyword">new</strong> SAXBuilder(); +<a class="jxr_linenumber" name="L106" href="#L106">106</a> builder.setProperty(XMLConstants.ACCESS_EXTERNAL_DTD, <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> builder.setProperty(XMLConstants.ACCESS_EXTERNAL_SCHEMA, <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> Document effectiveDocument = builder.build(<strong class="jxr_keyword">new</strong> StringReader(effectiveModel)); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> StringWriter w = <strong class="jxr_keyword">new</strong> StringWriter(); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> Format format = Format.getPrettyFormat(); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (encoding != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_comment">// This is a design flaw in JDOM, no NPE on null arguments, but null is not prohibited</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> format.setEncoding(encoding); +<a class="jxr_linenumber" name="L116" href="#L116">116</a> } +<a class="jxr_linenumber" name="L117" href="#L117">117</a> format.setLineSeparator(System.lineSeparator()); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> format.setOmitDeclaration(omitDeclaration); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> XMLOutputter out = <strong class="jxr_keyword">new</strong> XMLOutputter(format); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> out.output(effectiveDocument, w); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong> w.toString(); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> } <strong class="jxr_keyword">catch</strong> (JDOMException | IOException e) { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> effectiveModel; +<a class="jxr_linenumber" name="L125" href="#L125">125</a> } +<a class="jxr_linenumber" name="L126" href="#L126">126</a> } +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Properties which provides a sorted keySet().</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">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> SortedProperties <strong class="jxr_keyword">extends</strong> Properties { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/** serialVersionUID */</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = -8985316072702233744L; +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> @SuppressWarnings({<span class="jxr_string">"rawtypes"</span>, <span class="jxr_string">"unchecked"</span>}) +<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Override +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">public</strong> Set<Object> keySet() { +<a class="jxr_linenumber" name="L139" href="#L139">139</a> Set<Object> keynames = <strong class="jxr_keyword">super</strong>.keySet(); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> List list = <strong class="jxr_keyword">new</strong> ArrayList(keynames); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> Collections.sort(list); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> LinkedHashSet<>(list); +<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> } +</pre> +<hr/> +<div id="footer">Copyright © 2001–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> </html> \ No newline at end of file
