Modified: websites/production/commons/content/proper/commons-configuration/xref/org/apache/commons/configuration2/XMLPropertiesConfiguration.html ============================================================================== --- websites/production/commons/content/proper/commons-configuration/xref/org/apache/commons/configuration2/XMLPropertiesConfiguration.html (original) +++ websites/production/commons/content/proper/commons-configuration/xref/org/apache/commons/configuration2/XMLPropertiesConfiguration.html Wed Mar 20 22:19:06 2024 @@ -31,338 +31,339 @@ <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.nio.charset.StandardCharsets; <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParser; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParserFactory; -<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.commons.configuration2.convert.ListDelimiterHandler; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.ex.ConfigurationException; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.io.FileLocator; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.io.FileLocatorAware; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.text.StringEscapeUtils; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Node; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.xml.sax.Attributes; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.xml.sax.InputSource; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.xml.sax.XMLReader; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.xml.sax.helpers.DefaultHandler; -<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"> * This configuration implements the XML properties format introduced in Java, see</em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html."; target="alexandria_uri">https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html.</a> An XML properties file looks like this:</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * &lt;?xml version="1.0"?&gt;</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * &lt;!DOCTYPE properties SYSTEM "<a href="http://java.sun.com/dtd/properties.dtd"; target="alexandria_uri">http://java.sun.com/dtd/properties.dtd</a>"&gt;</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * &lt;properties&gt;</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * &lt;comment&gt;Description of the property list&lt;/comment&gt;</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &lt;entry key="key1"&gt;value1&lt;/entry&gt;</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;entry key="key2"&gt;value2&lt;/entry&gt;</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * &lt;entry key="key3"&gt;value3&lt;/entry&gt;</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * &lt;/properties&gt;</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * </pre></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"> * The Java runtime is not required to use this class. The default encoding for this configuration format is UTF-8.</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Note that unlike {@code PropertiesConfiguration}, {@code XMLPropertiesConfiguration} does not support includes.</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> <em class="jxr_javadoccomment"> * <em>Note:</em>Configuration objects of this type can be read concurrently by multiple threads. However if one of</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * these threads modifies the object, synchronization has to be performed manually.</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> <em class="jxr_javadoccomment"> * @since 1.1</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">public</strong> <strong class="jxr_keyword">class</strong> <a name="XMLPropertiesConfiguration" href="../../../../org/apache/commons/configuration2/XMLPropertiesConfiguration.html#XMLPropertiesConfiguration">XMLPropertiesConfiguration</a> <strong class="jxr_keyword">extends</strong> <a name="BaseConfiguration" href="../../../../org/apache/commons/configuration2/BaseConfiguration.html#BaseConfiguration">BaseConfiguration</a> <strong class="jxr_keyword">implements</strong> FileBasedConfiguration, <a name="FileLocatorAware" href="../../../../org/apache/commons/configuration2/io/FileLocatorAware.html#FileLocatorAware">FileLocatorAware</a> { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * The default encoding (UTF-8 as specified by <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html)" target="alexandria_uri">https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html)</a></em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ENCODING = StandardCharsets.UTF_8.name(); -<a class="jxr_linenumber" name="L73" href="#L73">73</a> -<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> <em class="jxr_javadoccomment"> * Default string used when the XML is malformed</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String MALFORMED_XML_EXCEPTION = <span class="jxr_string">"Malformed XML"</span>; -<a class="jxr_linenumber" name="L78" href="#L78">78</a> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/** The temporary file locator. */</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <a name="FileLocator" href="../../../../org/apache/commons/configuration2/io/FileLocator.html#FileLocator">FileLocator</a> locator; -<a class="jxr_linenumber" name="L81" href="#L81">81</a> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/** Stores a header comment. */</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> String header; -<a class="jxr_linenumber" name="L84" href="#L84">84</a> -<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> <em class="jxr_javadoccomment"> * Creates an empty XMLPropertyConfiguration object which can be used to synthesize a new Properties file by adding</em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * values and then saving(). An object constructed by this C'tor can not be tickled into loading included files because</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * it cannot supply a base for relative includes.</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">public</strong> <a name="XMLPropertiesConfiguration" href="../../../../org/apache/commons/configuration2/XMLPropertiesConfiguration.html#XMLPropertiesConfiguration">XMLPropertiesConfiguration</a>() { -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Creates and loads the xml properties from the specified DOM node.</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * @param element The DOM element</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @throws ConfigurationException Error while loading the properties file</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> <a name="XMLPropertiesConfiguration" href="../../../../org/apache/commons/configuration2/XMLPropertiesConfiguration.html#XMLPropertiesConfiguration">XMLPropertiesConfiguration</a>(<strong class="jxr_keyword">final</strong> Element element) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.load(element); -<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"> * Gets the header comment of this configuration.</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @return the header comment</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> String getHeader() { -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> header; -<a class="jxr_linenumber" name="L111" href="#L111">111</a> } -<a class="jxr_linenumber" name="L112" href="#L112">112</a> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * Sets the header comment of this configuration.</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @param header the header comment</em> -<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHeader(<strong class="jxr_keyword">final</strong> String header) { -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">this</strong>.header = header; -<a class="jxr_linenumber" name="L120" href="#L120">120</a> } -<a class="jxr_linenumber" name="L121" href="#L121">121</a> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> @Override -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> read(<strong class="jxr_keyword">final</strong> Reader in) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">final</strong> SAXParserFactory factory = SAXParserFactory.newInstance(); -<a class="jxr_linenumber" name="L125" href="#L125">125</a> factory.setNamespaceAware(false); -<a class="jxr_linenumber" name="L126" href="#L126">126</a> factory.setValidating(<strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L127" href="#L127">127</a> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">final</strong> SAXParser parser = factory.newSAXParser(); -<a class="jxr_linenumber" name="L130" href="#L130">130</a> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">final</strong> XMLReader xmlReader = parser.getXMLReader(); -<a class="jxr_linenumber" name="L132" href="#L132">132</a> xmlReader.setEntityResolver((publicId, systemId) -> <strong class="jxr_keyword">new</strong> InputSource(getClass().getClassLoader().getResourceAsStream(<span class="jxr_string">"properties.dtd"</span>))); -<a class="jxr_linenumber" name="L133" href="#L133">133</a> xmlReader.setContentHandler(<strong class="jxr_keyword">new</strong> XMLPropertiesHandler()); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> xmlReader.parse(<strong class="jxr_keyword">new</strong> InputSource(in)); -<a class="jxr_linenumber" name="L135" href="#L135">135</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) { -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(<span class="jxr_string">"Unable to parse the configuration file"</span>, e); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> } -<a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// todo: support included properties ?</em> -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * Parses a DOM element containing the properties. The DOM element has to follow the XML properties format introduced in</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Java, see <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html"; target="alexandria_uri">https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html</a></em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param element The DOM element</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @throws ConfigurationException Error while interpreting the DOM</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> load(<strong class="jxr_keyword">final</strong> Element element) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">if</strong> (!element.getNodeName().equals(<span class="jxr_string">"properties"</span>)) { -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(MALFORMED_XML_EXCEPTION); -<a class="jxr_linenumber" name="L153" href="#L153">153</a> } -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">final</strong> NodeList childNodes = element.getChildNodes(); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < childNodes.getLength(); i++) { -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">final</strong> Node item = childNodes.item(i); -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">if</strong> (item instanceof Element) { -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (item.getNodeName().equals(<span class="jxr_string">"comment"</span>)) { -<a class="jxr_linenumber" name="L159" href="#L159">159</a> setHeader(item.getTextContent()); -<a class="jxr_linenumber" name="L160" href="#L160">160</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (item.getNodeName().equals(<span class="jxr_string">"entry"</span>)) { -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">final</strong> String key = ((Element) item).getAttribute(<span class="jxr_string">"key"</span>); -<a class="jxr_linenumber" name="L162" href="#L162">162</a> addProperty(key, item.getTextContent()); -<a class="jxr_linenumber" name="L163" href="#L163">163</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(MALFORMED_XML_EXCEPTION); -<a class="jxr_linenumber" name="L165" href="#L165">165</a> } -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> } -<a class="jxr_linenumber" name="L168" href="#L168">168</a> } -<a class="jxr_linenumber" name="L169" href="#L169">169</a> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> @Override -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">final</strong> Writer out) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">final</strong> PrintWriter writer = <strong class="jxr_keyword">new</strong> PrintWriter(out); -<a class="jxr_linenumber" name="L173" href="#L173">173</a> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> String encoding = locator != <strong class="jxr_keyword">null</strong> ? locator.getEncoding() : <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> (encoding == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L176" href="#L176">176</a> encoding = DEFAULT_ENCODING; -<a class="jxr_linenumber" name="L177" href="#L177">177</a> } -<a class="jxr_linenumber" name="L178" href="#L178">178</a> writer.println(<span class="jxr_string">"<?xml version=\"1.0\" encoding=\""</span> + encoding + <span class="jxr_string">"\"?>"</span>); -<a class="jxr_linenumber" name="L179" href="#L179">179</a> writer.println(<span class="jxr_string">"<!DOCTYPE properties SYSTEM \"http://java.sun.com/dtd/properties.dtd\">";</span>); -<a class="jxr_linenumber" name="L180" href="#L180">180</a> writer.println(<span class="jxr_string">"<properties>"</span>); -<a class="jxr_linenumber" name="L181" href="#L181">181</a> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (getHeader() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L183" href="#L183">183</a> writer.println(<span class="jxr_string">" <comment>"</span> + StringEscapeUtils.escapeXml10(getHeader()) + <span class="jxr_string">"</comment>"</span>); -<a class="jxr_linenumber" name="L184" href="#L184">184</a> } -<a class="jxr_linenumber" name="L185" href="#L185">185</a> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> Iterator<String> keys = getKeys(); -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">while</strong> (keys.hasNext()) { -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> String key = keys.next(); -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">final</strong> Object value = getProperty(key); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> (value instanceof List) { -<a class="jxr_linenumber" name="L192" href="#L192">192</a> writeProperty(writer, key, (List<?>) value); -<a class="jxr_linenumber" name="L193" href="#L193">193</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L194" href="#L194">194</a> writeProperty(writer, key, value); -<a class="jxr_linenumber" name="L195" href="#L195">195</a> } -<a class="jxr_linenumber" name="L196" href="#L196">196</a> } -<a class="jxr_linenumber" name="L197" href="#L197">197</a> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> writer.println(<span class="jxr_string">"</properties>"</span>); -<a class="jxr_linenumber" name="L199" href="#L199">199</a> writer.flush(); -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } -<a class="jxr_linenumber" name="L201" href="#L201">201</a> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * Write a property.</em> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @param out the output stream</em> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @param key the key of the property</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @param value the value of the property</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> PrintWriter out, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Object value) { -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_comment">// escape the key</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">final</strong> String k = StringEscapeUtils.escapeXml10(key); -<a class="jxr_linenumber" name="L212" href="#L212">212</a> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">final</strong> String v = escapeValue(value); -<a class="jxr_linenumber" name="L215" href="#L215">215</a> out.println(<span class="jxr_string">" <entry key=\""</span> + k + <span class="jxr_string">"\">"</span> + v + <span class="jxr_string">"</entry>"</span>); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L217" href="#L217">217</a> out.println(<span class="jxr_string">" <entry key=\""</span> + k + <span class="jxr_string">"\"/>"</span>); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> } -<a class="jxr_linenumber" name="L219" href="#L219">219</a> } -<a class="jxr_linenumber" name="L220" href="#L220">220</a> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * Write a list property.</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * @param out the output stream</em> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * @param key the key of the property</em> -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * @param values a list with all property values</em> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> PrintWriter out, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> List<?> values) { -<a class="jxr_linenumber" name="L229" href="#L229">229</a> values.forEach(value -> writeProperty(out, key, value)); -<a class="jxr_linenumber" name="L230" href="#L230">230</a> } -<a class="jxr_linenumber" name="L231" href="#L231">231</a> -<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * Writes the configuration as child to the given DOM node</em> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @param document The DOM document to add the configuration to</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @param parent The DOM parent node</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> save(<strong class="jxr_keyword">final</strong> Document document, <strong class="jxr_keyword">final</strong> Node parent) { -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">final</strong> Element properties = document.createElement(<span class="jxr_string">"properties"</span>); -<a class="jxr_linenumber" name="L241" href="#L241">241</a> parent.appendChild(properties); -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">if</strong> (getHeader() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">final</strong> Element comment = document.createElement(<span class="jxr_string">"comment"</span>); -<a class="jxr_linenumber" name="L244" href="#L244">244</a> properties.appendChild(comment); -<a class="jxr_linenumber" name="L245" href="#L245">245</a> comment.setTextContent(StringEscapeUtils.escapeXml10(getHeader())); -<a class="jxr_linenumber" name="L246" href="#L246">246</a> } -<a class="jxr_linenumber" name="L247" href="#L247">247</a> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">final</strong> Iterator<String> keys = getKeys(); -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">while</strong> (keys.hasNext()) { -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">final</strong> String key = keys.next(); -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">final</strong> Object value = getProperty(key); -<a class="jxr_linenumber" name="L252" href="#L252">252</a> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">if</strong> (value instanceof List) { -<a class="jxr_linenumber" name="L254" href="#L254">254</a> writeProperty(document, properties, key, (List<?>) value); -<a class="jxr_linenumber" name="L255" href="#L255">255</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L256" href="#L256">256</a> writeProperty(document, properties, key, value); -<a class="jxr_linenumber" name="L257" href="#L257">257</a> } -<a class="jxr_linenumber" name="L258" href="#L258">258</a> } -<a class="jxr_linenumber" name="L259" href="#L259">259</a> } -<a class="jxr_linenumber" name="L260" href="#L260">260</a> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * Initializes this object with a {@code FileLocator}. The locator is accessed during load and save operations.</em> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * @param locator the associated {@code FileLocator}</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> @Override -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> initFileLocator(<strong class="jxr_keyword">final</strong> <a name="FileLocator" href="../../../../org/apache/commons/configuration2/io/FileLocator.html#FileLocator">FileLocator</a> locator) { -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">this</strong>.locator = locator; -<a class="jxr_linenumber" name="L269" href="#L269">269</a> } -<a class="jxr_linenumber" name="L270" href="#L270">270</a> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> Document document, <strong class="jxr_keyword">final</strong> Node properties, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Object value) { -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">final</strong> Element entry = document.createElement(<span class="jxr_string">"entry"</span>); -<a class="jxr_linenumber" name="L273" href="#L273">273</a> properties.appendChild(entry); -<a class="jxr_linenumber" name="L274" href="#L274">274</a> -<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_comment">// escape the key</em> -<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">final</strong> String k = StringEscapeUtils.escapeXml10(key); -<a class="jxr_linenumber" name="L277" href="#L277">277</a> entry.setAttribute(<span class="jxr_string">"key"</span>, k); -<a class="jxr_linenumber" name="L278" href="#L278">278</a> -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">final</strong> String v = escapeValue(value); -<a class="jxr_linenumber" name="L281" href="#L281">281</a> entry.setTextContent(v); -<a class="jxr_linenumber" name="L282" href="#L282">282</a> } -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } -<a class="jxr_linenumber" name="L284" href="#L284">284</a> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> Document document, <strong class="jxr_keyword">final</strong> Node properties, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> List<?> values) { -<a class="jxr_linenumber" name="L286" href="#L286">286</a> values.forEach(value -> writeProperty(document, properties, key, value)); -<a class="jxr_linenumber" name="L287" href="#L287">287</a> } -<a class="jxr_linenumber" name="L288" href="#L288">288</a> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * Escapes a property value before it is written to disk.</em> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @param value the value to be escaped</em> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @return the escaped value</em> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">private</strong> String escapeValue(<strong class="jxr_keyword">final</strong> Object value) { -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">final</strong> String v = StringEscapeUtils.escapeXml10(String.valueOf(value)); -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">return</strong> String.valueOf(getListDelimiterHandler().escape(v, ListDelimiterHandler.NOOP_TRANSFORMER)); -<a class="jxr_linenumber" name="L298" href="#L298">298</a> } -<a class="jxr_linenumber" name="L299" href="#L299">299</a> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * SAX Handler to parse a XML properties file.</em> -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @since 1.2</em> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> XMLPropertiesHandler <strong class="jxr_keyword">extends</strong> DefaultHandler { -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment">/** The key of the current entry being parsed. */</em> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">private</strong> String key; -<a class="jxr_linenumber" name="L308" href="#L308">308</a> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment">/** The value of the current entry being parsed. */</em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">private</strong> StringBuilder value = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L311" href="#L311">311</a> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment">/** Indicates that a comment is being parsed. */</em> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inCommentElement; -<a class="jxr_linenumber" name="L314" href="#L314">314</a> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment">/** Indicates that an entry is being parsed. */</em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inEntryElement; -<a class="jxr_linenumber" name="L317" href="#L317">317</a> -<a class="jxr_linenumber" name="L318" href="#L318">318</a> @Override -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> startElement(<strong class="jxr_keyword">final</strong> String uri, <strong class="jxr_keyword">final</strong> String localName, <strong class="jxr_keyword">final</strong> String qName, <strong class="jxr_keyword">final</strong> Attributes attrs) { -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"comment"</span>.equals(qName)) { -<a class="jxr_linenumber" name="L321" href="#L321">321</a> inCommentElement = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L322" href="#L322">322</a> } -<a class="jxr_linenumber" name="L323" href="#L323">323</a> -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"entry"</span>.equals(qName)) { -<a class="jxr_linenumber" name="L325" href="#L325">325</a> key = attrs.getValue(<span class="jxr_string">"key"</span>); -<a class="jxr_linenumber" name="L326" href="#L326">326</a> inEntryElement = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L327" href="#L327">327</a> } -<a class="jxr_linenumber" name="L328" href="#L328">328</a> } -<a class="jxr_linenumber" name="L329" href="#L329">329</a> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> @Override -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endElement(<strong class="jxr_keyword">final</strong> String uri, <strong class="jxr_keyword">final</strong> String localName, <strong class="jxr_keyword">final</strong> String qName) { -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">if</strong> (inCommentElement) { -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_comment">// We've just finished a <comment> element so set the header</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> setHeader(value.toString()); -<a class="jxr_linenumber" name="L335" href="#L335">335</a> inCommentElement = false; -<a class="jxr_linenumber" name="L336" href="#L336">336</a> } -<a class="jxr_linenumber" name="L337" href="#L337">337</a> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">if</strong> (inEntryElement) { -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_comment">// We've just finished an <entry> element, so add the key/value pair</em> -<a class="jxr_linenumber" name="L340" href="#L340">340</a> addProperty(key, value.toString()); -<a class="jxr_linenumber" name="L341" href="#L341">341</a> inEntryElement = false; -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_comment">// Clear the element value buffer</em> -<a class="jxr_linenumber" name="L345" href="#L345">345</a> value = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L346" href="#L346">346</a> } -<a class="jxr_linenumber" name="L347" href="#L347">347</a> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> @Override -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> characters(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] chars, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> start, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length) { -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * We're currently processing an element. All character data from now until the next endElement() call will be the data</em> -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * for this element.</em> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> value.append(chars, start, length); -<a class="jxr_linenumber" name="L355" href="#L355">355</a> } -<a class="jxr_linenumber" name="L356" href="#L356">356</a> } -<a class="jxr_linenumber" name="L357" href="#L357">357</a> } +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Objects; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParser; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> javax.xml.parsers.SAXParserFactory; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.convert.ListDelimiterHandler; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.ex.ConfigurationException; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.io.FileLocator; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.commons.configuration2.io.FileLocatorAware; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.commons.text.StringEscapeUtils; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Node; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.xml.sax.Attributes; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.xml.sax.InputSource; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.xml.sax.XMLReader; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.xml.sax.helpers.DefaultHandler; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> +<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> <em class="jxr_javadoccomment"> * This configuration implements the XML properties format introduced in Java, see</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html."; target="alexandria_uri">https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html.</a> An XML properties file looks like this:</em> +<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"> * <pre></em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * &lt;?xml version="1.0"?&gt;</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * &lt;!DOCTYPE properties SYSTEM "<a href="http://java.sun.com/dtd/properties.dtd"; target="alexandria_uri">http://java.sun.com/dtd/properties.dtd</a>"&gt;</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * &lt;properties&gt;</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * &lt;comment&gt;Description of the property list&lt;/comment&gt;</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * &lt;entry key="key1"&gt;value1&lt;/entry&gt;</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * &lt;entry key="key2"&gt;value2&lt;/entry&gt;</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * &lt;entry key="key3"&gt;value3&lt;/entry&gt;</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * &lt;/properties&gt;</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * </pre></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"> * The Java runtime is not required to use this class. The default encoding for this configuration format is UTF-8.</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Note that unlike {@code PropertiesConfiguration}, {@code XMLPropertiesConfiguration} does not support includes.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <em>Note:</em>Configuration objects of this type can be read concurrently by multiple threads. However if one of</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * these threads modifies the object, synchronization has to be performed manually.</em> +<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"> * @since 1.1</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">public</strong> <strong class="jxr_keyword">class</strong> <a name="XMLPropertiesConfiguration" href="../../../../org/apache/commons/configuration2/XMLPropertiesConfiguration.html#XMLPropertiesConfiguration">XMLPropertiesConfiguration</a> <strong class="jxr_keyword">extends</strong> <a name="BaseConfiguration" href="../../../../org/apache/commons/configuration2/BaseConfiguration.html#BaseConfiguration">BaseConfiguration</a> <strong class="jxr_keyword">implements</strong> FileBasedConfiguration, <a name="FileLocatorAware" href="../../../../org/apache/commons/configuration2/io/FileLocatorAware.html#FileLocatorAware">FileLocatorAware</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"> * The default encoding (UTF-8 as specified by <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html)" target="alexandria_uri">https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html)</a></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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ENCODING = StandardCharsets.UTF_8.name(); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Default string used when the XML is malformed</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String MALFORMED_XML_EXCEPTION = <span class="jxr_string">"Malformed XML"</span>; +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/** The temporary file locator. */</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <a name="FileLocator" href="../../../../org/apache/commons/configuration2/io/FileLocator.html#FileLocator">FileLocator</a> locator; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/** Stores a header comment. */</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> String header; +<a class="jxr_linenumber" name="L85" href="#L85">85</a> +<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"> * Creates an empty XMLPropertyConfiguration object which can be used to synthesize a new Properties file by adding</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * values and then saving(). An object constructed by this C'tor can not be tickled into loading included files because</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * it cannot supply a base for relative includes.</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">public</strong> <a name="XMLPropertiesConfiguration" href="../../../../org/apache/commons/configuration2/XMLPropertiesConfiguration.html#XMLPropertiesConfiguration">XMLPropertiesConfiguration</a>() { +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Creates and loads the XML properties from the specified DOM node.</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @param element The non-null DOM element.</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @throws ConfigurationException Error while loading the Element.</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @since 2.0</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> <strong class="jxr_keyword">public</strong> <a name="XMLPropertiesConfiguration" href="../../../../org/apache/commons/configuration2/XMLPropertiesConfiguration.html#XMLPropertiesConfiguration">XMLPropertiesConfiguration</a>(<strong class="jxr_keyword">final</strong> Element element) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { +<a class="jxr_linenumber" name="L102" href="#L102">102</a> load(Objects.requireNonNull(element, <span class="jxr_string">"element"</span>)); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> } +<a class="jxr_linenumber" name="L104" href="#L104">104</a> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Gets the header comment of this configuration.</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @return the header comment</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> String getHeader() { +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">return</strong> header; +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * Sets the header comment of this configuration.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * @param header the header comment</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setHeader(<strong class="jxr_keyword">final</strong> String header) { +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">this</strong>.header = header; +<a class="jxr_linenumber" name="L121" href="#L121">121</a> } +<a class="jxr_linenumber" name="L122" href="#L122">122</a> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> @Override +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> read(<strong class="jxr_keyword">final</strong> Reader in) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">final</strong> SAXParserFactory factory = SAXParserFactory.newInstance(); +<a class="jxr_linenumber" name="L126" href="#L126">126</a> factory.setNamespaceAware(false); +<a class="jxr_linenumber" name="L127" href="#L127">127</a> factory.setValidating(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L128" href="#L128">128</a> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">final</strong> SAXParser parser = factory.newSAXParser(); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">final</strong> XMLReader xmlReader = parser.getXMLReader(); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> xmlReader.setEntityResolver((publicId, systemId) -> <strong class="jxr_keyword">new</strong> InputSource(getClass().getClassLoader().getResourceAsStream(<span class="jxr_string">"properties.dtd"</span>))); +<a class="jxr_linenumber" name="L134" href="#L134">134</a> xmlReader.setContentHandler(<strong class="jxr_keyword">new</strong> XMLPropertiesHandler()); +<a class="jxr_linenumber" name="L135" href="#L135">135</a> xmlReader.parse(<strong class="jxr_keyword">new</strong> InputSource(in)); +<a class="jxr_linenumber" name="L136" href="#L136">136</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) { +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(<span class="jxr_string">"Unable to parse the configuration file"</span>, e); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> } +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// todo: support included properties ?</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> } +<a class="jxr_linenumber" name="L142" href="#L142">142</a> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Parses a DOM element containing the properties. The DOM element has to follow the XML properties format introduced in</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Java, see <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html"; target="alexandria_uri">https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html</a></em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @param element The DOM element</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @throws ConfigurationException Error while interpreting the DOM</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> load(<strong class="jxr_keyword">final</strong> Element element) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (!element.getNodeName().equals(<span class="jxr_string">"properties"</span>)) { +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(MALFORMED_XML_EXCEPTION); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> } +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">final</strong> NodeList childNodes = element.getChildNodes(); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < childNodes.getLength(); i++) { +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">final</strong> Node item = childNodes.item(i); +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (item instanceof Element) { +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">if</strong> (item.getNodeName().equals(<span class="jxr_string">"comment"</span>)) { +<a class="jxr_linenumber" name="L160" href="#L160">160</a> setHeader(item.getTextContent()); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (item.getNodeName().equals(<span class="jxr_string">"entry"</span>)) { +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">final</strong> String key = ((Element) item).getAttribute(<span class="jxr_string">"key"</span>); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> addProperty(key, item.getTextContent()); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(MALFORMED_XML_EXCEPTION); +<a class="jxr_linenumber" name="L166" href="#L166">166</a> } +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +<a class="jxr_linenumber" name="L168" href="#L168">168</a> } +<a class="jxr_linenumber" name="L169" href="#L169">169</a> } +<a class="jxr_linenumber" name="L170" href="#L170">170</a> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> @Override +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">final</strong> Writer out) <strong class="jxr_keyword">throws</strong> <a name="ConfigurationException" href="../../../../org/apache/commons/configuration2/ex/ConfigurationException.html#ConfigurationException">ConfigurationException</a> { +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">final</strong> PrintWriter writer = <strong class="jxr_keyword">new</strong> PrintWriter(out); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> String encoding = locator != <strong class="jxr_keyword">null</strong> ? locator.getEncoding() : <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (encoding == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> encoding = DEFAULT_ENCODING; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> } +<a class="jxr_linenumber" name="L179" href="#L179">179</a> writer.println(<span class="jxr_string">"<?xml version=\"1.0\" encoding=\""</span> + encoding + <span class="jxr_string">"\"?>"</span>); +<a class="jxr_linenumber" name="L180" href="#L180">180</a> writer.println(<span class="jxr_string">"<!DOCTYPE properties SYSTEM \"http://java.sun.com/dtd/properties.dtd\">";</span>); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> writer.println(<span class="jxr_string">"<properties>"</span>); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (getHeader() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L184" href="#L184">184</a> writer.println(<span class="jxr_string">" <comment>"</span> + StringEscapeUtils.escapeXml10(getHeader()) + <span class="jxr_string">"</comment>"</span>); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> } +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">final</strong> Iterator<String> keys = getKeys(); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">while</strong> (keys.hasNext()) { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">final</strong> String key = keys.next(); +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">final</strong> Object value = getProperty(key); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (value instanceof List) { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> writeProperty(writer, key, (List<?>) value); +<a class="jxr_linenumber" name="L194" href="#L194">194</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L195" href="#L195">195</a> writeProperty(writer, key, value); +<a class="jxr_linenumber" name="L196" href="#L196">196</a> } +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } +<a class="jxr_linenumber" name="L198" href="#L198">198</a> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> writer.println(<span class="jxr_string">"</properties>"</span>); +<a class="jxr_linenumber" name="L200" href="#L200">200</a> writer.flush(); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> } +<a class="jxr_linenumber" name="L202" href="#L202">202</a> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * Write a property.</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @param out the output stream</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * @param key the key of the property</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * @param value the value of the property</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> PrintWriter out, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Object value) { +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_comment">// escape the key</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">final</strong> String k = StringEscapeUtils.escapeXml10(key); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">final</strong> String v = escapeValue(value); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> out.println(<span class="jxr_string">" <entry key=\""</span> + k + <span class="jxr_string">"\">"</span> + v + <span class="jxr_string">"</entry>"</span>); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L218" href="#L218">218</a> out.println(<span class="jxr_string">" <entry key=\""</span> + k + <span class="jxr_string">"\"/>"</span>); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> } +<a class="jxr_linenumber" name="L220" href="#L220">220</a> } +<a class="jxr_linenumber" name="L221" href="#L221">221</a> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * Write a list property.</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * @param out the output stream</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * @param key the key of the property</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * @param values a list with all property values</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> PrintWriter out, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> List<?> values) { +<a class="jxr_linenumber" name="L230" href="#L230">230</a> values.forEach(value -> writeProperty(out, key, value)); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> } +<a class="jxr_linenumber" name="L232" href="#L232">232</a> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * Writes the configuration as child to the given DOM node</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @param document The DOM document to add the configuration to</em> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @param parent The DOM parent node</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> save(<strong class="jxr_keyword">final</strong> Document document, <strong class="jxr_keyword">final</strong> Node parent) { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">final</strong> Element properties = document.createElement(<span class="jxr_string">"properties"</span>); +<a class="jxr_linenumber" name="L242" href="#L242">242</a> parent.appendChild(properties); +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> (getHeader() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">final</strong> Element comment = document.createElement(<span class="jxr_string">"comment"</span>); +<a class="jxr_linenumber" name="L245" href="#L245">245</a> properties.appendChild(comment); +<a class="jxr_linenumber" name="L246" href="#L246">246</a> comment.setTextContent(StringEscapeUtils.escapeXml10(getHeader())); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> } +<a class="jxr_linenumber" name="L248" href="#L248">248</a> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">final</strong> Iterator<String> keys = getKeys(); +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">while</strong> (keys.hasNext()) { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">final</strong> String key = keys.next(); +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">final</strong> Object value = getProperty(key); +<a class="jxr_linenumber" name="L253" href="#L253">253</a> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">if</strong> (value instanceof List) { +<a class="jxr_linenumber" name="L255" href="#L255">255</a> writeProperty(document, properties, key, (List<?>) value); +<a class="jxr_linenumber" name="L256" href="#L256">256</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L257" href="#L257">257</a> writeProperty(document, properties, key, value); +<a class="jxr_linenumber" name="L258" href="#L258">258</a> } +<a class="jxr_linenumber" name="L259" href="#L259">259</a> } +<a class="jxr_linenumber" name="L260" href="#L260">260</a> } +<a class="jxr_linenumber" name="L261" href="#L261">261</a> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * Initializes this object with a {@code FileLocator}. The locator is accessed during load and save operations.</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @param locator the associated {@code FileLocator}</em> +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L267" href="#L267">267</a> @Override +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> initFileLocator(<strong class="jxr_keyword">final</strong> <a name="FileLocator" href="../../../../org/apache/commons/configuration2/io/FileLocator.html#FileLocator">FileLocator</a> locator) { +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">this</strong>.locator = locator; +<a class="jxr_linenumber" name="L270" href="#L270">270</a> } +<a class="jxr_linenumber" name="L271" href="#L271">271</a> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> Document document, <strong class="jxr_keyword">final</strong> Node properties, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> Object value) { +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">final</strong> Element entry = document.createElement(<span class="jxr_string">"entry"</span>); +<a class="jxr_linenumber" name="L274" href="#L274">274</a> properties.appendChild(entry); +<a class="jxr_linenumber" name="L275" href="#L275">275</a> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_comment">// escape the key</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">final</strong> String k = StringEscapeUtils.escapeXml10(key); +<a class="jxr_linenumber" name="L278" href="#L278">278</a> entry.setAttribute(<span class="jxr_string">"key"</span>, k); +<a class="jxr_linenumber" name="L279" href="#L279">279</a> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">final</strong> String v = escapeValue(value); +<a class="jxr_linenumber" name="L282" href="#L282">282</a> entry.setTextContent(v); +<a class="jxr_linenumber" name="L283" href="#L283">283</a> } +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } +<a class="jxr_linenumber" name="L285" href="#L285">285</a> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeProperty(<strong class="jxr_keyword">final</strong> Document document, <strong class="jxr_keyword">final</strong> Node properties, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> List<?> values) { +<a class="jxr_linenumber" name="L287" href="#L287">287</a> values.forEach(value -> writeProperty(document, properties, key, value)); +<a class="jxr_linenumber" name="L288" href="#L288">288</a> } +<a class="jxr_linenumber" name="L289" href="#L289">289</a> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * Escapes a property value before it is written to disk.</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> * @param value the value to be escaped</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment"> * @return the escaped value</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">private</strong> String escapeValue(<strong class="jxr_keyword">final</strong> Object value) { +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">final</strong> String v = StringEscapeUtils.escapeXml10(String.valueOf(value)); +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">return</strong> String.valueOf(getListDelimiterHandler().escape(v, ListDelimiterHandler.NOOP_TRANSFORMER)); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> } +<a class="jxr_linenumber" name="L300" href="#L300">300</a> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * SAX Handler to parse a XML properties file.</em> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * @since 1.2</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> XMLPropertiesHandler <strong class="jxr_keyword">extends</strong> DefaultHandler { +<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/** The key of the current entry being parsed. */</em> +<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">private</strong> String key; +<a class="jxr_linenumber" name="L309" href="#L309">309</a> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">/** The value of the current entry being parsed. */</em> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">private</strong> StringBuilder value = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="L312" href="#L312">312</a> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment">/** Indicates that a comment is being parsed. */</em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inCommentElement; +<a class="jxr_linenumber" name="L315" href="#L315">315</a> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment">/** Indicates that an entry is being parsed. */</em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> inEntryElement; +<a class="jxr_linenumber" name="L318" href="#L318">318</a> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> @Override +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> startElement(<strong class="jxr_keyword">final</strong> String uri, <strong class="jxr_keyword">final</strong> String localName, <strong class="jxr_keyword">final</strong> String qName, <strong class="jxr_keyword">final</strong> Attributes attrs) { +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"comment"</span>.equals(qName)) { +<a class="jxr_linenumber" name="L322" href="#L322">322</a> inCommentElement = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L323" href="#L323">323</a> } +<a class="jxr_linenumber" name="L324" href="#L324">324</a> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"entry"</span>.equals(qName)) { +<a class="jxr_linenumber" name="L326" href="#L326">326</a> key = attrs.getValue(<span class="jxr_string">"key"</span>); +<a class="jxr_linenumber" name="L327" href="#L327">327</a> inEntryElement = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L328" href="#L328">328</a> } +<a class="jxr_linenumber" name="L329" href="#L329">329</a> } +<a class="jxr_linenumber" name="L330" href="#L330">330</a> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> @Override +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endElement(<strong class="jxr_keyword">final</strong> String uri, <strong class="jxr_keyword">final</strong> String localName, <strong class="jxr_keyword">final</strong> String qName) {
[... 30 lines stripped ...]
