| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.config.store;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static org.apache.juneau.internal.CollectionUtils.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span><a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import java.io.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.lang.reflect.*;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.concurrent.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.juneau.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.juneau.config.internal.*;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.juneau.internal.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.utils.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Represents a storage location for configuration files.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Content stores require two methods to be implemented:<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <ul class='javatree'><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <li class='jm'>{@link #read(String)} - Retrieve a config file.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <li class='jm'>{@link #write(String,String,String)} - ConfigStore a config file.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * </ul><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <ul class='notes'><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <li class='note'>This class is thread safe and reusable.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </ul><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <ul class='seealso'><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <li class='extlink'>{@source}<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * </ul><a name="line.44"></a> |
| <span class="sourceLineNo">045</span>*/<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public abstract class ConfigStore extends Context implements Closeable {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> // Builder<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> //-------------------------------------------------------------------------------------------------------------------<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> * Builder class.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> @FluentSetters<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public abstract static class Builder extends Context.Builder {<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> * Constructor, default settings.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> protected Builder() {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> super();<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> }<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Copy constructor.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> *<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @param copyFrom The bean to copy from.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> protected Builder(ConfigStore copyFrom) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> super(copyFrom);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * Copy constructor.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param copyFrom The builder to copy from.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> protected Builder(Builder copyFrom) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> super(copyFrom);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @Override /* Context.Builder */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public abstract Builder copy();<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> // Properties<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> // <FluentSetters><a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public Builder annotations(Annotation...values) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> super.annotations(values);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return this;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public Builder apply(AnnotationWorkList work) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> super.apply(work);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return this;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public Builder applyAnnotations(java.lang.Class<?>...fromClasses) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> super.applyAnnotations(fromClasses);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> public Builder applyAnnotations(Method...fromMethods) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> super.applyAnnotations(fromMethods);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return this;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public Builder cache(Cache<HashKey,? extends org.apache.juneau.Context> value) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> super.cache(value);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return this;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public Builder debug() {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> super.debug();<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public Builder debug(boolean value) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> super.debug(value);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public Builder impl(Context value) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> super.impl(value);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return this;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public Builder type(Class<? extends org.apache.juneau.Context> value) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> super.type(value);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> return this;<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> // </FluentSetters><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // Instance<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> private final ConcurrentHashMap<String,Set<ConfigStoreListener>> listeners = new ConcurrentHashMap<>();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> private final ConcurrentHashMap<String,ConfigMap> configMaps = new ConcurrentHashMap<>();<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Constructor.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> *<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @param builder The builder for this object.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> */<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> protected ConfigStore(Builder builder) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> super(builder);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> /**<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * Returns the contents of the configuration file.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> *<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @param name The config file name.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * The contents of the configuration file.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * <br>A blank string if the config does not exist.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * <br>Never <jk>null</jk>.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @throws IOException Thrown by underlying stream.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> public abstract String read(String name) throws IOException;<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> /**<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * Saves the contents of the configuration file if the underlying storage hasn't been modified.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> *<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param name The config file name.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param expectedContents The expected contents of the file.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param newContents The new contents.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @return<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * If <jk>null</jk>, then we successfully stored the contents of the file.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * <br>Otherwise the contents of the file have changed and we return the new contents of the file.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @throws IOException Thrown by underlying stream.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> */<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> public abstract String write(String name, String expectedContents, String newContents) throws IOException;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> /**<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * Checks whether the configuration with the specified name exists in this store.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> *<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @param name The config name.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @return <jk>true</jk> if the configuration with the specified name exists in this store.<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> */<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> public abstract boolean exists(String name);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> /**<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * Registers a new listener on this store.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> *<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @param name The configuration name to listen for.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param l The new listener.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @return This object.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> */<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> public synchronized ConfigStore register(String name, ConfigStoreListener l) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> name = resolveName(name);<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> Set<ConfigStoreListener> s = listeners.get(name);<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> if (s == null) {<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> s = synced(Collections.newSetFromMap(new IdentityHashMap<ConfigStoreListener,Boolean>()));<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> listeners.put(name, s);<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> s.add(l);<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return this;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<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> * Unregisters a listener from this store.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> *<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * @param name The configuration name to listen for.<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * @param l The listener to unregister.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @return This object.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> */<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> public synchronized ConfigStore unregister(String name, ConfigStoreListener l) {<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> name = resolveName(name);<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> Set<ConfigStoreListener> s = listeners.get(name);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> if (s != null)<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> s.remove(l);<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> return this;<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> }<a name="line.229"></a> |
| <span class="sourceLineNo">230</span><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> /**<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * Returns a map file containing the parsed contents of a configuration.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> *<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @param name The configuration name.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @return<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * The parsed configuration.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <br>Never <jk>null</jk>.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @throws IOException Thrown by underlying stream.<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> public synchronized ConfigMap getMap(String name) throws IOException {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> name = resolveName(name);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> ConfigMap cm = configMaps.get(name);<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> if (cm != null)<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> return cm;<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> cm = new ConfigMap(this, name);<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> ConfigMap cm2 = configMaps.putIfAbsent(name, cm);<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> if (cm2 != null)<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> return cm2;<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> register(name, cm);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> return cm;<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> /**<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * Called when the physical contents of a config file have changed.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> *<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <p><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Triggers calls to {@link ConfigStoreListener#onChange(String)} on all registered listeners.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> *<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * @param name The config name (e.g. the filename without the extension).<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * @param contents The new contents.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * @return This object.<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> */<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> public synchronized ConfigStore update(String name, String contents) {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> name = resolveName(name);<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> Set<ConfigStoreListener> s = listeners.get(name);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> if (s != null)<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> listeners.get(name).forEach(x -> x.onChange(contents));<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> return this;<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> }<a name="line.269"></a> |
| <span class="sourceLineNo">270</span><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> /**<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * Convenience method for updating the contents of a file with lines.<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> *<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * @param name The config name (e.g. the filename without the extension).<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @param contentLines The new contents.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * @return This object.<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> */<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> public synchronized ConfigStore update(String name, String...contentLines) {<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> name = resolveName(name);<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> StringBuilder sb = new StringBuilder();<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> for (String l : contentLines)<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> sb.append(l).append('\n');<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> return update(name, sb.toString());<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> }<a name="line.284"></a> |
| <span class="sourceLineNo">285</span><a name="line.285"></a> |
| <span class="sourceLineNo">286</span> /**<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * Subclasses can override this method to convert config names to internal forms.<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> * For example, the {@link FileStore} class can take in both <js>"MyConfig"</js> and <js>"MyConfig.cfg"</js><a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * as names that both resolve to <js>"MyConfig.cfg"</js>.<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> *<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * @param name The name to resolve.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @return The resolved name.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> */<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> protected String resolveName(String name) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> return name;<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> }<a name="line.298"></a> |
| <span class="sourceLineNo">299</span>}<a name="line.299"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
