poolutils.html

优秀的文档,可以学习java之用 0006728337 00000 n 0006728424 00000 n 0006728600 00000 n

<a name="125" href="#125">125</a> <em>     *</em>
<a name="126" href="#126">126</a> <em>     * @param pool the {@link ObjectPool} to delegate to.</em>
<a name="127" href="#127">127</a> <em>     * @return a {@link KeyedObjectPool} that delegates to &lt;code>keyedPool&lt;/code> ignoring the key.</em>
<a name="128" href="#128">128</a> <em>     * @throws IllegalArgumentException when &lt;code>keyedPool&lt;/code> is &lt;code>null&lt;/code>.</em>
<a name="129" href="#129">129</a> <em>     * @since Pool 1.3</em>
<a name="130" href="#130">130</a> <em>     */</em>
<a name="131" href="#131">131</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../org/apache/commons/pool/KeyedObjectPool.html">KeyedObjectPool</a> adapt(<strong>final</strong> <a href="../../../../org/apache/commons/pool/ObjectPool.html">ObjectPool</a> pool) throws IllegalArgumentException {
<a name="132" href="#132">132</a>         <strong>return</strong> <strong>new</strong> KeyedObjectPoolAdaptor(pool);
<a name="133" href="#133">133</a>     }
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>     <em>/**<em>*</em></em>
<a name="136" href="#136">136</a> <em>     * Wraps an &lt;code>ObjectPool&lt;/code> and dynamically checks the type of objects borrowed and returned to the keyedPool.</em>
<a name="137" href="#137">137</a> <em>     * If an object is passed to the keyedPool that isn't of type &lt;code>type&lt;/code> a {@link ClassCastException} will be thrown.</em>
<a name="138" href="#138">138</a> <em>     *</em>
<a name="139" href="#139">139</a> <em>     * @param pool the keyedPool to enforce type safety on</em>
<a name="140" href="#140">140</a> <em>     * @return an &lt;code>ObjectPool&lt;/code> that will only allow objects of &lt;code>type&lt;/code></em>
<a name="141" href="#141">141</a> <em>     * @since Pool 1.3</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../org/apache/commons/pool/ObjectPool.html">ObjectPool</a> checkedPool(<strong>final</strong> <a href="../../../../org/apache/commons/pool/ObjectPool.html">ObjectPool</a> pool, <strong>final</strong> Class type) {
<a name="144" href="#144">144</a>         <strong>if</strong> (pool == <strong>null</strong>) {
<a name="145" href="#145">145</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"pool must not be null."</span>);
<a name="146" href="#146">146</a>         }
<a name="147" href="#147">147</a>         <strong>if</strong> (type == <strong>null</strong>) {
<a name="148" href="#148">148</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type must not be null."</span>);
<a name="149" href="#149">149</a>         }
<a name="150" href="#150">150</a>         <strong>return</strong> <strong>new</strong> CheckedObjectPool(pool, type);
<a name="151" href="#151">151</a>     }
<a name="152" href="#152">152</a> 
<a name="153" href="#153">153</a>     <em>/**<em>*</em></em>
<a name="154" href="#154">154</a> <em>     * Wraps an &lt;code>KeyedObjectPool&lt;/code> and dynamically checks the type of objects borrowed and returned to the keyedPool.</em>
<a name="155" href="#155">155</a> <em>     * If an object is passed to the keyedPool that isn't of type &lt;code>type&lt;/code> a {@link ClassCastException} will be thrown.</em>
<a name="156" href="#156">156</a> <em>     *</em>
<a name="157" href="#157">157</a> <em>     * @param keyedPool the keyedPool to enforce type safety on</em>
<a name="158" href="#158">158</a> <em>     * @return an &lt;code>KeyedObjectPool&lt;/code> that will only allow objects of &lt;code>type&lt;/code></em>
<a name="159" href="#159">159</a> <em>     * @since Pool 1.3</em>
<a name="160" href="#160">160</a> <em>     */</em>
<a name="161" href="#161">161</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../org/apache/commons/pool/KeyedObjectPool.html">KeyedObjectPool</a> checkedPool(<strong>final</strong> <a href="../../../../org/apache/commons/pool/KeyedObjectPool.html">KeyedObjectPool</a> keyedPool, <strong>final</strong> Class type) {
<a name="162" href="#162">162</a>         <strong>if</strong> (keyedPool == <strong>null</strong>) {
<a name="163" href="#163">163</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"keyedPool must not be null."</span>);
<a name="164" href="#164">164</a>         }
<a name="165" href="#165">165</a>         <strong>if</strong> (type == <strong>null</strong>) {
<a name="166" href="#166">166</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type must not be null."</span>);
<a name="167" href="#167">167</a>         }
<a name="168" href="#168">168</a>         <strong>return</strong> <strong>new</strong> CheckedKeyedObjectPool(keyedPool, type);
<a name="169" href="#169">169</a>     }
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>     <em>/**<em>*</em></em>
<a name="172" href="#172">172</a> <em>     * Periodically check the idle object count for the keyedPool. At most one idle object will be added per period.</em>
<a name="173" href="#173">173</a> <em>     * If there is an exception when calling {@link ObjectPool#addObject()} then no more checks will be performed.</em>
<a name="174" href="#174">174</a> <em>     *</em>
<a name="175" href="#175">175</a> <em>     * @param pool the keyedPool to check periodically.</em>
<a name="176" href="#176">176</a> <em>     * @param minIdle if the {@link ObjectPool#getNumIdle()} is less than this then add an idle object.</em>
<a name="177" href="#177">177</a> <em>     * @param period the frequency to check the number of idle objects in a keyedPool, see</em>
<a name="178" href="#178">178</a> <em>     *      {@link Timer#schedule(TimerTask, long, long)}.</em>
<a name="179" href="#179">179</a> <em>     * @return the {@link TimerTask} that will periodically check the pools idle object count.</em>
<a name="180" href="#180">180</a> <em>     * @throws IllegalArgumentException when &lt;code>keyedPool&lt;/code> is &lt;code>null&lt;/code> or</em>
<a name="181" href="#181">181</a> <em>     *      when &lt;code>minIdle&lt;/code> is negative or when &lt;code>period&lt;/code> isn't</em>
<a name="182" href="#182">182</a> <em>     *      valid for {@link Timer#schedule(TimerTask, long, long)}.</em>
<a name="183" href="#183">183</a> <em>     * @since Pool 1.3</em>
<a name="184" href="#184">184</a> <em>     */</em>
<a name="185" href="#185">185</a>     <strong>public</strong> <strong>static</strong> TimerTask checkMinIdle(<strong>final</strong> <a href="../../../../org/apache/commons/pool/ObjectPool.html">ObjectPool</a> pool, <strong>final</strong> <strong>int</strong> minIdle, <strong>final</strong> <strong>long</strong> period) throws IllegalArgumentException {
<a name="186" href="#186">186</a>         <strong>if</strong> (pool == <strong>null</strong>) {
<a name="187" href="#187">187</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"keyedPool must not be null."</span>);
<a name="188" href="#188">188</a>         }
<a name="189" href="#189">189</a>         <strong>if</strong> (minIdle &lt; 0) {
<a name="190" href="#190">190</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"minIdle must be non-negative."</span>);
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a>         <strong>final</strong> TimerTask task = <strong>new</strong> ObjectPoolMinIdleTimerTask(pool, minIdle);
<a name="193" href="#193">193</a>         getMinIdleTimer().schedule(task, 0L, period);
<a name="194" href="#194">194</a>         <strong>return</strong> task;
<a name="195" href="#195">195</a>     }
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>     <em>/**<em>*</em></em>
<a name="198" href="#198">198</a> <em>     * Periodically check the idle object count for the key in the keyedPool. At most one idle object will be added per period.</em>
<a name="199" href="#199">199</a> <em>     * If there is an exception when calling {@link KeyedObjectPool#addObject(Object)} then no more checks for that key</em>
<a name="200" href="#200">200</a> <em>     * will be performed.</em>
<a name="201" href="#201">201</a> <em>     *</em>
<a name="202" href="#202">202</a> <em>     * @param keyedPool the keyedPool to check periodically.</em>
<a name="203" href="#203">203</a> <em>     * @param key the key to check the idle count of.</em>
<a name="204" href="#204">204</a> <em>     * @param minIdle if the {@link KeyedObjectPool#getNumIdle(Object)} is less than this then add an idle object.</em>
<a name="205" href="#205">205</a> <em>     * @param period the frequency to check the number of idle objects in a keyedPool, see</em>
<a name="206" href="#206">206</a> <em>     *      {@link Timer#schedule(TimerTask, long, long)}.</em>
<a name="207" href="#207">207</a> <em>     * @return the {@link TimerTask} that will periodically check the pools idle object count.</em>
<a name="208" href="#208">208</a> <em>     * @throws IllegalArgumentException when &lt;code>keyedPool&lt;/code>, &lt;code>key&lt;/code> is &lt;code>null&lt;/code> or</em>
<a name="209" href="#209">209</a> <em>     *      when &lt;code>minIdle&lt;/code> is negative or when &lt;code>period&lt;/code> isn't</em>
<a name="210" href="#210">210</a> <em>     *      valid for {@link Timer#schedule(TimerTask, long, long)}.</em>
<a name="211" href="#211">211</a> <em>     * @since Pool 1.3</em>
<a name="212" href="#212">212</a> <em>     */</em>
<a name="213" href="#213">213</a>     <strong>public</strong> <strong>static</strong> TimerTask checkMinIdle(<strong>final</strong> <a href="../../../../org/apache/commons/pool/KeyedObjectPool.html">KeyedObjectPool</a> keyedPool, <strong>final</strong> Object key, <strong>final</strong> <strong>int</strong> minIdle, <strong>final</strong> <strong>long</strong> period) throws IllegalArgumentException {
<a name="214" href="#214">214</a>         <strong>if</strong> (keyedPool == <strong>null</strong>) {
<a name="215" href="#215">215</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"keyedPool must not be null."</span>);
<a name="216" href="#216">216</a>         }
<a name="217" href="#217">217</a>         <strong>if</strong> (key == <strong>null</strong>) {
<a name="218" href="#218">218</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"key must not be null."</span>);
<a name="219" href="#219">219</a>         }
<a name="220" href="#220">220</a>         <strong>if</strong> (minIdle &lt; 0) {
<a name="221" href="#221">221</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"minIdle must be non-negative."</span>);
<a name="222" href="#222">222</a>         }
<a name="223" href="#223">223</a>         <strong>final</strong> TimerTask task = <strong>new</strong> KeyedObjectPoolMinIdleTimerTask(keyedPool, key, minIdle);
<a name="224" href="#224">224</a>         getMinIdleTimer().schedule(task, 0L, period);
<a name="225" href="#225">225</a>         <strong>return</strong> task;
<a name="226" href="#226">226</a>     }
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a>     <em>/**<em>*</em></em>
<a name="229" href="#229">229</a> <em>     * Periodically check the idle object count for each key in the &lt;code>Collection&lt;/code> &lt;code>keys&lt;/code> in the keyedPool.</em>
<a name="230" href="#230">230</a> <em>     * At most one idle object will be added per period.</em>
<a name="231" href="#231">231</a> <em>     *</em>
<a name="232" href="#232">232</a> <em>     * @param keyedPool the keyedPool to check periodically.</em>
<a name="233" href="#233">233</a> <em>     * @param keys a collection of keys to check the idle object count.</em>
<a name="234" href="#234">234</a> <em>     * @param minIdle if the {@link KeyedObjectPool#getNumIdle(Object)} is less than this then add an idle object.</em>
<a name="235" href="#235">235</a> <em>     * @param period the frequency to check the number of idle objects in a keyedPool, see</em>
<a name="236" href="#236">236</a> <em>     *      {@link Timer#schedule(TimerTask, long, long)}.</em>
<a name="237" href="#237">237</a> <em>     * @return a {@link Map} of key and {@link TimerTask} pairs that will periodically check the pools idle object count.</em>
<a name="238" href="#238">238</a> <em>     * @throws IllegalArgumentException when &lt;code>keyedPool&lt;/code>, &lt;code>keys&lt;/code>, or any of the values in the</em>
<a name="239" href="#239">239</a> <em>     *      collection is &lt;code>null&lt;/code> or when &lt;code>minIdle&lt;/code> is negative or when &lt;code>period&lt;/code> isn't</em>
<a name="240" href="#240">240</a> <em>     *      valid for {@link Timer#schedule(TimerTask, long, long)}.</em>
<a name="241" href="#241">241</a> <em>     * @see #checkMinIdle(KeyedObjectPool, Object, int, long)</em>
<a name="242" href="#242">242</a> <em>     * @since Pool 1.3</em>
<a name="243" href="#243">243</a> <em>     */</em>
<a name="244" href="#244">244</a>     <strong>public</strong> <strong>static</strong> Map checkMinIdle(<strong>final</strong> <a href="../../../../org/apache/commons/pool/KeyedObjectPool.html">KeyedObjectPool</a> keyedPool, <strong>final</strong> Collection keys, <strong>final</strong> <strong>int</strong> minIdle, <strong>final</strong> <strong>long</strong> period) throws IllegalArgumentException {
<a name="245" href="#245">245</a>         <strong>if</strong> (keys == <strong>null</strong>) {
<a name="246" href="#246">246</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"keys must not be null."</span>);
<a name="247" href="#247">247</a>         }
<a name="248" href="#248">248</a>         <strong>final</strong> Map tasks = <strong>new</strong> HashMap(keys.size());
<a name="249" href="#249">249</a>         <strong>final</strong> Iterator iter = keys.iterator();
<a name="250" href="#250">250</a>         <strong>while</strong> (iter.hasNext()) {
<a name="251" href="#251">251</a>             <strong>final</strong> Object key = iter.next();
<a name="252" href="#252">252</a>             <strong>final</strong> TimerTask task = checkMinIdle(keyedPool, key, minIdle, period);
<a name="253" href="#253">253</a>             tasks.put(key, task);
<a name="254" href="#254">254</a>         }
<a name="255" href="#255">255</a>         <strong>return</strong> tasks;
<a name="256" href="#256">256</a>     }
<a name="257" href="#257">257</a>