juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [01/51] [partial] juneau-website git commit: Update javadocs.
Date Thu, 26 Oct 2017 14:02:07 GMT
Repository: juneau-website
Updated Branches:
  refs/heads/asf-site 075b9d3a3 -> 80fbe4a07


http://git-wip-us.apache.org/repos/asf/juneau-website/blob/80fbe4a0/content/site/apidocs/src-html/org/apache/juneau/Session.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/Session.html b/content/site/apidocs/src-html/org/apache/juneau/Session.html
index 7097426..e6eddc0 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/Session.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/Session.html
@@ -22,247 +22,248 @@
 <span class="sourceLineNo">014</span><a name="line.14"></a>
 <span class="sourceLineNo">015</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.15"></a>
 <span class="sourceLineNo">016</span><a name="line.16"></a>
-<span class="sourceLineNo">017</span>import java.text.*;<a name="line.17"></a>
-<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a>
-<span class="sourceLineNo">019</span><a name="line.19"></a>
-<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import org.apache.juneau.internal.*;<a name="line.21"></a>
-<span class="sourceLineNo">022</span>import org.apache.juneau.json.*;<a name="line.22"></a>
-<span class="sourceLineNo">023</span>import org.apache.juneau.serializer.*;<a name="line.23"></a>
-<span class="sourceLineNo">024</span><a name="line.24"></a>
-<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
-<span class="sourceLineNo">026</span> * A one-time-use non-thread-safe object that's meant to be used once and then thrown away.<a name="line.26"></a>
-<span class="sourceLineNo">027</span> *<a name="line.27"></a>
-<span class="sourceLineNo">028</span> * &lt;p&gt;<a name="line.28"></a>
-<span class="sourceLineNo">029</span> * Serializers and parsers use session objects to retrieve config properties and to use it as a scratchpad during<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * serialize and parse actions.<a name="line.30"></a>
-<span class="sourceLineNo">031</span> *<a name="line.31"></a>
-<span class="sourceLineNo">032</span> * @see PropertyStore<a name="line.32"></a>
-<span class="sourceLineNo">033</span> */<a name="line.33"></a>
-<span class="sourceLineNo">034</span>public abstract class Session {<a name="line.34"></a>
-<span class="sourceLineNo">035</span><a name="line.35"></a>
-<span class="sourceLineNo">036</span>   private JuneauLogger logger;<a name="line.36"></a>
-<span class="sourceLineNo">037</span><a name="line.37"></a>
-<span class="sourceLineNo">038</span>   private final ObjectMap properties;<a name="line.38"></a>
-<span class="sourceLineNo">039</span>   private final Context ctx;<a name="line.39"></a>
-<span class="sourceLineNo">040</span>   private Map&lt;String,Object&gt; cache;<a name="line.40"></a>
-<span class="sourceLineNo">041</span>   private boolean closed;<a name="line.41"></a>
-<span class="sourceLineNo">042</span>   private List&lt;String&gt; warnings;                 // Any warnings encountered.<a name="line.42"></a>
-<span class="sourceLineNo">043</span><a name="line.43"></a>
+<span class="sourceLineNo">017</span>import java.io.Closeable;<a name="line.17"></a>
+<span class="sourceLineNo">018</span>import java.text.*;<a name="line.18"></a>
+<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a>
+<span class="sourceLineNo">020</span><a name="line.20"></a>
+<span class="sourceLineNo">021</span>import org.apache.juneau.annotation.*;<a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.juneau.internal.*;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.juneau.json.*;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.juneau.serializer.*;<a name="line.24"></a>
+<span class="sourceLineNo">025</span><a name="line.25"></a>
+<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * A one-time-use non-thread-safe object that's meant to be used once and then thrown away.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> *<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * Serializers and parsers use session objects to retrieve config properties and to use it as a scratchpad during<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * serialize and parse actions.<a name="line.31"></a>
+<span class="sourceLineNo">032</span> *<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * @see PropertyStore<a name="line.33"></a>
+<span class="sourceLineNo">034</span> */<a name="line.34"></a>
+<span class="sourceLineNo">035</span>public abstract class Session implements Closeable {<a name="line.35"></a>
+<span class="sourceLineNo">036</span><a name="line.36"></a>
+<span class="sourceLineNo">037</span>   private JuneauLogger logger;<a name="line.37"></a>
+<span class="sourceLineNo">038</span><a name="line.38"></a>
+<span class="sourceLineNo">039</span>   private final ObjectMap properties;<a name="line.39"></a>
+<span class="sourceLineNo">040</span>   private final Context ctx;<a name="line.40"></a>
+<span class="sourceLineNo">041</span>   private Map&lt;String,Object&gt; cache;<a name="line.41"></a>
+<span class="sourceLineNo">042</span>   private boolean closed;<a name="line.42"></a>
+<span class="sourceLineNo">043</span>   private List&lt;String&gt; warnings;                 // Any warnings encountered.<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>    * Default constructor.<a name="line.46"></a>
-<span class="sourceLineNo">047</span>    *<a name="line.47"></a>
-<span class="sourceLineNo">048</span>    * @param ctx<a name="line.48"></a>
-<span class="sourceLineNo">049</span>    *    The context creating this session object.<a name="line.49"></a>
-<span class="sourceLineNo">050</span>    *    The context contains all the configuration settings for the session.<a name="line.50"></a>
-<span class="sourceLineNo">051</span>    * @param args<a name="line.51"></a>
-<span class="sourceLineNo">052</span>    *    Runtime arguments.<a name="line.52"></a>
-<span class="sourceLineNo">053</span>    */<a name="line.53"></a>
-<span class="sourceLineNo">054</span>   protected Session(final Context ctx, SessionArgs args) {<a name="line.54"></a>
-<span class="sourceLineNo">055</span>      this.ctx = ctx;<a name="line.55"></a>
-<span class="sourceLineNo">056</span>      this.properties = args.properties != null ? args.properties : ObjectMap.EMPTY_MAP;<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>   /**<a name="line.59"></a>
-<span class="sourceLineNo">060</span>    * Returns the session-level properties.<a name="line.60"></a>
-<span class="sourceLineNo">061</span>    *<a name="line.61"></a>
-<span class="sourceLineNo">062</span>    * @return The session-level properties.<a name="line.62"></a>
-<span class="sourceLineNo">063</span>    */<a name="line.63"></a>
-<span class="sourceLineNo">064</span>   protected final ObjectMap getProperties() {<a name="line.64"></a>
-<span class="sourceLineNo">065</span>      return properties;<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>   /**<a name="line.68"></a>
-<span class="sourceLineNo">069</span>    * Returns the session property with the specified key.<a name="line.69"></a>
-<span class="sourceLineNo">070</span>    *<a name="line.70"></a>
-<span class="sourceLineNo">071</span>    * &lt;p&gt;<a name="line.71"></a>
-<span class="sourceLineNo">072</span>    * The order of lookup for the property is as follows:<a name="line.72"></a>
-<span class="sourceLineNo">073</span>    * &lt;ul&gt;<a name="line.73"></a>
-<span class="sourceLineNo">074</span>    *    &lt;li&gt;Override property passed in through the constructor.<a name="line.74"></a>
-<span class="sourceLineNo">075</span>    *    &lt;li&gt;Property defined on the context object.<a name="line.75"></a>
-<span class="sourceLineNo">076</span>    *    &lt;li&gt;System.property.<a name="line.76"></a>
-<span class="sourceLineNo">077</span>    * &lt;/ul&gt;<a name="line.77"></a>
-<span class="sourceLineNo">078</span>    *<a name="line.78"></a>
-<span class="sourceLineNo">079</span>    * @param key The property key.<a name="line.79"></a>
-<span class="sourceLineNo">080</span>    * @return The property value, or &lt;jk&gt;null&lt;/jk&gt; if it doesn't exist.<a name="line.80"></a>
-<span class="sourceLineNo">081</span>    */<a name="line.81"></a>
-<span class="sourceLineNo">082</span>   public final String getStringProperty(String key) {<a name="line.82"></a>
-<span class="sourceLineNo">083</span>      return getStringProperty(key, null);<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>    * Same as {@link #getStringProperty(String)} but with a default value.<a name="line.87"></a>
-<span class="sourceLineNo">088</span>    *<a name="line.88"></a>
-<span class="sourceLineNo">089</span>    * @param key The property key.<a name="line.89"></a>
-<span class="sourceLineNo">090</span>    * @param def The default value if the property doesn't exist or is &lt;jk&gt;null&lt;/jk&gt;.<a name="line.90"></a>
-<span class="sourceLineNo">091</span>    * @return The property value.<a name="line.91"></a>
-<span class="sourceLineNo">092</span>    */<a name="line.92"></a>
-<span class="sourceLineNo">093</span>   public final String getStringProperty(String key, String def) {<a name="line.93"></a>
-<span class="sourceLineNo">094</span>      Object v = properties.get(key);<a name="line.94"></a>
-<span class="sourceLineNo">095</span>      if (v == null)<a name="line.95"></a>
-<span class="sourceLineNo">096</span>         v = ctx.getPropertyStore().getProperty(key, String.class, null);<a name="line.96"></a>
-<span class="sourceLineNo">097</span>      if (v == null)<a name="line.97"></a>
-<span class="sourceLineNo">098</span>         v = def;<a name="line.98"></a>
-<span class="sourceLineNo">099</span>      return StringUtils.toString(v);<a name="line.99"></a>
-<span class="sourceLineNo">100</span>   }<a name="line.100"></a>
-<span class="sourceLineNo">101</span><a name="line.101"></a>
-<span class="sourceLineNo">102</span>   /**<a name="line.102"></a>
-<span class="sourceLineNo">103</span>    * Same as {@link #getStringProperty(String)} but transforms the value to the specified type.<a name="line.103"></a>
-<span class="sourceLineNo">104</span>    *<a name="line.104"></a>
-<span class="sourceLineNo">105</span>    * @param key The property key.<a name="line.105"></a>
-<span class="sourceLineNo">106</span>    * @param type The class type of the value.<a name="line.106"></a>
-<span class="sourceLineNo">107</span>    *<a name="line.107"></a>
-<span class="sourceLineNo">108</span>    * @return The property value.<a name="line.108"></a>
-<span class="sourceLineNo">109</span>    */<a name="line.109"></a>
-<span class="sourceLineNo">110</span>   public final &lt;T&gt; T getProperty(String key, Class&lt;T&gt; type) {<a name="line.110"></a>
-<span class="sourceLineNo">111</span>      return getPropertyWithDefault(key, null, type);<a name="line.111"></a>
-<span class="sourceLineNo">112</span>   }<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>    * Same as {@link #getProperty(String,Class)} but with a default value.<a name="line.115"></a>
-<span class="sourceLineNo">116</span>    *<a name="line.116"></a>
-<span class="sourceLineNo">117</span>    * @param key The property key.<a name="line.117"></a>
-<span class="sourceLineNo">118</span>    * @param def The default value if the property doesn't exist or is &lt;jk&gt;null&lt;/jk&gt;.<a name="line.118"></a>
-<span class="sourceLineNo">119</span>    * @param type The class type of the value.<a name="line.119"></a>
-<span class="sourceLineNo">120</span>    *<a name="line.120"></a>
-<span class="sourceLineNo">121</span>    * @return The property value.<a name="line.121"></a>
-<span class="sourceLineNo">122</span>    */<a name="line.122"></a>
-<span class="sourceLineNo">123</span>   public final &lt;T&gt; T getPropertyWithDefault(String key, T def, Class&lt;T&gt; type) {<a name="line.123"></a>
-<span class="sourceLineNo">124</span>      T t = properties.get(key, type);<a name="line.124"></a>
-<span class="sourceLineNo">125</span>      if (t == null)<a name="line.125"></a>
-<span class="sourceLineNo">126</span>         t = ctx.getPropertyStore().getProperty(key, type, def);<a name="line.126"></a>
-<span class="sourceLineNo">127</span>      return t;<a name="line.127"></a>
-<span class="sourceLineNo">128</span>   }<a name="line.128"></a>
-<span class="sourceLineNo">129</span><a name="line.129"></a>
-<span class="sourceLineNo">130</span>   /**<a name="line.130"></a>
-<span class="sourceLineNo">131</span>    * Adds an arbitrary object to this session's cache.<a name="line.131"></a>
-<span class="sourceLineNo">132</span>    *<a name="line.132"></a>
-<span class="sourceLineNo">133</span>    * &lt;p&gt;<a name="line.133"></a>
-<span class="sourceLineNo">134</span>    * Can be used to store objects for reuse during a session.<a name="line.134"></a>
-<span class="sourceLineNo">135</span>    *<a name="line.135"></a>
-<span class="sourceLineNo">136</span>    * @param key The key.  Can be any string.<a name="line.136"></a>
-<span class="sourceLineNo">137</span>    * @param val The cached object.<a name="line.137"></a>
-<span class="sourceLineNo">138</span>    */<a name="line.138"></a>
-<span class="sourceLineNo">139</span>   public final void addToCache(String key, Object val) {<a name="line.139"></a>
-<span class="sourceLineNo">140</span>      if (cache == null)<a name="line.140"></a>
-<span class="sourceLineNo">141</span>         cache = new TreeMap&lt;String,Object&gt;();<a name="line.141"></a>
-<span class="sourceLineNo">142</span>      cache.put(key, val);<a name="line.142"></a>
-<span class="sourceLineNo">143</span>   }<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>    * Adds arbitrary objects to this session's cache.<a name="line.146"></a>
-<span class="sourceLineNo">147</span>    *<a name="line.147"></a>
-<span class="sourceLineNo">148</span>    * &lt;p&gt;<a name="line.148"></a>
-<span class="sourceLineNo">149</span>    * Can be used to store objects for reuse during a session.<a name="line.149"></a>
-<span class="sourceLineNo">150</span>    *<a name="line.150"></a>
-<span class="sourceLineNo">151</span>    * @param cacheObjects<a name="line.151"></a>
-<span class="sourceLineNo">152</span>    *    The objects to add to this session's cache.<a name="line.152"></a>
-<span class="sourceLineNo">153</span>    *    No-op if &lt;jk&gt;null&lt;/jk&gt;.<a name="line.153"></a>
-<span class="sourceLineNo">154</span>    */<a name="line.154"></a>
-<span class="sourceLineNo">155</span>   public final void addToCache(Map&lt;String,Object&gt; cacheObjects) {<a name="line.155"></a>
-<span class="sourceLineNo">156</span>      if (cacheObjects != null) {<a name="line.156"></a>
-<span class="sourceLineNo">157</span>         if (cache == null)<a name="line.157"></a>
-<span class="sourceLineNo">158</span>            cache = new TreeMap&lt;String,Object&gt;();<a name="line.158"></a>
-<span class="sourceLineNo">159</span>         cache.putAll(cacheObjects);<a name="line.159"></a>
-<span class="sourceLineNo">160</span>      }<a name="line.160"></a>
-<span class="sourceLineNo">161</span>   }<a name="line.161"></a>
-<span class="sourceLineNo">162</span><a name="line.162"></a>
-<span class="sourceLineNo">163</span>   /**<a name="line.163"></a>
-<span class="sourceLineNo">164</span>    * Returns an object stored in the session cache.<a name="line.164"></a>
-<span class="sourceLineNo">165</span>    *<a name="line.165"></a>
-<span class="sourceLineNo">166</span>    * @param c The class type of the object.<a name="line.166"></a>
-<span class="sourceLineNo">167</span>    * @param key The session object key.<a name="line.167"></a>
-<span class="sourceLineNo">168</span>    * @return The cached object, or &lt;jk&gt;null&lt;/jk&gt; if it doesn't exist.<a name="line.168"></a>
-<span class="sourceLineNo">169</span>    */<a name="line.169"></a>
-<span class="sourceLineNo">170</span>   @SuppressWarnings("unchecked")<a name="line.170"></a>
-<span class="sourceLineNo">171</span>   public final &lt;T&gt; T getFromCache(Class&lt;T&gt; c, String key) {<a name="line.171"></a>
-<span class="sourceLineNo">172</span>      return cache == null ? null : (T)cache.get(key);<a name="line.172"></a>
-<span class="sourceLineNo">173</span>   }<a name="line.173"></a>
-<span class="sourceLineNo">174</span><a name="line.174"></a>
-<span class="sourceLineNo">175</span>   /**<a name="line.175"></a>
-<span class="sourceLineNo">176</span>    * Logs a warning message.<a name="line.176"></a>
-<span class="sourceLineNo">177</span>    *<a name="line.177"></a>
-<span class="sourceLineNo">178</span>    * @param msg The warning message.<a name="line.178"></a>
-<span class="sourceLineNo">179</span>    * @param args Optional {@link MessageFormat}-style arguments.<a name="line.179"></a>
-<span class="sourceLineNo">180</span>    */<a name="line.180"></a>
-<span class="sourceLineNo">181</span>   public final void addWarning(String msg, Object... args) {<a name="line.181"></a>
-<span class="sourceLineNo">182</span>      if (warnings == null)<a name="line.182"></a>
-<span class="sourceLineNo">183</span>         warnings = new LinkedList&lt;String&gt;();<a name="line.183"></a>
-<span class="sourceLineNo">184</span>      getLogger().warning(msg, args);<a name="line.184"></a>
-<span class="sourceLineNo">185</span>      warnings.add((warnings.size() + 1) + ": " + format(msg, args));<a name="line.185"></a>
-<span class="sourceLineNo">186</span>   }<a name="line.186"></a>
-<span class="sourceLineNo">187</span><a name="line.187"></a>
-<span class="sourceLineNo">188</span>   /**<a name="line.188"></a>
-<span class="sourceLineNo">189</span>    * Returns &lt;jk&gt;true&lt;/jk&gt; if warnings occurred in this session.<a name="line.189"></a>
-<span class="sourceLineNo">190</span>    *<a name="line.190"></a>
-<span class="sourceLineNo">191</span>    * @return &lt;jk&gt;true&lt;/jk&gt; if warnings occurred in this session.<a name="line.191"></a>
-<span class="sourceLineNo">192</span>    */<a name="line.192"></a>
-<span class="sourceLineNo">193</span>   public final boolean hasWarnings() {<a name="line.193"></a>
-<span class="sourceLineNo">194</span>      return warnings != null &amp;&amp; warnings.size() &gt; 0;<a name="line.194"></a>
-<span class="sourceLineNo">195</span>   }<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>    * Returns the warnings that occurred in this session.<a name="line.198"></a>
-<span class="sourceLineNo">199</span>    *<a name="line.199"></a>
-<span class="sourceLineNo">200</span>    * @return The warnings that occurred in this session, or &lt;jk&gt;null&lt;/jk&gt; if no warnings occurred.<a name="line.200"></a>
-<span class="sourceLineNo">201</span>    */<a name="line.201"></a>
-<span class="sourceLineNo">202</span>   public final List&lt;String&gt; getWarnings() {<a name="line.202"></a>
-<span class="sourceLineNo">203</span>      return warnings;<a name="line.203"></a>
-<span class="sourceLineNo">204</span>   }<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 logger associated with this session.<a name="line.207"></a>
-<span class="sourceLineNo">208</span>    *<a name="line.208"></a>
-<span class="sourceLineNo">209</span>    * &lt;p&gt;<a name="line.209"></a>
-<span class="sourceLineNo">210</span>    * Subclasses can override this method to provide their own logger.<a name="line.210"></a>
-<span class="sourceLineNo">211</span>    *<a name="line.211"></a>
-<span class="sourceLineNo">212</span>    * @return The logger associated with this session.<a name="line.212"></a>
-<span class="sourceLineNo">213</span>    */<a name="line.213"></a>
-<span class="sourceLineNo">214</span>   protected final JuneauLogger getLogger() {<a name="line.214"></a>
-<span class="sourceLineNo">215</span>      if (logger == null)<a name="line.215"></a>
-<span class="sourceLineNo">216</span>         logger = JuneauLogger.getLogger(getClass());<a name="line.216"></a>
-<span class="sourceLineNo">217</span>      return logger;<a name="line.217"></a>
-<span class="sourceLineNo">218</span>   }<a name="line.218"></a>
-<span class="sourceLineNo">219</span><a name="line.219"></a>
-<span class="sourceLineNo">220</span>   /**<a name="line.220"></a>
-<span class="sourceLineNo">221</span>    * Returns the properties defined on this bean context as a simple map for debugging purposes.<a name="line.221"></a>
-<span class="sourceLineNo">222</span>    *<a name="line.222"></a>
-<span class="sourceLineNo">223</span>    * @return A new map containing the properties defined on this context.<a name="line.223"></a>
-<span class="sourceLineNo">224</span>    */<a name="line.224"></a>
-<span class="sourceLineNo">225</span>   @Overrideable<a name="line.225"></a>
-<span class="sourceLineNo">226</span>   public ObjectMap asMap() {<a name="line.226"></a>
-<span class="sourceLineNo">227</span>      return new ObjectMap();<a name="line.227"></a>
-<span class="sourceLineNo">228</span>   }<a name="line.228"></a>
-<span class="sourceLineNo">229</span><a name="line.229"></a>
-<span class="sourceLineNo">230</span>   @Override /* Object */<a name="line.230"></a>
-<span class="sourceLineNo">231</span>   public String toString() {<a name="line.231"></a>
-<span class="sourceLineNo">232</span>      try {<a name="line.232"></a>
-<span class="sourceLineNo">233</span>         return asMap().toString(JsonSerializer.DEFAULT_LAX_READABLE);<a name="line.233"></a>
-<span class="sourceLineNo">234</span>      } catch (SerializeException e) {<a name="line.234"></a>
-<span class="sourceLineNo">235</span>         return e.getLocalizedMessage();<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><a name="line.238"></a>
-<span class="sourceLineNo">239</span>   /**<a name="line.239"></a>
-<span class="sourceLineNo">240</span>    * Perform cleanup on this context object if necessary.<a name="line.240"></a>
-<span class="sourceLineNo">241</span>    *<a name="line.241"></a>
-<span class="sourceLineNo">242</span>    * @return &lt;jk&gt;true&lt;/jk&gt; if this method wasn't previously called.<a name="line.242"></a>
-<span class="sourceLineNo">243</span>    * @throws BeanRuntimeException If called more than once, or in debug mode and warnings occurred.<a name="line.243"></a>
-<span class="sourceLineNo">244</span>    */<a name="line.244"></a>
-<span class="sourceLineNo">245</span>   public boolean close() throws BeanRuntimeException {<a name="line.245"></a>
-<span class="sourceLineNo">246</span>      if (closed)<a name="line.246"></a>
-<span class="sourceLineNo">247</span>         return false;<a name="line.247"></a>
-<span class="sourceLineNo">248</span>      closed = true;<a name="line.248"></a>
-<span class="sourceLineNo">249</span>      return true;<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>   @Override /* Object */<a name="line.252"></a>
-<span class="sourceLineNo">253</span>   protected void finalize() throws Throwable {<a name="line.253"></a>
-<span class="sourceLineNo">254</span>//    if (! closed)<a name="line.254"></a>
-<span class="sourceLineNo">255</span>//       throw new RuntimeException("Session was not closed.");<a name="line.255"></a>
-<span class="sourceLineNo">256</span>   }<a name="line.256"></a>
-<span class="sourceLineNo">257</span>}<a name="line.257"></a>
+<span class="sourceLineNo">045</span><a name="line.45"></a>
+<span class="sourceLineNo">046</span>   /**<a name="line.46"></a>
+<span class="sourceLineNo">047</span>    * Default constructor.<a name="line.47"></a>
+<span class="sourceLineNo">048</span>    *<a name="line.48"></a>
+<span class="sourceLineNo">049</span>    * @param ctx<a name="line.49"></a>
+<span class="sourceLineNo">050</span>    *    The context creating this session object.<a name="line.50"></a>
+<span class="sourceLineNo">051</span>    *    The context contains all the configuration settings for the session.<a name="line.51"></a>
+<span class="sourceLineNo">052</span>    * @param args<a name="line.52"></a>
+<span class="sourceLineNo">053</span>    *    Runtime arguments.<a name="line.53"></a>
+<span class="sourceLineNo">054</span>    */<a name="line.54"></a>
+<span class="sourceLineNo">055</span>   protected Session(final Context ctx, SessionArgs args) {<a name="line.55"></a>
+<span class="sourceLineNo">056</span>      this.ctx = ctx;<a name="line.56"></a>
+<span class="sourceLineNo">057</span>      this.properties = args.properties != null ? args.properties : ObjectMap.EMPTY_MAP;<a name="line.57"></a>
+<span class="sourceLineNo">058</span>   }<a name="line.58"></a>
+<span class="sourceLineNo">059</span><a name="line.59"></a>
+<span class="sourceLineNo">060</span>   /**<a name="line.60"></a>
+<span class="sourceLineNo">061</span>    * Returns the session-level properties.<a name="line.61"></a>
+<span class="sourceLineNo">062</span>    *<a name="line.62"></a>
+<span class="sourceLineNo">063</span>    * @return The session-level properties.<a name="line.63"></a>
+<span class="sourceLineNo">064</span>    */<a name="line.64"></a>
+<span class="sourceLineNo">065</span>   protected final ObjectMap getProperties() {<a name="line.65"></a>
+<span class="sourceLineNo">066</span>      return properties;<a name="line.66"></a>
+<span class="sourceLineNo">067</span>   }<a name="line.67"></a>
+<span class="sourceLineNo">068</span><a name="line.68"></a>
+<span class="sourceLineNo">069</span>   /**<a name="line.69"></a>
+<span class="sourceLineNo">070</span>    * Returns the session property with the specified key.<a name="line.70"></a>
+<span class="sourceLineNo">071</span>    *<a name="line.71"></a>
+<span class="sourceLineNo">072</span>    * &lt;p&gt;<a name="line.72"></a>
+<span class="sourceLineNo">073</span>    * The order of lookup for the property is as follows:<a name="line.73"></a>
+<span class="sourceLineNo">074</span>    * &lt;ul&gt;<a name="line.74"></a>
+<span class="sourceLineNo">075</span>    *    &lt;li&gt;Override property passed in through the constructor.<a name="line.75"></a>
+<span class="sourceLineNo">076</span>    *    &lt;li&gt;Property defined on the context object.<a name="line.76"></a>
+<span class="sourceLineNo">077</span>    *    &lt;li&gt;System.property.<a name="line.77"></a>
+<span class="sourceLineNo">078</span>    * &lt;/ul&gt;<a name="line.78"></a>
+<span class="sourceLineNo">079</span>    *<a name="line.79"></a>
+<span class="sourceLineNo">080</span>    * @param key The property key.<a name="line.80"></a>
+<span class="sourceLineNo">081</span>    * @return The property value, or &lt;jk&gt;null&lt;/jk&gt; if it doesn't exist.<a name="line.81"></a>
+<span class="sourceLineNo">082</span>    */<a name="line.82"></a>
+<span class="sourceLineNo">083</span>   public final String getStringProperty(String key) {<a name="line.83"></a>
+<span class="sourceLineNo">084</span>      return getStringProperty(key, null);<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>   /**<a name="line.87"></a>
+<span class="sourceLineNo">088</span>    * Same as {@link #getStringProperty(String)} but with a default value.<a name="line.88"></a>
+<span class="sourceLineNo">089</span>    *<a name="line.89"></a>
+<span class="sourceLineNo">090</span>    * @param key The property key.<a name="line.90"></a>
+<span class="sourceLineNo">091</span>    * @param def The default value if the property doesn't exist or is &lt;jk&gt;null&lt;/jk&gt;.<a name="line.91"></a>
+<span class="sourceLineNo">092</span>    * @return The property value.<a name="line.92"></a>
+<span class="sourceLineNo">093</span>    */<a name="line.93"></a>
+<span class="sourceLineNo">094</span>   public final String getStringProperty(String key, String def) {<a name="line.94"></a>
+<span class="sourceLineNo">095</span>      Object v = properties.get(key);<a name="line.95"></a>
+<span class="sourceLineNo">096</span>      if (v == null)<a name="line.96"></a>
+<span class="sourceLineNo">097</span>         v = ctx.getPropertyStore().getProperty(key, String.class, null);<a name="line.97"></a>
+<span class="sourceLineNo">098</span>      if (v == null)<a name="line.98"></a>
+<span class="sourceLineNo">099</span>         v = def;<a name="line.99"></a>
+<span class="sourceLineNo">100</span>      return StringUtils.toString(v);<a name="line.100"></a>
+<span class="sourceLineNo">101</span>   }<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>    * Same as {@link #getStringProperty(String)} but transforms the value to the specified type.<a name="line.104"></a>
+<span class="sourceLineNo">105</span>    *<a name="line.105"></a>
+<span class="sourceLineNo">106</span>    * @param key The property key.<a name="line.106"></a>
+<span class="sourceLineNo">107</span>    * @param type The class type of the value.<a name="line.107"></a>
+<span class="sourceLineNo">108</span>    *<a name="line.108"></a>
+<span class="sourceLineNo">109</span>    * @return The property value.<a name="line.109"></a>
+<span class="sourceLineNo">110</span>    */<a name="line.110"></a>
+<span class="sourceLineNo">111</span>   public final &lt;T&gt; T getProperty(String key, Class&lt;T&gt; type) {<a name="line.111"></a>
+<span class="sourceLineNo">112</span>      return getPropertyWithDefault(key, null, type);<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>   /**<a name="line.115"></a>
+<span class="sourceLineNo">116</span>    * Same as {@link #getProperty(String,Class)} but with a default value.<a name="line.116"></a>
+<span class="sourceLineNo">117</span>    *<a name="line.117"></a>
+<span class="sourceLineNo">118</span>    * @param key The property key.<a name="line.118"></a>
+<span class="sourceLineNo">119</span>    * @param def The default value if the property doesn't exist or is &lt;jk&gt;null&lt;/jk&gt;.<a name="line.119"></a>
+<span class="sourceLineNo">120</span>    * @param type The class type of the value.<a name="line.120"></a>
+<span class="sourceLineNo">121</span>    *<a name="line.121"></a>
+<span class="sourceLineNo">122</span>    * @return The property value.<a name="line.122"></a>
+<span class="sourceLineNo">123</span>    */<a name="line.123"></a>
+<span class="sourceLineNo">124</span>   public final &lt;T&gt; T getPropertyWithDefault(String key, T def, Class&lt;T&gt; type) {<a name="line.124"></a>
+<span class="sourceLineNo">125</span>      T t = properties.get(key, type);<a name="line.125"></a>
+<span class="sourceLineNo">126</span>      if (t == null)<a name="line.126"></a>
+<span class="sourceLineNo">127</span>         t = ctx.getPropertyStore().getProperty(key, type, def);<a name="line.127"></a>
+<span class="sourceLineNo">128</span>      return t;<a name="line.128"></a>
+<span class="sourceLineNo">129</span>   }<a name="line.129"></a>
+<span class="sourceLineNo">130</span><a name="line.130"></a>
+<span class="sourceLineNo">131</span>   /**<a name="line.131"></a>
+<span class="sourceLineNo">132</span>    * Adds an arbitrary object to this session's cache.<a name="line.132"></a>
+<span class="sourceLineNo">133</span>    *<a name="line.133"></a>
+<span class="sourceLineNo">134</span>    * &lt;p&gt;<a name="line.134"></a>
+<span class="sourceLineNo">135</span>    * Can be used to store objects for reuse during a session.<a name="line.135"></a>
+<span class="sourceLineNo">136</span>    *<a name="line.136"></a>
+<span class="sourceLineNo">137</span>    * @param key The key.  Can be any string.<a name="line.137"></a>
+<span class="sourceLineNo">138</span>    * @param val The cached object.<a name="line.138"></a>
+<span class="sourceLineNo">139</span>    */<a name="line.139"></a>
+<span class="sourceLineNo">140</span>   public final void addToCache(String key, Object val) {<a name="line.140"></a>
+<span class="sourceLineNo">141</span>      if (cache == null)<a name="line.141"></a>
+<span class="sourceLineNo">142</span>         cache = new TreeMap&lt;&gt;();<a name="line.142"></a>
+<span class="sourceLineNo">143</span>      cache.put(key, val);<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>   /**<a name="line.146"></a>
+<span class="sourceLineNo">147</span>    * Adds arbitrary objects to this session's cache.<a name="line.147"></a>
+<span class="sourceLineNo">148</span>    *<a name="line.148"></a>
+<span class="sourceLineNo">149</span>    * &lt;p&gt;<a name="line.149"></a>
+<span class="sourceLineNo">150</span>    * Can be used to store objects for reuse during a session.<a name="line.150"></a>
+<span class="sourceLineNo">151</span>    *<a name="line.151"></a>
+<span class="sourceLineNo">152</span>    * @param cacheObjects<a name="line.152"></a>
+<span class="sourceLineNo">153</span>    *    The objects to add to this session's cache.<a name="line.153"></a>
+<span class="sourceLineNo">154</span>    *    No-op if &lt;jk&gt;null&lt;/jk&gt;.<a name="line.154"></a>
+<span class="sourceLineNo">155</span>    */<a name="line.155"></a>
+<span class="sourceLineNo">156</span>   public final void addToCache(Map&lt;String,Object&gt; cacheObjects) {<a name="line.156"></a>
+<span class="sourceLineNo">157</span>      if (cacheObjects != null) {<a name="line.157"></a>
+<span class="sourceLineNo">158</span>         if (cache == null)<a name="line.158"></a>
+<span class="sourceLineNo">159</span>            cache = new TreeMap&lt;&gt;();<a name="line.159"></a>
+<span class="sourceLineNo">160</span>         cache.putAll(cacheObjects);<a name="line.160"></a>
+<span class="sourceLineNo">161</span>      }<a name="line.161"></a>
+<span class="sourceLineNo">162</span>   }<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>    * Returns an object stored in the session cache.<a name="line.165"></a>
+<span class="sourceLineNo">166</span>    *<a name="line.166"></a>
+<span class="sourceLineNo">167</span>    * @param c The class type of the object.<a name="line.167"></a>
+<span class="sourceLineNo">168</span>    * @param key The session object key.<a name="line.168"></a>
+<span class="sourceLineNo">169</span>    * @return The cached object, or &lt;jk&gt;null&lt;/jk&gt; if it doesn't exist.<a name="line.169"></a>
+<span class="sourceLineNo">170</span>    */<a name="line.170"></a>
+<span class="sourceLineNo">171</span>   @SuppressWarnings("unchecked")<a name="line.171"></a>
+<span class="sourceLineNo">172</span>   public final &lt;T&gt; T getFromCache(Class&lt;T&gt; c, String key) {<a name="line.172"></a>
+<span class="sourceLineNo">173</span>      return cache == null ? null : (T)cache.get(key);<a name="line.173"></a>
+<span class="sourceLineNo">174</span>   }<a name="line.174"></a>
+<span class="sourceLineNo">175</span><a name="line.175"></a>
+<span class="sourceLineNo">176</span>   /**<a name="line.176"></a>
+<span class="sourceLineNo">177</span>    * Logs a warning message.<a name="line.177"></a>
+<span class="sourceLineNo">178</span>    *<a name="line.178"></a>
+<span class="sourceLineNo">179</span>    * @param msg The warning message.<a name="line.179"></a>
+<span class="sourceLineNo">180</span>    * @param args Optional {@link MessageFormat}-style arguments.<a name="line.180"></a>
+<span class="sourceLineNo">181</span>    */<a name="line.181"></a>
+<span class="sourceLineNo">182</span>   public final void addWarning(String msg, Object... args) {<a name="line.182"></a>
+<span class="sourceLineNo">183</span>      if (warnings == null)<a name="line.183"></a>
+<span class="sourceLineNo">184</span>         warnings = new LinkedList&lt;&gt;();<a name="line.184"></a>
+<span class="sourceLineNo">185</span>      getLogger().warning(msg, args);<a name="line.185"></a>
+<span class="sourceLineNo">186</span>      warnings.add((warnings.size() + 1) + ": " + format(msg, args));<a name="line.186"></a>
+<span class="sourceLineNo">187</span>   }<a name="line.187"></a>
+<span class="sourceLineNo">188</span><a name="line.188"></a>
+<span class="sourceLineNo">189</span>   /**<a name="line.189"></a>
+<span class="sourceLineNo">190</span>    * Returns &lt;jk&gt;true&lt;/jk&gt; if warnings occurred in this session.<a name="line.190"></a>
+<span class="sourceLineNo">191</span>    *<a name="line.191"></a>
+<span class="sourceLineNo">192</span>    * @return &lt;jk&gt;true&lt;/jk&gt; if warnings occurred in this session.<a name="line.192"></a>
+<span class="sourceLineNo">193</span>    */<a name="line.193"></a>
+<span class="sourceLineNo">194</span>   public final boolean hasWarnings() {<a name="line.194"></a>
+<span class="sourceLineNo">195</span>      return warnings != null &amp;&amp; warnings.size() &gt; 0;<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>   /**<a name="line.198"></a>
+<span class="sourceLineNo">199</span>    * Returns the warnings that occurred in this session.<a name="line.199"></a>
+<span class="sourceLineNo">200</span>    *<a name="line.200"></a>
+<span class="sourceLineNo">201</span>    * @return The warnings that occurred in this session, or &lt;jk&gt;null&lt;/jk&gt; if no warnings occurred.<a name="line.201"></a>
+<span class="sourceLineNo">202</span>    */<a name="line.202"></a>
+<span class="sourceLineNo">203</span>   public final List&lt;String&gt; getWarnings() {<a name="line.203"></a>
+<span class="sourceLineNo">204</span>      return warnings;<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>   /**<a name="line.207"></a>
+<span class="sourceLineNo">208</span>    * Returns the logger associated with this session.<a name="line.208"></a>
+<span class="sourceLineNo">209</span>    *<a name="line.209"></a>
+<span class="sourceLineNo">210</span>    * &lt;p&gt;<a name="line.210"></a>
+<span class="sourceLineNo">211</span>    * Subclasses can override this method to provide their own logger.<a name="line.211"></a>
+<span class="sourceLineNo">212</span>    *<a name="line.212"></a>
+<span class="sourceLineNo">213</span>    * @return The logger associated with this session.<a name="line.213"></a>
+<span class="sourceLineNo">214</span>    */<a name="line.214"></a>
+<span class="sourceLineNo">215</span>   protected final JuneauLogger getLogger() {<a name="line.215"></a>
+<span class="sourceLineNo">216</span>      if (logger == null)<a name="line.216"></a>
+<span class="sourceLineNo">217</span>         logger = JuneauLogger.getLogger(getClass());<a name="line.217"></a>
+<span class="sourceLineNo">218</span>      return logger;<a name="line.218"></a>
+<span class="sourceLineNo">219</span>   }<a name="line.219"></a>
+<span class="sourceLineNo">220</span><a name="line.220"></a>
+<span class="sourceLineNo">221</span>   /**<a name="line.221"></a>
+<span class="sourceLineNo">222</span>    * Returns the properties defined on this bean context as a simple map for debugging purposes.<a name="line.222"></a>
+<span class="sourceLineNo">223</span>    *<a name="line.223"></a>
+<span class="sourceLineNo">224</span>    * @return A new map containing the properties defined on this context.<a name="line.224"></a>
+<span class="sourceLineNo">225</span>    */<a name="line.225"></a>
+<span class="sourceLineNo">226</span>   @Overrideable<a name="line.226"></a>
+<span class="sourceLineNo">227</span>   public ObjectMap asMap() {<a name="line.227"></a>
+<span class="sourceLineNo">228</span>      return new ObjectMap();<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>   @Override /* Object */<a name="line.231"></a>
+<span class="sourceLineNo">232</span>   public String toString() {<a name="line.232"></a>
+<span class="sourceLineNo">233</span>      try {<a name="line.233"></a>
+<span class="sourceLineNo">234</span>         return asMap().toString(JsonSerializer.DEFAULT_LAX_READABLE);<a name="line.234"></a>
+<span class="sourceLineNo">235</span>      } catch (SerializeException e) {<a name="line.235"></a>
+<span class="sourceLineNo">236</span>         return e.getLocalizedMessage();<a name="line.236"></a>
+<span class="sourceLineNo">237</span>      }<a name="line.237"></a>
+<span class="sourceLineNo">238</span>   }<a name="line.238"></a>
+<span class="sourceLineNo">239</span><a name="line.239"></a>
+<span class="sourceLineNo">240</span>   @Override /* Closeable */<a name="line.240"></a>
+<span class="sourceLineNo">241</span>   public void close() {<a name="line.241"></a>
+<span class="sourceLineNo">242</span>      closed = true;<a name="line.242"></a>
+<span class="sourceLineNo">243</span>   }<a name="line.243"></a>
+<span class="sourceLineNo">244</span>   <a name="line.244"></a>
+<span class="sourceLineNo">245</span>   /**<a name="line.245"></a>
+<span class="sourceLineNo">246</span>    * Returns &lt;jk&gt;true&lt;/jk&gt; if this object is closed.<a name="line.246"></a>
+<span class="sourceLineNo">247</span>    * @return &lt;jk&gt;true&lt;/jk&gt; if this object is closed.<a name="line.247"></a>
+<span class="sourceLineNo">248</span>    */<a name="line.248"></a>
+<span class="sourceLineNo">249</span>   protected boolean isClosed() {<a name="line.249"></a>
+<span class="sourceLineNo">250</span>      return closed;<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>   @Override /* Object */<a name="line.253"></a>
+<span class="sourceLineNo">254</span>   protected void finalize() throws Throwable {<a name="line.254"></a>
+<span class="sourceLineNo">255</span>//    if (! closed)<a name="line.255"></a>
+<span class="sourceLineNo">256</span>//       throw new RuntimeException("Session was not closed.");<a name="line.256"></a>
+<span class="sourceLineNo">257</span>   }<a name="line.257"></a>
+<span class="sourceLineNo">258</span>}<a name="line.258"></a>
 
 
 



Mime
View raw message