http://git-wip-us.apache.org/repos/asf/juneau-website/blob/81ca4d4d/content/site/apidocs/src-html/org/apache/juneau/ini/ConfigFile.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/ini/ConfigFile.html b/content/site/apidocs/src-html/org/apache/juneau/ini/ConfigFile.html index 3ca5423..726c7c9 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/ini/ConfigFile.html +++ b/content/site/apidocs/src-html/org/apache/juneau/ini/ConfigFile.html @@ -45,1182 +45,1217 @@ <span class="sourceLineNo">037</span> * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.ini</a> for usage information.<a name="line.37"></a> <span class="sourceLineNo">038</span> */<a name="line.38"></a> <span class="sourceLineNo">039</span>public abstract class ConfigFile implements Map<String,Section> {<a name="line.39"></a> -<span class="sourceLineNo">040</span><a name="line.40"></a> -<span class="sourceLineNo">041</span> //--------------------------------------------------------------------------------<a name="line.41"></a> -<span class="sourceLineNo">042</span> // Abstract methods<a name="line.42"></a> -<span class="sourceLineNo">043</span> //--------------------------------------------------------------------------------<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Retrieves an entry value from this config file.<a name="line.46"></a> -<span class="sourceLineNo">047</span> *<a name="line.47"></a> -<span class="sourceLineNo">048</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * @return The value, or the default value if the section or value doesn't exist.<a name="line.50"></a> -<span class="sourceLineNo">051</span> */<a name="line.51"></a> -<span class="sourceLineNo">052</span> public abstract String get(String sectionName, String sectionKey);<a name="line.52"></a> +<span class="sourceLineNo">040</span> <a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * Instantiates a new clean-slate {@link ConfigFileBuilder} object.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * <a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * This is equivalent to simply calling <code><jk>new</jk> ConfigFileBuilder()</code>.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <a name="line.46"></a> +<span class="sourceLineNo">047</span> * @return A new {@link ConfigFileBuilder} object.<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span> public static ConfigFileBuilder create() {<a name="line.49"></a> +<span class="sourceLineNo">050</span> return new ConfigFileBuilder();<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<a name="line.51"></a> +<span class="sourceLineNo">052</span> <a name="line.52"></a> <span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span> /**<a name="line.54"></a> -<span class="sourceLineNo">055</span> * Sets an entry value in this config file.<a name="line.55"></a> -<span class="sourceLineNo">056</span> *<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.58"></a> -<span class="sourceLineNo">059</span> * @param value The new value.<a name="line.59"></a> -<span class="sourceLineNo">060</span> * @param serializer<a name="line.60"></a> -<span class="sourceLineNo">061</span> * The serializer to use for serializing the object.<a name="line.61"></a> -<span class="sourceLineNo">062</span> * If <jk>null</jk>, then uses the predefined serializer on the config file.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @param encoded If <jk>true</jk>, then encode the value using the encoder associated with this config file.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * @param newline If <jk>true</jk>, then put serialized output on a separate line from the key.<a name="line.64"></a> -<span class="sourceLineNo">065</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.65"></a> -<span class="sourceLineNo">066</span> * @throws SerializeException If the object value could not be converted to a JSON string for some reason.<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.67"></a> -<span class="sourceLineNo">068</span> */<a name="line.68"></a> -<span class="sourceLineNo">069</span> public abstract String put(String sectionName, String sectionKey, Object value, Serializer serializer,<a name="line.69"></a> -<span class="sourceLineNo">070</span> boolean encoded, boolean newline) throws SerializeException;<a name="line.70"></a> -<span class="sourceLineNo">071</span><a name="line.71"></a> -<span class="sourceLineNo">072</span> /**<a name="line.72"></a> -<span class="sourceLineNo">073</span> * Identical to {@link #put(String, String, Object, Serializer, boolean, boolean)} except used when the value is a<a name="line.73"></a> -<span class="sourceLineNo">074</span> * simple string to avoid having to catch a {@link SerializeException}.<a name="line.74"></a> -<span class="sourceLineNo">075</span> *<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.77"></a> -<span class="sourceLineNo">078</span> * @param value The new value.<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @param encoded<a name="line.79"></a> -<span class="sourceLineNo">080</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.80"></a> -<span class="sourceLineNo">081</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.81"></a> -<span class="sourceLineNo">082</span> */<a name="line.82"></a> -<span class="sourceLineNo">083</span> public abstract String put(String sectionName, String sectionKey, String value, boolean encoded);<a name="line.83"></a> +<span class="sourceLineNo">054</span> //--------------------------------------------------------------------------------<a name="line.54"></a> +<span class="sourceLineNo">055</span> // Abstract methods<a name="line.55"></a> +<span class="sourceLineNo">056</span> //--------------------------------------------------------------------------------<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * Retrieves an entry value from this config file.<a name="line.59"></a> +<span class="sourceLineNo">060</span> *<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @return The value, or the default value if the section or value doesn't exist.<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> public abstract String get(String sectionName, String sectionKey);<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * Sets an entry value in this config file.<a name="line.68"></a> +<span class="sourceLineNo">069</span> *<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * @param value The new value.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * @param serializer<a name="line.73"></a> +<span class="sourceLineNo">074</span> * The serializer to use for serializing the object.<a name="line.74"></a> +<span class="sourceLineNo">075</span> * If <jk>null</jk>, then uses the predefined serializer on the config file.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @param encoded If <jk>true</jk>, then encode the value using the encoder associated with this config file.<a name="line.76"></a> +<span class="sourceLineNo">077</span> * @param newline If <jk>true</jk>, then put serialized output on a separate line from the key.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @throws SerializeException If the object value could not be converted to a JSON string for some reason.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> public abstract String put(String sectionName, String sectionKey, Object value, Serializer serializer,<a name="line.82"></a> +<span class="sourceLineNo">083</span> boolean encoded, boolean newline) throws SerializeException;<a name="line.83"></a> <span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span><a name="line.85"></a> -<span class="sourceLineNo">086</span> /**<a name="line.86"></a> -<span class="sourceLineNo">087</span> * Removes an entry from this config file.<a name="line.87"></a> +<span class="sourceLineNo">085</span> /**<a name="line.85"></a> +<span class="sourceLineNo">086</span> * Identical to {@link #put(String, String, Object, Serializer, boolean, boolean)} except used when the value is a<a name="line.86"></a> +<span class="sourceLineNo">087</span> * simple string to avoid having to catch a {@link SerializeException}.<a name="line.87"></a> <span class="sourceLineNo">088</span> *<a name="line.88"></a> <span class="sourceLineNo">089</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.89"></a> <span class="sourceLineNo">090</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.90"></a> -<span class="sourceLineNo">091</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.92"></a> -<span class="sourceLineNo">093</span> */<a name="line.93"></a> -<span class="sourceLineNo">094</span> public abstract String remove(String sectionName, String sectionKey);<a name="line.94"></a> -<span class="sourceLineNo">095</span><a name="line.95"></a> -<span class="sourceLineNo">096</span> /**<a name="line.96"></a> -<span class="sourceLineNo">097</span> * Returns the current set of keys in the specified section.<a name="line.97"></a> -<span class="sourceLineNo">098</span> *<a name="line.98"></a> -<span class="sourceLineNo">099</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.99"></a> -<span class="sourceLineNo">100</span> * @return The list of keys in the specified section, or <jk>null</jk> if section does not exist.<a name="line.100"></a> -<span class="sourceLineNo">101</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.101"></a> -<span class="sourceLineNo">102</span> */<a name="line.102"></a> -<span class="sourceLineNo">103</span> public abstract Set<String> getSectionKeys(String sectionName);<a name="line.103"></a> -<span class="sourceLineNo">104</span><a name="line.104"></a> -<span class="sourceLineNo">105</span> /**<a name="line.105"></a> -<span class="sourceLineNo">106</span> * Reloads this config file object from the persisted file contents if the modified timestamp on the file has changed.<a name="line.106"></a> -<span class="sourceLineNo">107</span> *<a name="line.107"></a> -<span class="sourceLineNo">108</span> * @return This object (for method chaining).<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @throws IOException If file could not be read, or file is not associated with this object.<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.110"></a> -<span class="sourceLineNo">111</span> */<a name="line.111"></a> -<span class="sourceLineNo">112</span> public abstract ConfigFile loadIfModified() throws IOException;<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Loads this config file object from the persisted file contents.<a name="line.115"></a> -<span class="sourceLineNo">116</span> *<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @return This object (for method chaining).<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @throws IOException If file could not be read, or file is not associated with this object.<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.119"></a> -<span class="sourceLineNo">120</span> */<a name="line.120"></a> -<span class="sourceLineNo">121</span> public abstract ConfigFile load() throws IOException;<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Loads this config file object from the specified reader.<a name="line.124"></a> -<span class="sourceLineNo">125</span> *<a name="line.125"></a> -<span class="sourceLineNo">126</span> * @param r The reader to read from.<a name="line.126"></a> -<span class="sourceLineNo">127</span> * @return This object (for method chaining).<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @throws IOException If file could not be read, or file is not associated with this object.<a name="line.128"></a> -<span class="sourceLineNo">129</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.129"></a> -<span class="sourceLineNo">130</span> */<a name="line.130"></a> -<span class="sourceLineNo">131</span> public abstract ConfigFile load(Reader r) throws IOException;<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> /**<a name="line.133"></a> -<span class="sourceLineNo">134</span> * Adds arbitrary lines to the specified config file section.<a name="line.134"></a> -<span class="sourceLineNo">135</span> *<a name="line.135"></a> -<span class="sourceLineNo">136</span> * <p><a name="line.136"></a> -<span class="sourceLineNo">137</span> * The lines can be any of the following....<a name="line.137"></a> -<span class="sourceLineNo">138</span> * <ul class='spaced-list'><a name="line.138"></a> -<span class="sourceLineNo">139</span> * <li><a name="line.139"></a> -<span class="sourceLineNo">140</span> * <js>"# comment"</js> - A comment line.<a name="line.140"></a> -<span class="sourceLineNo">141</span> * <li><a name="line.141"></a> -<span class="sourceLineNo">142</span> * <js>"key=val"</js> - A key/value pair (equivalent to calling {@link #put(String,Object)}.<a name="line.142"></a> -<span class="sourceLineNo">143</span> * <li><a name="line.143"></a> -<span class="sourceLineNo">144</span> * <js>" foobar "</js> - Anything else (interpreted as a comment).<a name="line.144"></a> -<span class="sourceLineNo">145</span> * </ul><a name="line.145"></a> -<span class="sourceLineNo">146</span> *<a name="line.146"></a> -<span class="sourceLineNo">147</span> * <p><a name="line.147"></a> -<span class="sourceLineNo">148</span> * If the section does not exist, it will automatically be created.<a name="line.148"></a> -<span class="sourceLineNo">149</span> *<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param section The name of the section to add lines to, or <jk>null</jk> to add to the beginning unnamed section.<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @param lines The lines to add to the section.<a name="line.151"></a> -<span class="sourceLineNo">152</span> * @return This object (for method chaining).<a name="line.152"></a> -<span class="sourceLineNo">153</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.153"></a> -<span class="sourceLineNo">154</span> */<a name="line.154"></a> -<span class="sourceLineNo">155</span> public abstract ConfigFile addLines(String section, String...lines);<a name="line.155"></a> -<span class="sourceLineNo">156</span><a name="line.156"></a> -<span class="sourceLineNo">157</span> /**<a name="line.157"></a> -<span class="sourceLineNo">158</span> * Adds header comments to the specified section.<a name="line.158"></a> +<span class="sourceLineNo">091</span> * @param value The new value.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @param encoded<a name="line.92"></a> +<span class="sourceLineNo">093</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.93"></a> +<span class="sourceLineNo">094</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.94"></a> +<span class="sourceLineNo">095</span> */<a name="line.95"></a> +<span class="sourceLineNo">096</span> public abstract String put(String sectionName, String sectionKey, String value, boolean encoded);<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span><a name="line.98"></a> +<span class="sourceLineNo">099</span> /**<a name="line.99"></a> +<span class="sourceLineNo">100</span> * Removes an entry from this config file.<a name="line.100"></a> +<span class="sourceLineNo">101</span> *<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.102"></a> +<span class="sourceLineNo">103</span> * @param sectionKey The section key. Must not be <jk>null</jk>.<a name="line.103"></a> +<span class="sourceLineNo">104</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> public abstract String remove(String sectionName, String sectionKey);<a name="line.107"></a> +<span class="sourceLineNo">108</span><a name="line.108"></a> +<span class="sourceLineNo">109</span> /**<a name="line.109"></a> +<span class="sourceLineNo">110</span> * Returns the current set of keys in the specified section.<a name="line.110"></a> +<span class="sourceLineNo">111</span> *<a name="line.111"></a> +<span class="sourceLineNo">112</span> * @param sectionName The section name. Must not be <jk>null</jk>.<a name="line.112"></a> +<span class="sourceLineNo">113</span> * @return The list of keys in the specified section, or <jk>null</jk> if section does not exist.<a name="line.113"></a> +<span class="sourceLineNo">114</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.114"></a> +<span class="sourceLineNo">115</span> */<a name="line.115"></a> +<span class="sourceLineNo">116</span> public abstract Set<String> getSectionKeys(String sectionName);<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Reloads this config file object from the persisted file contents if the modified timestamp on the file has changed.<a name="line.119"></a> +<span class="sourceLineNo">120</span> *<a name="line.120"></a> +<span class="sourceLineNo">121</span> * @return This object (for method chaining).<a name="line.121"></a> +<span class="sourceLineNo">122</span> * @throws IOException If file could not be read, or file is not associated with this object.<a name="line.122"></a> +<span class="sourceLineNo">123</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.123"></a> +<span class="sourceLineNo">124</span> */<a name="line.124"></a> +<span class="sourceLineNo">125</span> public abstract ConfigFile loadIfModified() throws IOException;<a name="line.125"></a> +<span class="sourceLineNo">126</span><a name="line.126"></a> +<span class="sourceLineNo">127</span> /**<a name="line.127"></a> +<span class="sourceLineNo">128</span> * Loads this config file object from the persisted file contents.<a name="line.128"></a> +<span class="sourceLineNo">129</span> *<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @return This object (for method chaining).<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @throws IOException If file could not be read, or file is not associated with this object.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> public abstract ConfigFile load() throws IOException;<a name="line.134"></a> +<span class="sourceLineNo">135</span><a name="line.135"></a> +<span class="sourceLineNo">136</span> /**<a name="line.136"></a> +<span class="sourceLineNo">137</span> * Loads this config file object from the specified reader.<a name="line.137"></a> +<span class="sourceLineNo">138</span> *<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @param r The reader to read from.<a name="line.139"></a> +<span class="sourceLineNo">140</span> * @return This object (for method chaining).<a name="line.140"></a> +<span class="sourceLineNo">141</span> * @throws IOException If file could not be read, or file is not associated with this object.<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> public abstract ConfigFile load(Reader r) throws IOException;<a name="line.144"></a> +<span class="sourceLineNo">145</span><a name="line.145"></a> +<span class="sourceLineNo">146</span> /**<a name="line.146"></a> +<span class="sourceLineNo">147</span> * Adds arbitrary lines to the specified config file section.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <p><a name="line.149"></a> +<span class="sourceLineNo">150</span> * The lines can be any of the following....<a name="line.150"></a> +<span class="sourceLineNo">151</span> * <ul class='spaced-list'><a name="line.151"></a> +<span class="sourceLineNo">152</span> * <li><a name="line.152"></a> +<span class="sourceLineNo">153</span> * <js>"# comment"</js> - A comment line.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <li><a name="line.154"></a> +<span class="sourceLineNo">155</span> * <js>"key=val"</js> - A key/value pair (equivalent to calling {@link #put(String,Object)}.<a name="line.155"></a> +<span class="sourceLineNo">156</span> * <li><a name="line.156"></a> +<span class="sourceLineNo">157</span> * <js>" foobar "</js> - Anything else (interpreted as a comment).<a name="line.157"></a> +<span class="sourceLineNo">158</span> * </ul><a name="line.158"></a> <span class="sourceLineNo">159</span> *<a name="line.159"></a> <span class="sourceLineNo">160</span> * <p><a name="line.160"></a> -<span class="sourceLineNo">161</span> * Header comments are defined as lines that start with <jk>"#"</jk> immediately preceding a section header<a name="line.161"></a> -<span class="sourceLineNo">162</span> * <jk>"[section]"</jk>.<a name="line.162"></a> -<span class="sourceLineNo">163</span> * These are handled as part of the section itself instead of being interpreted as comments in the previous section.<a name="line.163"></a> -<span class="sourceLineNo">164</span> *<a name="line.164"></a> -<span class="sourceLineNo">165</span> * <p><a name="line.165"></a> -<span class="sourceLineNo">166</span> * Header comments can be of the following formats...<a name="line.166"></a> -<span class="sourceLineNo">167</span> * <ul class='spaced-list'><a name="line.167"></a> -<span class="sourceLineNo">168</span> * <li><a name="line.168"></a> -<span class="sourceLineNo">169</span> * <js>"# comment"</js> - A comment line.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * <li><a name="line.170"></a> -<span class="sourceLineNo">171</span> * <js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>).<a name="line.171"></a> -<span class="sourceLineNo">172</span> * </ul><a name="line.172"></a> -<span class="sourceLineNo">173</span> *<a name="line.173"></a> -<span class="sourceLineNo">174</span> * <p><a name="line.174"></a> -<span class="sourceLineNo">175</span> * If the section does not exist, it will automatically be created.<a name="line.175"></a> -<span class="sourceLineNo">176</span> *<a name="line.176"></a> -<span class="sourceLineNo">177</span> * @param section The name of the section to add lines to, or <jk>null</jk> to add to the default section.<a name="line.177"></a> -<span class="sourceLineNo">178</span> * @param headerComments The comment lines to add to the section.<a name="line.178"></a> -<span class="sourceLineNo">179</span> * @return This object (for method chaining).<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> public abstract ConfigFile addHeaderComments(String section, String...headerComments);<a name="line.182"></a> -<span class="sourceLineNo">183</span><a name="line.183"></a> -<span class="sourceLineNo">184</span> /**<a name="line.184"></a> -<span class="sourceLineNo">185</span> * Removes any header comments from the specified section.<a name="line.185"></a> +<span class="sourceLineNo">161</span> * If the section does not exist, it will automatically be created.<a name="line.161"></a> +<span class="sourceLineNo">162</span> *<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @param section The name of the section to add lines to, or <jk>null</jk> to add to the beginning unnamed section.<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @param lines The lines to add to the section.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * @return This object (for method chaining).<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> public abstract ConfigFile addLines(String section, String...lines);<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> /**<a name="line.170"></a> +<span class="sourceLineNo">171</span> * Adds header comments to the specified section.<a name="line.171"></a> +<span class="sourceLineNo">172</span> *<a name="line.172"></a> +<span class="sourceLineNo">173</span> * <p><a name="line.173"></a> +<span class="sourceLineNo">174</span> * Header comments are defined as lines that start with <jk>"#"</jk> immediately preceding a section header<a name="line.174"></a> +<span class="sourceLineNo">175</span> * <jk>"[section]"</jk>.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * These are handled as part of the section itself instead of being interpreted as comments in the previous section.<a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * Header comments can be of the following formats...<a name="line.179"></a> +<span class="sourceLineNo">180</span> * <ul class='spaced-list'><a name="line.180"></a> +<span class="sourceLineNo">181</span> * <li><a name="line.181"></a> +<span class="sourceLineNo">182</span> * <js>"# comment"</js> - A comment line.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * <li><a name="line.183"></a> +<span class="sourceLineNo">184</span> * <js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>).<a name="line.184"></a> +<span class="sourceLineNo">185</span> * </ul><a name="line.185"></a> <span class="sourceLineNo">186</span> *<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @param section The name of the section to remove header comments from.<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @return This object (for method chaining).<a name="line.188"></a> -<span class="sourceLineNo">189</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> public abstract ConfigFile clearHeaderComments(String section);<a name="line.191"></a> -<span class="sourceLineNo">192</span><a name="line.192"></a> -<span class="sourceLineNo">193</span> /**<a name="line.193"></a> -<span class="sourceLineNo">194</span> * Returns the reusable bean session associated with this config file.<a name="line.194"></a> -<span class="sourceLineNo">195</span> *<a name="line.195"></a> -<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> -<span class="sourceLineNo">197</span> * Used for performing simple datatype conversions.<a name="line.197"></a> -<span class="sourceLineNo">198</span> *<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return The reusable bean session associated with this config file.<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> protected abstract BeanSession getBeanSession();<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /**<a name="line.203"></a> -<span class="sourceLineNo">204</span> * Converts the specified object to a string.<a name="line.204"></a> -<span class="sourceLineNo">205</span> *<a name="line.205"></a> -<span class="sourceLineNo">206</span> * <p><a name="line.206"></a> -<span class="sourceLineNo">207</span> * The serialized output is identical to LAX JSON (JSON with unquoted attributes) except for the following<a name="line.207"></a> -<span class="sourceLineNo">208</span> * exceptions:<a name="line.208"></a> -<span class="sourceLineNo">209</span> * <ul><a name="line.209"></a> -<span class="sourceLineNo">210</span> * <li>Top level strings are not quoted.<a name="line.210"></a> -<span class="sourceLineNo">211</span> * </ul><a name="line.211"></a> -<span class="sourceLineNo">212</span> *<a name="line.212"></a> -<span class="sourceLineNo">213</span> * @param o The object to serialize.<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @param serializer<a name="line.214"></a> -<span class="sourceLineNo">215</span> * The serializer to use for serializing the object.<a name="line.215"></a> -<span class="sourceLineNo">216</span> * If <jk>null</jk>, then uses the predefined serializer on the config file.<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param newline If <jk>true</jk>, add a newline at the beginning of the value.<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @return The serialized object.<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @throws SerializeException<a name="line.219"></a> -<span class="sourceLineNo">220</span> */<a name="line.220"></a> -<span class="sourceLineNo">221</span> protected abstract String serialize(Object o, Serializer serializer, boolean newline) throws SerializeException;<a name="line.221"></a> -<span class="sourceLineNo">222</span><a name="line.222"></a> -<span class="sourceLineNo">223</span> /**<a name="line.223"></a> -<span class="sourceLineNo">224</span> * Converts the specified string to an object of the specified type.<a name="line.224"></a> +<span class="sourceLineNo">187</span> * <p><a name="line.187"></a> +<span class="sourceLineNo">188</span> * If the section does not exist, it will automatically be created.<a name="line.188"></a> +<span class="sourceLineNo">189</span> *<a name="line.189"></a> +<span class="sourceLineNo">190</span> * @param section The name of the section to add lines to, or <jk>null</jk> to add to the default section.<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @param headerComments The comment lines to add to the section.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @return This object (for method chaining).<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.193"></a> +<span class="sourceLineNo">194</span> */<a name="line.194"></a> +<span class="sourceLineNo">195</span> public abstract ConfigFile addHeaderComments(String section, String...headerComments);<a name="line.195"></a> +<span class="sourceLineNo">196</span><a name="line.196"></a> +<span class="sourceLineNo">197</span> /**<a name="line.197"></a> +<span class="sourceLineNo">198</span> * Removes any header comments from the specified section.<a name="line.198"></a> +<span class="sourceLineNo">199</span> *<a name="line.199"></a> +<span class="sourceLineNo">200</span> * @param section The name of the section to remove header comments from.<a name="line.200"></a> +<span class="sourceLineNo">201</span> * @return This object (for method chaining).<a name="line.201"></a> +<span class="sourceLineNo">202</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.202"></a> +<span class="sourceLineNo">203</span> */<a name="line.203"></a> +<span class="sourceLineNo">204</span> public abstract ConfigFile clearHeaderComments(String section);<a name="line.204"></a> +<span class="sourceLineNo">205</span><a name="line.205"></a> +<span class="sourceLineNo">206</span> /**<a name="line.206"></a> +<span class="sourceLineNo">207</span> * Returns the reusable bean session associated with this config file.<a name="line.207"></a> +<span class="sourceLineNo">208</span> *<a name="line.208"></a> +<span class="sourceLineNo">209</span> * <p><a name="line.209"></a> +<span class="sourceLineNo">210</span> * Used for performing simple datatype conversions.<a name="line.210"></a> +<span class="sourceLineNo">211</span> *<a name="line.211"></a> +<span class="sourceLineNo">212</span> * @return The reusable bean session associated with this config file.<a name="line.212"></a> +<span class="sourceLineNo">213</span> */<a name="line.213"></a> +<span class="sourceLineNo">214</span> protected abstract BeanSession getBeanSession();<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> /**<a name="line.216"></a> +<span class="sourceLineNo">217</span> * Converts the specified object to a string.<a name="line.217"></a> +<span class="sourceLineNo">218</span> *<a name="line.218"></a> +<span class="sourceLineNo">219</span> * <p><a name="line.219"></a> +<span class="sourceLineNo">220</span> * The serialized output is identical to LAX JSON (JSON with unquoted attributes) except for the following<a name="line.220"></a> +<span class="sourceLineNo">221</span> * exceptions:<a name="line.221"></a> +<span class="sourceLineNo">222</span> * <ul><a name="line.222"></a> +<span class="sourceLineNo">223</span> * <li>Top level strings are not quoted.<a name="line.223"></a> +<span class="sourceLineNo">224</span> * </ul><a name="line.224"></a> <span class="sourceLineNo">225</span> *<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @param s The string to parse.<a name="line.226"></a> -<span class="sourceLineNo">227</span> * @param parser<a name="line.227"></a> -<span class="sourceLineNo">228</span> * The parser to use for parsing the object.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @param type The data type to create.<a name="line.230"></a> -<span class="sourceLineNo">231</span> * @param args The generic type arguments if the type is a {@link Collection} or {@link Map}<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @return The parsed object.<a name="line.232"></a> -<span class="sourceLineNo">233</span> * @throws ParseException<a name="line.233"></a> -<span class="sourceLineNo">234</span> */<a name="line.234"></a> -<span class="sourceLineNo">235</span> protected abstract <T> T parse(String s, Parser parser, Type type, Type...args) throws ParseException;<a name="line.235"></a> -<span class="sourceLineNo">236</span><a name="line.236"></a> -<span class="sourceLineNo">237</span> /**<a name="line.237"></a> -<span class="sourceLineNo">238</span> * Places a read lock on this config file.<a name="line.238"></a> -<span class="sourceLineNo">239</span> */<a name="line.239"></a> -<span class="sourceLineNo">240</span> protected abstract void readLock();<a name="line.240"></a> -<span class="sourceLineNo">241</span><a name="line.241"></a> -<span class="sourceLineNo">242</span> /**<a name="line.242"></a> -<span class="sourceLineNo">243</span> * Removes the read lock on this config file.<a name="line.243"></a> -<span class="sourceLineNo">244</span> */<a name="line.244"></a> -<span class="sourceLineNo">245</span> protected abstract void readUnlock();<a name="line.245"></a> -<span class="sourceLineNo">246</span><a name="line.246"></a> -<span class="sourceLineNo">247</span><a name="line.247"></a> -<span class="sourceLineNo">248</span> //--------------------------------------------------------------------------------<a name="line.248"></a> -<span class="sourceLineNo">249</span> // API methods<a name="line.249"></a> -<span class="sourceLineNo">250</span> //--------------------------------------------------------------------------------<a name="line.250"></a> -<span class="sourceLineNo">251</span><a name="line.251"></a> -<span class="sourceLineNo">252</span> /**<a name="line.252"></a> -<span class="sourceLineNo">253</span> * Returns the specified value as a string from the config file.<a name="line.253"></a> -<span class="sourceLineNo">254</span> *<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.255"></a> -<span class="sourceLineNo">256</span> * @param def The default value if the section or value does not exist.<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @return The value, or the default value if the section or value doesn't exist.<a name="line.257"></a> -<span class="sourceLineNo">258</span> */<a name="line.258"></a> -<span class="sourceLineNo">259</span> public final String getString(String key, String def) {<a name="line.259"></a> -<span class="sourceLineNo">260</span> assertFieldNotNull(key, "key");<a name="line.260"></a> -<span class="sourceLineNo">261</span> String s = get(getSectionName(key), getSectionKey(key));<a name="line.261"></a> -<span class="sourceLineNo">262</span> return (StringUtils.isEmpty(s) && def != null ? def : s);<a name="line.262"></a> -<span class="sourceLineNo">263</span> }<a name="line.263"></a> +<span class="sourceLineNo">226</span> * @param o The object to serialize.<a name="line.226"></a> +<span class="sourceLineNo">227</span> * @param serializer<a name="line.227"></a> +<span class="sourceLineNo">228</span> * The serializer to use for serializing the object.<a name="line.228"></a> +<span class="sourceLineNo">229</span> * If <jk>null</jk>, then uses the predefined serializer on the config file.<a name="line.229"></a> +<span class="sourceLineNo">230</span> * @param newline If <jk>true</jk>, add a newline at the beginning of the value.<a name="line.230"></a> +<span class="sourceLineNo">231</span> * @return The serialized object.<a name="line.231"></a> +<span class="sourceLineNo">232</span> * @throws SerializeException<a name="line.232"></a> +<span class="sourceLineNo">233</span> */<a name="line.233"></a> +<span class="sourceLineNo">234</span> protected abstract String serialize(Object o, Serializer serializer, boolean newline) throws SerializeException;<a name="line.234"></a> +<span class="sourceLineNo">235</span><a name="line.235"></a> +<span class="sourceLineNo">236</span> /**<a name="line.236"></a> +<span class="sourceLineNo">237</span> * Converts the specified string to an object of the specified type.<a name="line.237"></a> +<span class="sourceLineNo">238</span> *<a name="line.238"></a> +<span class="sourceLineNo">239</span> * @param s The string to parse.<a name="line.239"></a> +<span class="sourceLineNo">240</span> * @param parser<a name="line.240"></a> +<span class="sourceLineNo">241</span> * The parser to use for parsing the object.<a name="line.241"></a> +<span class="sourceLineNo">242</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * @param type The data type to create.<a name="line.243"></a> +<span class="sourceLineNo">244</span> * @param args The generic type arguments if the type is a {@link Collection} or {@link Map}<a name="line.244"></a> +<span class="sourceLineNo">245</span> * @return The parsed object.<a name="line.245"></a> +<span class="sourceLineNo">246</span> * @throws ParseException<a name="line.246"></a> +<span class="sourceLineNo">247</span> */<a name="line.247"></a> +<span class="sourceLineNo">248</span> protected abstract <T> T parse(String s, Parser parser, Type type, Type...args) throws ParseException;<a name="line.248"></a> +<span class="sourceLineNo">249</span><a name="line.249"></a> +<span class="sourceLineNo">250</span> /**<a name="line.250"></a> +<span class="sourceLineNo">251</span> * Places a read lock on this config file.<a name="line.251"></a> +<span class="sourceLineNo">252</span> */<a name="line.252"></a> +<span class="sourceLineNo">253</span> protected abstract void readLock();<a name="line.253"></a> +<span class="sourceLineNo">254</span><a name="line.254"></a> +<span class="sourceLineNo">255</span> /**<a name="line.255"></a> +<span class="sourceLineNo">256</span> * Removes the read lock on this config file.<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> protected abstract void readUnlock();<a name="line.258"></a> +<span class="sourceLineNo">259</span><a name="line.259"></a> +<span class="sourceLineNo">260</span><a name="line.260"></a> +<span class="sourceLineNo">261</span> //--------------------------------------------------------------------------------<a name="line.261"></a> +<span class="sourceLineNo">262</span> // API methods<a name="line.262"></a> +<span class="sourceLineNo">263</span> //--------------------------------------------------------------------------------<a name="line.263"></a> <span class="sourceLineNo">264</span><a name="line.264"></a> <span class="sourceLineNo">265</span> /**<a name="line.265"></a> -<span class="sourceLineNo">266</span> * Removes an entry with the specified key.<a name="line.266"></a> +<span class="sourceLineNo">266</span> * Returns the specified value as a string from the config file.<a name="line.266"></a> <span class="sourceLineNo">267</span> *<a name="line.267"></a> <span class="sourceLineNo">268</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.268"></a> -<span class="sourceLineNo">269</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.269"></a> -<span class="sourceLineNo">270</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.270"></a> +<span class="sourceLineNo">269</span> * @param def The default value if the section or value does not exist.<a name="line.269"></a> +<span class="sourceLineNo">270</span> * @return The value, or the default value if the section or value doesn't exist.<a name="line.270"></a> <span class="sourceLineNo">271</span> */<a name="line.271"></a> -<span class="sourceLineNo">272</span> public final String removeString(String key) {<a name="line.272"></a> +<span class="sourceLineNo">272</span> public final String getString(String key, String def) {<a name="line.272"></a> <span class="sourceLineNo">273</span> assertFieldNotNull(key, "key");<a name="line.273"></a> -<span class="sourceLineNo">274</span> return remove(getSectionName(key), getSectionKey(key));<a name="line.274"></a> -<span class="sourceLineNo">275</span> }<a name="line.275"></a> -<span class="sourceLineNo">276</span><a name="line.276"></a> -<span class="sourceLineNo">277</span> /**<a name="line.277"></a> -<span class="sourceLineNo">278</span> * Gets the entry with the specified key and converts it to the specified value.<a name="line.278"></a> -<span class="sourceLineNo">279</span> *<a name="line.279"></a> -<span class="sourceLineNo">280</span> * <p><a name="line.280"></a> -<span class="sourceLineNo">281</span> * The key can be in one of the following formats...<a name="line.281"></a> -<span class="sourceLineNo">282</span> * <ul class='spaced-list'><a name="line.282"></a> -<span class="sourceLineNo">283</span> * <li><a name="line.283"></a> -<span class="sourceLineNo">284</span> * <js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header).<a name="line.284"></a> -<span class="sourceLineNo">285</span> * <li><a name="line.285"></a> -<span class="sourceLineNo">286</span> * <js>"section/key"</js> - A value from the specified section.<a name="line.286"></a> -<span class="sourceLineNo">287</span> * </ul><a name="line.287"></a> -<span class="sourceLineNo">288</span> *<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <p><a name="line.289"></a> -<span class="sourceLineNo">290</span> * The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).<a name="line.290"></a> -<span class="sourceLineNo">291</span> *<a name="line.291"></a> -<span class="sourceLineNo">292</span> * <h5 class='section'>Examples:</h5><a name="line.292"></a> -<span class="sourceLineNo">293</span> * <p class='bcode'><a name="line.293"></a> -<span class="sourceLineNo">294</span> * ConfigFile cf = <jk>new</jk> ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);<a name="line.294"></a> -<span class="sourceLineNo">295</span> *<a name="line.295"></a> -<span class="sourceLineNo">296</span> * <jc>// Parse into a linked-list of strings.</jc><a name="line.296"></a> -<span class="sourceLineNo">297</span> * List l = cf.getObject(<js>"MySection/myListOfStrings"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.297"></a> -<span class="sourceLineNo">298</span> *<a name="line.298"></a> -<span class="sourceLineNo">299</span> * <jc>// Parse into a linked-list of beans.</jc><a name="line.299"></a> -<span class="sourceLineNo">300</span> * List l = cf.getObject(<js>"MySection/myListOfBeans"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.300"></a> +<span class="sourceLineNo">274</span> String s = get(getSectionName(key), getSectionKey(key));<a name="line.274"></a> +<span class="sourceLineNo">275</span> return (StringUtils.isEmpty(s) && def != null ? def : s);<a name="line.275"></a> +<span class="sourceLineNo">276</span> }<a name="line.276"></a> +<span class="sourceLineNo">277</span><a name="line.277"></a> +<span class="sourceLineNo">278</span> /**<a name="line.278"></a> +<span class="sourceLineNo">279</span> * Removes an entry with the specified key.<a name="line.279"></a> +<span class="sourceLineNo">280</span> *<a name="line.280"></a> +<span class="sourceLineNo">281</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.281"></a> +<span class="sourceLineNo">282</span> * @return The previous value, or <jk>null</jk> if the section or key did not previously exist.<a name="line.282"></a> +<span class="sourceLineNo">283</span> * @throws UnsupportedOperationException If config file is read only.<a name="line.283"></a> +<span class="sourceLineNo">284</span> */<a name="line.284"></a> +<span class="sourceLineNo">285</span> public final String removeString(String key) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> assertFieldNotNull(key, "key");<a name="line.286"></a> +<span class="sourceLineNo">287</span> return remove(getSectionName(key), getSectionKey(key));<a name="line.287"></a> +<span class="sourceLineNo">288</span> }<a name="line.288"></a> +<span class="sourceLineNo">289</span><a name="line.289"></a> +<span class="sourceLineNo">290</span> /**<a name="line.290"></a> +<span class="sourceLineNo">291</span> * Gets the entry with the specified key and converts it to the specified value.<a name="line.291"></a> +<span class="sourceLineNo">292</span> *<a name="line.292"></a> +<span class="sourceLineNo">293</span> * <p><a name="line.293"></a> +<span class="sourceLineNo">294</span> * The key can be in one of the following formats...<a name="line.294"></a> +<span class="sourceLineNo">295</span> * <ul class='spaced-list'><a name="line.295"></a> +<span class="sourceLineNo">296</span> * <li><a name="line.296"></a> +<span class="sourceLineNo">297</span> * <js>"key"</js> - A value in the default section (i.e. defined above any <code>[section]</code> header).<a name="line.297"></a> +<span class="sourceLineNo">298</span> * <li><a name="line.298"></a> +<span class="sourceLineNo">299</span> * <js>"section/key"</js> - A value from the specified section.<a name="line.299"></a> +<span class="sourceLineNo">300</span> * </ul><a name="line.300"></a> <span class="sourceLineNo">301</span> *<a name="line.301"></a> -<span class="sourceLineNo">302</span> * <jc>// Parse into a linked-list of linked-lists of strings.</jc><a name="line.302"></a> -<span class="sourceLineNo">303</span> * List l = cf.getObject(<js>"MySection/my2dListOfStrings"</js>, LinkedList.<jk>class</jk>,<a name="line.303"></a> -<span class="sourceLineNo">304</span> * LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.304"></a> -<span class="sourceLineNo">305</span> *<a name="line.305"></a> -<span class="sourceLineNo">306</span> * <jc>// Parse into a map of string keys/values.</jc><a name="line.306"></a> -<span class="sourceLineNo">307</span> * Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,<a name="line.307"></a> -<span class="sourceLineNo">308</span> * String.<jk>class</jk>);<a name="line.308"></a> -<span class="sourceLineNo">309</span> *<a name="line.309"></a> -<span class="sourceLineNo">310</span> * <jc>// Parse into a map containing string keys and values of lists containing beans.</jc><a name="line.310"></a> -<span class="sourceLineNo">311</span> * Map m = cf.getObject(<js>"MySection/myMapOfListsOfBeans"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,<a name="line.311"></a> -<span class="sourceLineNo">312</span> * List.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.312"></a> -<span class="sourceLineNo">313</span> * </p><a name="line.313"></a> +<span class="sourceLineNo">302</span> * <p><a name="line.302"></a> +<span class="sourceLineNo">303</span> * The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).<a name="line.303"></a> +<span class="sourceLineNo">304</span> *<a name="line.304"></a> +<span class="sourceLineNo">305</span> * <h5 class='section'>Examples:</h5><a name="line.305"></a> +<span class="sourceLineNo">306</span> * <p class='bcode'><a name="line.306"></a> +<span class="sourceLineNo">307</span> * ConfigFile cf = <jk>new</jk> ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);<a name="line.307"></a> +<span class="sourceLineNo">308</span> *<a name="line.308"></a> +<span class="sourceLineNo">309</span> * <jc>// Parse into a linked-list of strings.</jc><a name="line.309"></a> +<span class="sourceLineNo">310</span> * List l = cf.getObject(<js>"MySection/myListOfStrings"</js>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.310"></a> +<span class="sourceLineNo">311</span> *<a name="line.311"></a> +<span class="sourceLineNo">312</span> * <jc>// Parse into a linked-list of beans.</jc><a name="line.312"></a> +<span class="sourceLineNo">313</span> * List l = cf.getObject(<js>"MySection/myListOfBeans"</js>, LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.313"></a> <span class="sourceLineNo">314</span> *<a name="line.314"></a> -<span class="sourceLineNo">315</span> * <p><a name="line.315"></a> -<span class="sourceLineNo">316</span> * <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.<a name="line.316"></a> -<span class="sourceLineNo">317</span> *<a name="line.317"></a> -<span class="sourceLineNo">318</span> * <p><a name="line.318"></a> -<span class="sourceLineNo">319</span> * <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value<a name="line.319"></a> -<span class="sourceLineNo">320</span> * types.<a name="line.320"></a> -<span class="sourceLineNo">321</span> *<a name="line.321"></a> -<span class="sourceLineNo">322</span> * <p><a name="line.322"></a> -<span class="sourceLineNo">323</span> * The array can be arbitrarily long to indicate arbitrarily complex data structures.<a name="line.323"></a> -<span class="sourceLineNo">324</span> *<a name="line.324"></a> -<span class="sourceLineNo">325</span> * <h5 class='section'>Notes:</h5><a name="line.325"></a> -<span class="sourceLineNo">326</span> * <ul><a name="line.326"></a> -<span class="sourceLineNo">327</span> * <li>Use the {@link #getObject(String, Class)} method instead if you don't need a parameterized map/collection.<a name="line.327"></a> -<span class="sourceLineNo">328</span> * </ul><a name="line.328"></a> -<span class="sourceLineNo">329</span> *<a name="line.329"></a> -<span class="sourceLineNo">330</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.330"></a> -<span class="sourceLineNo">331</span> * @param type<a name="line.331"></a> -<span class="sourceLineNo">332</span> * The object type to create.<a name="line.332"></a> -<span class="sourceLineNo">333</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.333"></a> -<span class="sourceLineNo">334</span> * {@link GenericArrayType}<a name="line.334"></a> -<span class="sourceLineNo">335</span> * @param args<a name="line.335"></a> -<span class="sourceLineNo">336</span> * The type arguments of the class if it's a collection or map.<a name="line.336"></a> -<span class="sourceLineNo">337</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.337"></a> -<span class="sourceLineNo">338</span> * {@link GenericArrayType}<a name="line.338"></a> -<span class="sourceLineNo">339</span> * <br>Ignored if the main type is not a map or collection.<a name="line.339"></a> -<span class="sourceLineNo">340</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.340"></a> -<span class="sourceLineNo">341</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.341"></a> -<span class="sourceLineNo">342</span> */<a name="line.342"></a> -<span class="sourceLineNo">343</span> public final <T> T getObject(String key, Type type, Type...args) throws ParseException {<a name="line.343"></a> -<span class="sourceLineNo">344</span> return getObject(key, (Parser)null, type, args);<a name="line.344"></a> -<span class="sourceLineNo">345</span> }<a name="line.345"></a> -<span class="sourceLineNo">346</span><a name="line.346"></a> -<span class="sourceLineNo">347</span> /**<a name="line.347"></a> -<span class="sourceLineNo">348</span> * Same as {@link #getObject(String, Type, Type...)} but allows you to specify the parser to use to parse the value.<a name="line.348"></a> -<span class="sourceLineNo">349</span> *<a name="line.349"></a> -<span class="sourceLineNo">350</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.350"></a> -<span class="sourceLineNo">351</span> * @param parser<a name="line.351"></a> -<span class="sourceLineNo">352</span> * The parser to use for parsing the object.<a name="line.352"></a> -<span class="sourceLineNo">353</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.353"></a> -<span class="sourceLineNo">354</span> * @param type<a name="line.354"></a> -<span class="sourceLineNo">355</span> * The object type to create.<a name="line.355"></a> -<span class="sourceLineNo">356</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.356"></a> -<span class="sourceLineNo">357</span> * {@link GenericArrayType}<a name="line.357"></a> -<span class="sourceLineNo">358</span> * @param args<a name="line.358"></a> -<span class="sourceLineNo">359</span> * The type arguments of the class if it's a collection or map.<a name="line.359"></a> -<span class="sourceLineNo">360</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.360"></a> -<span class="sourceLineNo">361</span> * {@link GenericArrayType}<a name="line.361"></a> -<span class="sourceLineNo">362</span> * <br>Ignored if the main type is not a map or collection.<a name="line.362"></a> -<span class="sourceLineNo">363</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.363"></a> -<span class="sourceLineNo">364</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.364"></a> -<span class="sourceLineNo">365</span> */<a name="line.365"></a> -<span class="sourceLineNo">366</span> public final <T> T getObject(String key, Parser parser, Type type, Type...args) throws ParseException {<a name="line.366"></a> -<span class="sourceLineNo">367</span> assertFieldNotNull(key, "key");<a name="line.367"></a> -<span class="sourceLineNo">368</span> assertFieldNotNull(type, "type");<a name="line.368"></a> -<span class="sourceLineNo">369</span> return parse(getString(key), parser, type, args);<a name="line.369"></a> -<span class="sourceLineNo">370</span> }<a name="line.370"></a> -<span class="sourceLineNo">371</span><a name="line.371"></a> -<span class="sourceLineNo">372</span> /**<a name="line.372"></a> -<span class="sourceLineNo">373</span> * Same as {@link #getObject(String, Type, Type...)} except optimized for a non-parameterized class.<a name="line.373"></a> -<span class="sourceLineNo">374</span> *<a name="line.374"></a> -<span class="sourceLineNo">375</span> * <p><a name="line.375"></a> -<span class="sourceLineNo">376</span> * This is the preferred parse method for simple types since you don't need to cast the results.<a name="line.376"></a> -<span class="sourceLineNo">377</span> *<a name="line.377"></a> -<span class="sourceLineNo">378</span> * <h5 class='section'>Examples:</h5><a name="line.378"></a> -<span class="sourceLineNo">379</span> * <p class='bcode'><a name="line.379"></a> -<span class="sourceLineNo">380</span> * ConfigFile cf = <jk>new</jk> ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);<a name="line.380"></a> -<span class="sourceLineNo">381</span> *<a name="line.381"></a> -<span class="sourceLineNo">382</span> * <jc>// Parse into a string.</jc><a name="line.382"></a> -<span class="sourceLineNo">383</span> * String s = cf.getObject(<js>"MySection/mySimpleString"</js>, String.<jk>class</jk>);<a name="line.383"></a> -<span class="sourceLineNo">384</span> *<a name="line.384"></a> -<span class="sourceLineNo">385</span> * <jc>// Parse into a bean.</jc><a name="line.385"></a> -<span class="sourceLineNo">386</span> * MyBean b = cf.getObject(<js>"MySection/myBean"</js>, MyBean.<jk>class</jk>);<a name="line.386"></a> +<span class="sourceLineNo">315</span> * <jc>// Parse into a linked-list of linked-lists of strings.</jc><a name="line.315"></a> +<span class="sourceLineNo">316</span> * List l = cf.getObject(<js>"MySection/my2dListOfStrings"</js>, LinkedList.<jk>class</jk>,<a name="line.316"></a> +<span class="sourceLineNo">317</span> * LinkedList.<jk>class</jk>, String.<jk>class</jk>);<a name="line.317"></a> +<span class="sourceLineNo">318</span> *<a name="line.318"></a> +<span class="sourceLineNo">319</span> * <jc>// Parse into a map of string keys/values.</jc><a name="line.319"></a> +<span class="sourceLineNo">320</span> * Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,<a name="line.320"></a> +<span class="sourceLineNo">321</span> * String.<jk>class</jk>);<a name="line.321"></a> +<span class="sourceLineNo">322</span> *<a name="line.322"></a> +<span class="sourceLineNo">323</span> * <jc>// Parse into a map containing string keys and values of lists containing beans.</jc><a name="line.323"></a> +<span class="sourceLineNo">324</span> * Map m = cf.getObject(<js>"MySection/myMapOfListsOfBeans"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,<a name="line.324"></a> +<span class="sourceLineNo">325</span> * List.<jk>class</jk>, MyBean.<jk>class</jk>);<a name="line.325"></a> +<span class="sourceLineNo">326</span> * </p><a name="line.326"></a> +<span class="sourceLineNo">327</span> *<a name="line.327"></a> +<span class="sourceLineNo">328</span> * <p><a name="line.328"></a> +<span class="sourceLineNo">329</span> * <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.<a name="line.329"></a> +<span class="sourceLineNo">330</span> *<a name="line.330"></a> +<span class="sourceLineNo">331</span> * <p><a name="line.331"></a> +<span class="sourceLineNo">332</span> * <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value<a name="line.332"></a> +<span class="sourceLineNo">333</span> * types.<a name="line.333"></a> +<span class="sourceLineNo">334</span> *<a name="line.334"></a> +<span class="sourceLineNo">335</span> * <p><a name="line.335"></a> +<span class="sourceLineNo">336</span> * The array can be arbitrarily long to indicate arbitrarily complex data structures.<a name="line.336"></a> +<span class="sourceLineNo">337</span> *<a name="line.337"></a> +<span class="sourceLineNo">338</span> * <h5 class='section'>Notes:</h5><a name="line.338"></a> +<span class="sourceLineNo">339</span> * <ul><a name="line.339"></a> +<span class="sourceLineNo">340</span> * <li>Use the {@link #getObject(String, Class)} method instead if you don't need a parameterized map/collection.<a name="line.340"></a> +<span class="sourceLineNo">341</span> * </ul><a name="line.341"></a> +<span class="sourceLineNo">342</span> *<a name="line.342"></a> +<span class="sourceLineNo">343</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @param type<a name="line.344"></a> +<span class="sourceLineNo">345</span> * The object type to create.<a name="line.345"></a> +<span class="sourceLineNo">346</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.346"></a> +<span class="sourceLineNo">347</span> * {@link GenericArrayType}<a name="line.347"></a> +<span class="sourceLineNo">348</span> * @param args<a name="line.348"></a> +<span class="sourceLineNo">349</span> * The type arguments of the class if it's a collection or map.<a name="line.349"></a> +<span class="sourceLineNo">350</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.350"></a> +<span class="sourceLineNo">351</span> * {@link GenericArrayType}<a name="line.351"></a> +<span class="sourceLineNo">352</span> * <br>Ignored if the main type is not a map or collection.<a name="line.352"></a> +<span class="sourceLineNo">353</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.353"></a> +<span class="sourceLineNo">354</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.354"></a> +<span class="sourceLineNo">355</span> */<a name="line.355"></a> +<span class="sourceLineNo">356</span> public final <T> T getObject(String key, Type type, Type...args) throws ParseException {<a name="line.356"></a> +<span class="sourceLineNo">357</span> return getObject(key, (Parser)null, type, args);<a name="line.357"></a> +<span class="sourceLineNo">358</span> }<a name="line.358"></a> +<span class="sourceLineNo">359</span><a name="line.359"></a> +<span class="sourceLineNo">360</span> /**<a name="line.360"></a> +<span class="sourceLineNo">361</span> * Same as {@link #getObject(String, Type, Type...)} but allows you to specify the parser to use to parse the value.<a name="line.361"></a> +<span class="sourceLineNo">362</span> *<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.363"></a> +<span class="sourceLineNo">364</span> * @param parser<a name="line.364"></a> +<span class="sourceLineNo">365</span> * The parser to use for parsing the object.<a name="line.365"></a> +<span class="sourceLineNo">366</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.366"></a> +<span class="sourceLineNo">367</span> * @param type<a name="line.367"></a> +<span class="sourceLineNo">368</span> * The object type to create.<a name="line.368"></a> +<span class="sourceLineNo">369</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.369"></a> +<span class="sourceLineNo">370</span> * {@link GenericArrayType}<a name="line.370"></a> +<span class="sourceLineNo">371</span> * @param args<a name="line.371"></a> +<span class="sourceLineNo">372</span> * The type arguments of the class if it's a collection or map.<a name="line.372"></a> +<span class="sourceLineNo">373</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.373"></a> +<span class="sourceLineNo">374</span> * {@link GenericArrayType}<a name="line.374"></a> +<span class="sourceLineNo">375</span> * <br>Ignored if the main type is not a map or collection.<a name="line.375"></a> +<span class="sourceLineNo">376</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.376"></a> +<span class="sourceLineNo">377</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.377"></a> +<span class="sourceLineNo">378</span> */<a name="line.378"></a> +<span class="sourceLineNo">379</span> public final <T> T getObject(String key, Parser parser, Type type, Type...args) throws ParseException {<a name="line.379"></a> +<span class="sourceLineNo">380</span> assertFieldNotNull(key, "key");<a name="line.380"></a> +<span class="sourceLineNo">381</span> assertFieldNotNull(type, "type");<a name="line.381"></a> +<span class="sourceLineNo">382</span> return parse(getString(key), parser, type, args);<a name="line.382"></a> +<span class="sourceLineNo">383</span> }<a name="line.383"></a> +<span class="sourceLineNo">384</span><a name="line.384"></a> +<span class="sourceLineNo">385</span> /**<a name="line.385"></a> +<span class="sourceLineNo">386</span> * Same as {@link #getObject(String, Type, Type...)} except optimized for a non-parameterized class.<a name="line.386"></a> <span class="sourceLineNo">387</span> *<a name="line.387"></a> -<span class="sourceLineNo">388</span> * <jc>// Parse into a bean array.</jc><a name="line.388"></a> -<span class="sourceLineNo">389</span> * MyBean[] b = cf.getObject(<js>"MySection/myBeanArray"</js>, MyBean[].<jk>class</jk>);<a name="line.389"></a> +<span class="sourceLineNo">388</span> * <p><a name="line.388"></a> +<span class="sourceLineNo">389</span> * This is the preferred parse method for simple types since you don't need to cast the results.<a name="line.389"></a> <span class="sourceLineNo">390</span> *<a name="line.390"></a> -<span class="sourceLineNo">391</span> * <jc>// Parse into a linked-list of objects.</jc><a name="line.391"></a> -<span class="sourceLineNo">392</span> * List l = cf.getObject(<js>"MySection/myList"</js>, LinkedList.<jk>class</jk>);<a name="line.392"></a> -<span class="sourceLineNo">393</span> *<a name="line.393"></a> -<span class="sourceLineNo">394</span> * <jc>// Parse into a map of object keys/values.</jc><a name="line.394"></a> -<span class="sourceLineNo">395</span> * Map m = cf.getObject(<js>"MySection/myMap"</js>, TreeMap.<jk>class</jk>);<a name="line.395"></a> -<span class="sourceLineNo">396</span> * </p><a name="line.396"></a> +<span class="sourceLineNo">391</span> * <h5 class='section'>Examples:</h5><a name="line.391"></a> +<span class="sourceLineNo">392</span> * <p class='bcode'><a name="line.392"></a> +<span class="sourceLineNo">393</span> * ConfigFile cf = <jk>new</jk> ConfigFileBuilder().build(<js>"MyConfig.cfg"</js>);<a name="line.393"></a> +<span class="sourceLineNo">394</span> *<a name="line.394"></a> +<span class="sourceLineNo">395</span> * <jc>// Parse into a string.</jc><a name="line.395"></a> +<span class="sourceLineNo">396</span> * String s = cf.getObject(<js>"MySection/mySimpleString"</js>, String.<jk>class</jk>);<a name="line.396"></a> <span class="sourceLineNo">397</span> *<a name="line.397"></a> -<span class="sourceLineNo">398</span> * @param <T> The class type of the object being created.<a name="line.398"></a> -<span class="sourceLineNo">399</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.399"></a> -<span class="sourceLineNo">400</span> * @param type The object type to create.<a name="line.400"></a> -<span class="sourceLineNo">401</span> * @return The parsed object.<a name="line.401"></a> -<span class="sourceLineNo">402</span> * @throws ParseException<a name="line.402"></a> -<span class="sourceLineNo">403</span> * If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.403"></a> -<span class="sourceLineNo">404</span> * @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.<a name="line.404"></a> -<span class="sourceLineNo">405</span> */<a name="line.405"></a> -<span class="sourceLineNo">406</span> public final <T> T getObject(String key, Class<T> type) throws ParseException {<a name="line.406"></a> -<span class="sourceLineNo">407</span> return getObject(key, (Parser)null, type);<a name="line.407"></a> -<span class="sourceLineNo">408</span> }<a name="line.408"></a> -<span class="sourceLineNo">409</span><a name="line.409"></a> -<span class="sourceLineNo">410</span> /**<a name="line.410"></a> -<span class="sourceLineNo">411</span> * Same as {@link #getObject(String, Class)} but allows you to specify the parser to use to parse the value.<a name="line.411"></a> -<span class="sourceLineNo">412</span> *<a name="line.412"></a> -<span class="sourceLineNo">413</span> * @param <T> The class type of the object being created.<a name="line.413"></a> -<span class="sourceLineNo">414</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.414"></a> -<span class="sourceLineNo">415</span> * @param parser<a name="line.415"></a> -<span class="sourceLineNo">416</span> * The parser to use for parsing the object.<a name="line.416"></a> -<span class="sourceLineNo">417</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.417"></a> -<span class="sourceLineNo">418</span> * @param type The object type to create.<a name="line.418"></a> -<span class="sourceLineNo">419</span> * @return The parsed object.<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @throws ParseException<a name="line.420"></a> -<span class="sourceLineNo">421</span> * If the input contains a syntax error or is malformed, or is not valid for the specified type.<a name="line.421"></a> -<span class="sourceLineNo">422</span> * @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.<a name="line.422"></a> -<span class="sourceLineNo">423</span> */<a name="line.423"></a> -<span class="sourceLineNo">424</span> public final <T> T getObject(String key, Parser parser, Class<T> type) throws ParseException {<a name="line.424"></a> -<span class="sourceLineNo">425</span> assertFieldNotNull(key, "key");<a name="line.425"></a> -<span class="sourceLineNo">426</span> assertFieldNotNull(type, "c");<a name="line.426"></a> -<span class="sourceLineNo">427</span> return parse(getString(key), parser, type);<a name="line.427"></a> -<span class="sourceLineNo">428</span> }<a name="line.428"></a> -<span class="sourceLineNo">429</span><a name="line.429"></a> -<span class="sourceLineNo">430</span> /**<a name="line.430"></a> -<span class="sourceLineNo">431</span> * Gets the entry with the specified key and converts it to the specified value.<a name="line.431"></a> -<span class="sourceLineNo">432</span> *<a name="line.432"></a> -<span class="sourceLineNo">433</span> * <p><a name="line.433"></a> -<span class="sourceLineNo">434</span> * Same as {@link #getObject(String, Class)}, but with a default value.<a name="line.434"></a> -<span class="sourceLineNo">435</span> *<a name="line.435"></a> -<span class="sourceLineNo">436</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.436"></a> -<span class="sourceLineNo">437</span> * @param def The default value if section or key does not exist.<a name="line.437"></a> -<span class="sourceLineNo">438</span> * @param type The class to convert the value to.<a name="line.438"></a> -<span class="sourceLineNo">439</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.439"></a> -<span class="sourceLineNo">440</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.440"></a> -<span class="sourceLineNo">441</span> */<a name="line.441"></a> -<span class="sourceLineNo">442</span> public final <T> T getObjectWithDefault(String key, T def, Class<T> type) throws ParseException {<a name="line.442"></a> -<span class="sourceLineNo">443</span> return getObjectWithDefault(key, null, def, type);<a name="line.443"></a> -<span class="sourceLineNo">444</span> }<a name="line.444"></a> -<span class="sourceLineNo">445</span><a name="line.445"></a> -<span class="sourceLineNo">446</span> /**<a name="line.446"></a> -<span class="sourceLineNo">447</span> * Same as {@link #getObjectWithDefault(String, Object, Class)} but allows you to specify the parser to use to parse<a name="line.447"></a> -<span class="sourceLineNo">448</span> * the value.<a name="line.448"></a> -<span class="sourceLineNo">449</span> *<a name="line.449"></a> -<span class="sourceLineNo">450</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.450"></a> -<span class="sourceLineNo">451</span> * @param parser<a name="line.451"></a> -<span class="sourceLineNo">452</span> * The parser to use for parsing the object.<a name="line.452"></a> -<span class="sourceLineNo">453</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.453"></a> -<span class="sourceLineNo">454</span> * @param def The default value if section or key does not exist.<a name="line.454"></a> -<span class="sourceLineNo">455</span> * @param type The class to convert the value to.<a name="line.455"></a> -<span class="sourceLineNo">456</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.456"></a> -<span class="sourceLineNo">457</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.457"></a> -<span class="sourceLineNo">458</span> */<a name="line.458"></a> -<span class="sourceLineNo">459</span> public final <T> T getObjectWithDefault(String key, Parser parser, T def, Class<T> type) throws ParseException {<a name="line.459"></a> -<span class="sourceLineNo">460</span> assertFieldNotNull(key, "key");<a name="line.460"></a> -<span class="sourceLineNo">461</span> assertFieldNotNull(type, "c");<a name="line.461"></a> -<span class="sourceLineNo">462</span> T t = parse(getString(key), parser, type);<a name="line.462"></a> -<span class="sourceLineNo">463</span> return (t == null ? def : t);<a name="line.463"></a> -<span class="sourceLineNo">464</span> }<a name="line.464"></a> -<span class="sourceLineNo">465</span><a name="line.465"></a> -<span class="sourceLineNo">466</span> /**<a name="line.466"></a> -<span class="sourceLineNo">467</span> * Gets the entry with the specified key and converts it to the specified value.<a name="line.467"></a> -<span class="sourceLineNo">468</span> *<a name="line.468"></a> -<span class="sourceLineNo">469</span> * <p><a name="line.469"></a> -<span class="sourceLineNo">470</span> * Same as {@link #getObject(String, Type, Type...)}, but with a default value.<a name="line.470"></a> -<span class="sourceLineNo">471</span> *<a name="line.471"></a> -<span class="sourceLineNo">472</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param def The default value if section or key does not exist.<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @param type<a name="line.474"></a> -<span class="sourceLineNo">475</span> * The object type to create.<a name="line.475"></a> -<span class="sourceLineNo">476</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.476"></a> -<span class="sourceLineNo">477</span> * {@link GenericArrayType}<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @param args<a name="line.478"></a> -<span class="sourceLineNo">479</span> * The type arguments of the class if it's a collection or map.<a name="line.479"></a> -<span class="sourceLineNo">480</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.480"></a> -<span class="sourceLineNo">481</span> * {@link GenericArrayType}<a name="line.481"></a> -<span class="sourceLineNo">482</span> * <br>Ignored if the main type is not a map or collection.<a name="line.482"></a> -<span class="sourceLineNo">483</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.483"></a> -<span class="sourceLineNo">484</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.484"></a> -<span class="sourceLineNo">485</span> */<a name="line.485"></a> -<span class="sourceLineNo">486</span> public final <T> T getObjectWithDefault(String key, T def, Type type, Type...args) throws ParseException {<a name="line.486"></a> -<span class="sourceLineNo">487</span> return getObjectWithDefault(key, null, def, type, args);<a name="line.487"></a> -<span class="sourceLineNo">488</span> }<a name="line.488"></a> -<span class="sourceLineNo">489</span><a name="line.489"></a> -<span class="sourceLineNo">490</span> /**<a name="line.490"></a> -<span class="sourceLineNo">491</span> * Same as {@link #getObjectWithDefault(String, Object, Type, Type...)} but allows you to specify the parser to use<a name="line.491"></a> -<span class="sourceLineNo">492</span> * to parse the value.<a name="line.492"></a> -<span class="sourceLineNo">493</span> *<a name="line.493"></a> -<span class="sourceLineNo">494</span> * @param key The key. See {@link #getString(String)} for a description of the key.<a name="line.494"></a> -<span class="sourceLineNo">495</span> * @param parser<a name="line.495"></a> -<span class="sourceLineNo">496</span> * The parser to use for parsing the object.<a name="line.496"></a> -<span class="sourceLineNo">497</span> * If <jk>null</jk>, then uses the predefined parser on the config file.<a name="line.497"></a> -<span class="sourceLineNo">498</span> * @param def The default value if section or key does not exist.<a name="line.498"></a> -<span class="sourceLineNo">499</span> * @param type<a name="line.499"></a> -<span class="sourceLineNo">500</span> * The object type to create.<a name="line.500"></a> -<span class="sourceLineNo">501</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.501"></a> -<span class="sourceLineNo">502</span> * {@link GenericArrayType}<a name="line.502"></a> -<span class="sourceLineNo">503</span> * @param args<a name="line.503"></a> -<span class="sourceLineNo">504</span> * The type arguments of the class if it's a collection or map.<a name="line.504"></a> -<span class="sourceLineNo">505</span> * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},<a name="line.505"></a> -<span class="sourceLineNo">506</span> * {@link GenericArrayType}<a name="line.506"></a> -<span class="sourceLineNo">507</span> * <br>Ignored if the main type is not a map or collection.<a name="line.507"></a> -<span class="sourceLineNo">508</span> * @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.<a name="line.508"></a> -<span class="sourceLineNo">509</span> * @return The value, or <jk>null</jk> if the section or key does not exist.<a name="line.509"></a> -<span class="sourceLineNo">510</span> */<a name="line.510"></a> -<span class="sourceLineNo">511</span> public final <T> T getObjectWithDefault(String key, Parser parser, T def, Type type, Type...args) throws ParseException {<a name="line.511"></a> -<span class="sourceLineNo">512</span> assertFieldNotNull(key, "key");<a name="line.512"></a> -<span class="sourceLineNo">513</span> assertField
<TRUNCATED>
