Modified:
websites/production/commons/content/proper/commons-pool/apidocs/src-html/org/apache/commons/pool2/impl/BaseGenericObjectPool.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/apidocs/src-html/org/apache/commons/pool2/impl/BaseGenericObjectPool.html
(original)
+++
websites/production/commons/content/proper/commons-pool/apidocs/src-html/org/apache/commons/pool2/impl/BaseGenericObjectPool.html
Thu Feb 14 14:37:19 2019
@@ -225,1171 +225,1200 @@
<span class="sourceLineNo">217</span> this.blockWhenExhausted =
blockWhenExhausted;<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 maximum amount of time
(in milliseconds) the<a name="line.221"></a>
-<span class="sourceLineNo">222</span> *
<code>borrowObject()</code> method should block before throwing
an<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * exception when the pool is
exhausted and<a name="line.223"></a>
-<span class="sourceLineNo">224</span> * {@link #getBlockWhenExhausted} is
true. When less than 0, the<a name="line.224"></a>
-<span class="sourceLineNo">225</span> *
<code>borrowObject()</code> method may block indefinitely.<a
name="line.225"></a>
-<span class="sourceLineNo">226</span> *<a name="line.226"></a>
-<span class="sourceLineNo">227</span> * @return the maximum number of
milliseconds <code>borrowObject()</code><a name="line.227"></a>
-<span class="sourceLineNo">228</span> * will block.<a
name="line.228"></a>
-<span class="sourceLineNo">229</span> *<a name="line.229"></a>
-<span class="sourceLineNo">230</span> * @see #setMaxWaitMillis<a
name="line.230"></a>
-<span class="sourceLineNo">231</span> * @see #setBlockWhenExhausted<a
name="line.231"></a>
-<span class="sourceLineNo">232</span> */<a name="line.232"></a>
-<span class="sourceLineNo">233</span> public final long getMaxWaitMillis()
{<a name="line.233"></a>
-<span class="sourceLineNo">234</span> return maxWaitMillis;<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> /**<a name="line.237"></a>
-<span class="sourceLineNo">238</span> * Sets the maximum amount of time
(in milliseconds) the<a name="line.238"></a>
-<span class="sourceLineNo">239</span> *
<code>borrowObject()</code> method should block before throwing
an<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * exception when the pool is
exhausted and<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * {@link #getBlockWhenExhausted} is
true. When less than 0, the<a name="line.241"></a>
-<span class="sourceLineNo">242</span> *
<code>borrowObject()</code> method may block indefinitely.<a
name="line.242"></a>
-<span class="sourceLineNo">243</span> *<a name="line.243"></a>
-<span class="sourceLineNo">244</span> * @param maxWaitMillis the maximum
number of milliseconds<a name="line.244"></a>
-<span class="sourceLineNo">245</span> *
<code>borrowObject()</code> will block or negative<a
name="line.245"></a>
-<span class="sourceLineNo">246</span> * for
indefinitely.<a name="line.246"></a>
-<span class="sourceLineNo">247</span> *<a name="line.247"></a>
-<span class="sourceLineNo">248</span> * @see #getMaxWaitMillis<a
name="line.248"></a>
-<span class="sourceLineNo">249</span> * @see #setBlockWhenExhausted<a
name="line.249"></a>
-<span class="sourceLineNo">250</span> */<a name="line.250"></a>
-<span class="sourceLineNo">251</span> public final void
setMaxWaitMillis(final long maxWaitMillis) {<a name="line.251"></a>
-<span class="sourceLineNo">252</span> this.maxWaitMillis =
maxWaitMillis;<a name="line.252"></a>
-<span class="sourceLineNo">253</span> }<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> * Returns whether the pool has LIFO
(last in, first out) behaviour with<a name="line.256"></a>
-<span class="sourceLineNo">257</span> * respect to idle objects - always
returning the most recently used object<a name="line.257"></a>
-<span class="sourceLineNo">258</span> * from the pool, or as a FIFO (first
in, first out) queue, where the pool<a name="line.258"></a>
-<span class="sourceLineNo">259</span> * always returns the oldest object
in the idle object pool.<a name="line.259"></a>
-<span class="sourceLineNo">260</span> *<a name="line.260"></a>
-<span class="sourceLineNo">261</span> * @return
<code>true</code> if the pool is configured with LIFO behaviour<a
name="line.261"></a>
-<span class="sourceLineNo">262</span> * or
<code>false</code> if the pool is configured with FIFO<a
name="line.262"></a>
-<span class="sourceLineNo">263</span> * behaviour<a
name="line.263"></a>
-<span class="sourceLineNo">264</span> *<a name="line.264"></a>
-<span class="sourceLineNo">265</span> * @see #setLifo<a
name="line.265"></a>
-<span class="sourceLineNo">266</span> */<a name="line.266"></a>
-<span class="sourceLineNo">267</span> public final boolean getLifo() {<a
name="line.267"></a>
-<span class="sourceLineNo">268</span> return lifo;<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> * Returns whether or not the pool
serves threads waiting to borrow objects fairly.<a name="line.272"></a>
-<span class="sourceLineNo">273</span> * True means that waiting threads
are served as if waiting in a FIFO queue.<a name="line.273"></a>
-<span class="sourceLineNo">274</span> *<a name="line.274"></a>
-<span class="sourceLineNo">275</span> * @return
<code>true</code> if waiting threads are to be served<a
name="line.275"></a>
-<span class="sourceLineNo">276</span> * by the pool in arrival
order<a name="line.276"></a>
-<span class="sourceLineNo">277</span> */<a name="line.277"></a>
-<span class="sourceLineNo">278</span> public final boolean getFairness()
{<a name="line.278"></a>
-<span class="sourceLineNo">279</span> return fairness;<a
name="line.279"></a>
-<span class="sourceLineNo">280</span> }<a name="line.280"></a>
-<span class="sourceLineNo">281</span><a name="line.281"></a>
-<span class="sourceLineNo">282</span> /**<a name="line.282"></a>
-<span class="sourceLineNo">283</span> * Sets whether the pool has LIFO
(last in, first out) behaviour with<a name="line.283"></a>
-<span class="sourceLineNo">284</span> * respect to idle objects - always
returning the most recently used object<a name="line.284"></a>
-<span class="sourceLineNo">285</span> * from the pool, or as a FIFO (first
in, first out) queue, where the pool<a name="line.285"></a>
-<span class="sourceLineNo">286</span> * always returns the oldest object
in the idle object pool.<a name="line.286"></a>
+<span class="sourceLineNo">220</span> protected void setConfig(final
BaseObjectPoolConfig<T> conf) {<a name="line.220"></a>
+<span class="sourceLineNo">221</span> setLifo(conf.getLifo());<a
name="line.221"></a>
+<span class="sourceLineNo">222</span>
setMaxWaitMillis(conf.getMaxWaitMillis());<a name="line.222"></a>
+<span class="sourceLineNo">223</span>
setBlockWhenExhausted(conf.getBlockWhenExhausted());<a name="line.223"></a>
+<span class="sourceLineNo">224</span>
setTestOnCreate(conf.getTestOnCreate());<a name="line.224"></a>
+<span class="sourceLineNo">225</span>
setTestOnBorrow(conf.getTestOnBorrow());<a name="line.225"></a>
+<span class="sourceLineNo">226</span>
setTestOnReturn(conf.getTestOnReturn());<a name="line.226"></a>
+<span class="sourceLineNo">227</span>
setTestWhileIdle(conf.getTestWhileIdle());<a name="line.227"></a>
+<span class="sourceLineNo">228</span>
setNumTestsPerEvictionRun(conf.getNumTestsPerEvictionRun());<a
name="line.228"></a>
+<span class="sourceLineNo">229</span>
setMinEvictableIdleTimeMillis(conf.getMinEvictableIdleTimeMillis());<a
name="line.229"></a>
+<span class="sourceLineNo">230</span>
setTimeBetweenEvictionRunsMillis(conf.getTimeBetweenEvictionRunsMillis());<a
name="line.230"></a>
+<span class="sourceLineNo">231</span>
setSoftMinEvictableIdleTimeMillis(conf.getSoftMinEvictableIdleTimeMillis());<a
name="line.231"></a>
+<span class="sourceLineNo">232</span> final EvictionPolicy<T>
policy = conf.getEvictionPolicy();<a name="line.232"></a>
+<span class="sourceLineNo">233</span> if (policy == null) {<a
name="line.233"></a>
+<span class="sourceLineNo">234</span> // Use the class name
(pre-2.6.0 compatible)<a name="line.234"></a>
+<span class="sourceLineNo">235</span>
setEvictionPolicyClassName(conf.getEvictionPolicyClassName());<a
name="line.235"></a>
+<span class="sourceLineNo">236</span> } else {<a name="line.236"></a>
+<span class="sourceLineNo">237</span> // Otherwise, use the class
(2.6.0 feature)<a name="line.237"></a>
+<span class="sourceLineNo">238</span> setEvictionPolicy(policy);<a
name="line.238"></a>
+<span class="sourceLineNo">239</span> }<a name="line.239"></a>
+<span class="sourceLineNo">240</span>
setEvictorShutdownTimeoutMillis(conf.getEvictorShutdownTimeoutMillis());<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> /**<a name="line.243"></a>
+<span class="sourceLineNo">244</span> * Returns the maximum amount of time
(in milliseconds) the<a name="line.244"></a>
+<span class="sourceLineNo">245</span> *
<code>borrowObject()</code> method should block before throwing
an<a name="line.245"></a>
+<span class="sourceLineNo">246</span> * exception when the pool is
exhausted and<a name="line.246"></a>
+<span class="sourceLineNo">247</span> * {@link #getBlockWhenExhausted} is
true. When less than 0, the<a name="line.247"></a>
+<span class="sourceLineNo">248</span> *
<code>borrowObject()</code> method may block indefinitely.<a
name="line.248"></a>
+<span class="sourceLineNo">249</span> *<a name="line.249"></a>
+<span class="sourceLineNo">250</span> * @return the maximum number of
milliseconds <code>borrowObject()</code><a name="line.250"></a>
+<span class="sourceLineNo">251</span> * will block.<a
name="line.251"></a>
+<span class="sourceLineNo">252</span> *<a name="line.252"></a>
+<span class="sourceLineNo">253</span> * @see #setMaxWaitMillis<a
name="line.253"></a>
+<span class="sourceLineNo">254</span> * @see #setBlockWhenExhausted<a
name="line.254"></a>
+<span class="sourceLineNo">255</span> */<a name="line.255"></a>
+<span class="sourceLineNo">256</span> public final long getMaxWaitMillis()
{<a name="line.256"></a>
+<span class="sourceLineNo">257</span> return maxWaitMillis;<a
name="line.257"></a>
+<span class="sourceLineNo">258</span> }<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> * Sets the maximum amount of time
(in milliseconds) the<a name="line.261"></a>
+<span class="sourceLineNo">262</span> *
<code>borrowObject()</code> method should block before throwing
an<a name="line.262"></a>
+<span class="sourceLineNo">263</span> * exception when the pool is
exhausted and<a name="line.263"></a>
+<span class="sourceLineNo">264</span> * {@link #getBlockWhenExhausted} is
true. When less than 0, the<a name="line.264"></a>
+<span class="sourceLineNo">265</span> *
<code>borrowObject()</code> method may block indefinitely.<a
name="line.265"></a>
+<span class="sourceLineNo">266</span> *<a name="line.266"></a>
+<span class="sourceLineNo">267</span> * @param maxWaitMillis the maximum
number of milliseconds<a name="line.267"></a>
+<span class="sourceLineNo">268</span> *
<code>borrowObject()</code> will block or negative<a
name="line.268"></a>
+<span class="sourceLineNo">269</span> * for
indefinitely.<a name="line.269"></a>
+<span class="sourceLineNo">270</span> *<a name="line.270"></a>
+<span class="sourceLineNo">271</span> * @see #getMaxWaitMillis<a
name="line.271"></a>
+<span class="sourceLineNo">272</span> * @see #setBlockWhenExhausted<a
name="line.272"></a>
+<span class="sourceLineNo">273</span> */<a name="line.273"></a>
+<span class="sourceLineNo">274</span> public final void
setMaxWaitMillis(final long maxWaitMillis) {<a name="line.274"></a>
+<span class="sourceLineNo">275</span> this.maxWaitMillis =
maxWaitMillis;<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> * Returns whether the pool has LIFO
(last in, first out) behaviour with<a name="line.279"></a>
+<span class="sourceLineNo">280</span> * respect to idle objects - always
returning the most recently used object<a name="line.280"></a>
+<span class="sourceLineNo">281</span> * from the pool, or as a FIFO (first
in, first out) queue, where the pool<a name="line.281"></a>
+<span class="sourceLineNo">282</span> * always returns the oldest object
in the idle object pool.<a name="line.282"></a>
+<span class="sourceLineNo">283</span> *<a name="line.283"></a>
+<span class="sourceLineNo">284</span> * @return
<code>true</code> if the pool is configured with LIFO behaviour<a
name="line.284"></a>
+<span class="sourceLineNo">285</span> * or
<code>false</code> if the pool is configured with FIFO<a
name="line.285"></a>
+<span class="sourceLineNo">286</span> * behaviour<a
name="line.286"></a>
<span class="sourceLineNo">287</span> *<a name="line.287"></a>
-<span class="sourceLineNo">288</span> * @param lifo
<code>true</code> if the pool is to be configured with LIFO<a
name="line.288"></a>
-<span class="sourceLineNo">289</span> * behaviour or
<code>false</code> if the pool is to be<a name="line.289"></a>
-<span class="sourceLineNo">290</span> * configured with FIFO
behaviour<a name="line.290"></a>
-<span class="sourceLineNo">291</span> *<a name="line.291"></a>
-<span class="sourceLineNo">292</span> * @see #getLifo()<a
name="line.292"></a>
-<span class="sourceLineNo">293</span> */<a name="line.293"></a>
-<span class="sourceLineNo">294</span> public final void setLifo(final
boolean lifo) {<a name="line.294"></a>
-<span class="sourceLineNo">295</span> this.lifo = lifo;<a
name="line.295"></a>
-<span class="sourceLineNo">296</span> }<a name="line.296"></a>
-<span class="sourceLineNo">297</span><a name="line.297"></a>
-<span class="sourceLineNo">298</span> /**<a name="line.298"></a>
-<span class="sourceLineNo">299</span> * Returns whether objects created
for the pool will be validated before<a name="line.299"></a>
-<span class="sourceLineNo">300</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.300"></a>
-<span class="sourceLineNo">301</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.301"></a>
-<span class="sourceLineNo">302</span> * associated with the pool. If the
object fails to validate, then<a name="line.302"></a>
-<span class="sourceLineNo">303</span> *
<code>borrowObject()</code> will fail.<a name="line.303"></a>
-<span class="sourceLineNo">304</span> *<a name="line.304"></a>
-<span class="sourceLineNo">305</span> * @return
<code>true</code> if newly created objects are validated before<a
name="line.305"></a>
-<span class="sourceLineNo">306</span> * being returned from the
<code>borrowObject()</code> method<a name="line.306"></a>
-<span class="sourceLineNo">307</span> *<a name="line.307"></a>
-<span class="sourceLineNo">308</span> * @see #setTestOnCreate<a
name="line.308"></a>
-<span class="sourceLineNo">309</span> *<a name="line.309"></a>
-<span class="sourceLineNo">310</span> * @since 2.2<a name="line.310"></a>
-<span class="sourceLineNo">311</span> */<a name="line.311"></a>
-<span class="sourceLineNo">312</span> public final boolean
getTestOnCreate() {<a name="line.312"></a>
-<span class="sourceLineNo">313</span> return testOnCreate;<a
name="line.313"></a>
-<span class="sourceLineNo">314</span> }<a name="line.314"></a>
-<span class="sourceLineNo">315</span><a name="line.315"></a>
-<span class="sourceLineNo">316</span> /**<a name="line.316"></a>
-<span class="sourceLineNo">317</span> * Sets whether objects created for
the pool will be validated before<a name="line.317"></a>
-<span class="sourceLineNo">318</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.318"></a>
-<span class="sourceLineNo">319</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.319"></a>
-<span class="sourceLineNo">320</span> * associated with the pool. If the
object fails to validate, then<a name="line.320"></a>
-<span class="sourceLineNo">321</span> *
<code>borrowObject()</code> will fail.<a name="line.321"></a>
-<span class="sourceLineNo">322</span> *<a name="line.322"></a>
-<span class="sourceLineNo">323</span> * @param testOnCreate
<code>true</code> if newly created objects should be<a
name="line.323"></a>
-<span class="sourceLineNo">324</span> * validated
before being returned from the<a name="line.324"></a>
-<span class="sourceLineNo">325</span> *
<code>borrowObject()</code> method<a name="line.325"></a>
-<span class="sourceLineNo">326</span> *<a name="line.326"></a>
-<span class="sourceLineNo">327</span> * @see #getTestOnCreate<a
name="line.327"></a>
-<span class="sourceLineNo">328</span> *<a name="line.328"></a>
-<span class="sourceLineNo">329</span> * @since 2.2<a name="line.329"></a>
-<span class="sourceLineNo">330</span> */<a name="line.330"></a>
-<span class="sourceLineNo">331</span> public final void
setTestOnCreate(final boolean testOnCreate) {<a name="line.331"></a>
-<span class="sourceLineNo">332</span> this.testOnCreate =
testOnCreate;<a name="line.332"></a>
-<span class="sourceLineNo">333</span> }<a name="line.333"></a>
-<span class="sourceLineNo">334</span><a name="line.334"></a>
-<span class="sourceLineNo">335</span> /**<a name="line.335"></a>
-<span class="sourceLineNo">336</span> * Returns whether objects borrowed
from the pool will be validated before<a name="line.336"></a>
-<span class="sourceLineNo">337</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.337"></a>
-<span class="sourceLineNo">338</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.338"></a>
-<span class="sourceLineNo">339</span> * associated with the pool. If the
object fails to validate, it will be<a name="line.339"></a>
-<span class="sourceLineNo">340</span> * removed from the pool and
destroyed, and a new attempt will be made to<a name="line.340"></a>
-<span class="sourceLineNo">341</span> * borrow an object from the pool.<a
name="line.341"></a>
-<span class="sourceLineNo">342</span> *<a name="line.342"></a>
-<span class="sourceLineNo">343</span> * @return
<code>true</code> if objects are validated before being returned<a
name="line.343"></a>
-<span class="sourceLineNo">344</span> * from the
<code>borrowObject()</code> method<a name="line.344"></a>
+<span class="sourceLineNo">288</span> * @see #setLifo<a
name="line.288"></a>
+<span class="sourceLineNo">289</span> */<a name="line.289"></a>
+<span class="sourceLineNo">290</span> public final boolean getLifo() {<a
name="line.290"></a>
+<span class="sourceLineNo">291</span> return lifo;<a
name="line.291"></a>
+<span class="sourceLineNo">292</span> }<a name="line.292"></a>
+<span class="sourceLineNo">293</span><a name="line.293"></a>
+<span class="sourceLineNo">294</span> /**<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * Returns whether or not the pool
serves threads waiting to borrow objects fairly.<a name="line.295"></a>
+<span class="sourceLineNo">296</span> * True means that waiting threads
are served as if waiting in a FIFO queue.<a name="line.296"></a>
+<span class="sourceLineNo">297</span> *<a name="line.297"></a>
+<span class="sourceLineNo">298</span> * @return
<code>true</code> if waiting threads are to be served<a
name="line.298"></a>
+<span class="sourceLineNo">299</span> * by the pool in arrival
order<a name="line.299"></a>
+<span class="sourceLineNo">300</span> */<a name="line.300"></a>
+<span class="sourceLineNo">301</span> public final boolean getFairness()
{<a name="line.301"></a>
+<span class="sourceLineNo">302</span> return fairness;<a
name="line.302"></a>
+<span class="sourceLineNo">303</span> }<a name="line.303"></a>
+<span class="sourceLineNo">304</span><a name="line.304"></a>
+<span class="sourceLineNo">305</span> /**<a name="line.305"></a>
+<span class="sourceLineNo">306</span> * Sets whether the pool has LIFO
(last in, first out) behaviour with<a name="line.306"></a>
+<span class="sourceLineNo">307</span> * respect to idle objects - always
returning the most recently used object<a name="line.307"></a>
+<span class="sourceLineNo">308</span> * from the pool, or as a FIFO (first
in, first out) queue, where the pool<a name="line.308"></a>
+<span class="sourceLineNo">309</span> * always returns the oldest object
in the idle object pool.<a name="line.309"></a>
+<span class="sourceLineNo">310</span> *<a name="line.310"></a>
+<span class="sourceLineNo">311</span> * @param lifo
<code>true</code> if the pool is to be configured with LIFO<a
name="line.311"></a>
+<span class="sourceLineNo">312</span> * behaviour or
<code>false</code> if the pool is to be<a name="line.312"></a>
+<span class="sourceLineNo">313</span> * configured with FIFO
behaviour<a name="line.313"></a>
+<span class="sourceLineNo">314</span> *<a name="line.314"></a>
+<span class="sourceLineNo">315</span> * @see #getLifo()<a
name="line.315"></a>
+<span class="sourceLineNo">316</span> */<a name="line.316"></a>
+<span class="sourceLineNo">317</span> public final void setLifo(final
boolean lifo) {<a name="line.317"></a>
+<span class="sourceLineNo">318</span> this.lifo = lifo;<a
name="line.318"></a>
+<span class="sourceLineNo">319</span> }<a name="line.319"></a>
+<span class="sourceLineNo">320</span><a name="line.320"></a>
+<span class="sourceLineNo">321</span> /**<a name="line.321"></a>
+<span class="sourceLineNo">322</span> * Returns whether objects created
for the pool will be validated before<a name="line.322"></a>
+<span class="sourceLineNo">323</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.323"></a>
+<span class="sourceLineNo">324</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.324"></a>
+<span class="sourceLineNo">325</span> * associated with the pool. If the
object fails to validate, then<a name="line.325"></a>
+<span class="sourceLineNo">326</span> *
<code>borrowObject()</code> will fail.<a name="line.326"></a>
+<span class="sourceLineNo">327</span> *<a name="line.327"></a>
+<span class="sourceLineNo">328</span> * @return
<code>true</code> if newly created objects are validated before<a
name="line.328"></a>
+<span class="sourceLineNo">329</span> * being returned from the
<code>borrowObject()</code> method<a name="line.329"></a>
+<span class="sourceLineNo">330</span> *<a name="line.330"></a>
+<span class="sourceLineNo">331</span> * @see #setTestOnCreate<a
name="line.331"></a>
+<span class="sourceLineNo">332</span> *<a name="line.332"></a>
+<span class="sourceLineNo">333</span> * @since 2.2<a name="line.333"></a>
+<span class="sourceLineNo">334</span> */<a name="line.334"></a>
+<span class="sourceLineNo">335</span> public final boolean
getTestOnCreate() {<a name="line.335"></a>
+<span class="sourceLineNo">336</span> return testOnCreate;<a
name="line.336"></a>
+<span class="sourceLineNo">337</span> }<a name="line.337"></a>
+<span class="sourceLineNo">338</span><a name="line.338"></a>
+<span class="sourceLineNo">339</span> /**<a name="line.339"></a>
+<span class="sourceLineNo">340</span> * Sets whether objects created for
the pool will be validated before<a name="line.340"></a>
+<span class="sourceLineNo">341</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.341"></a>
+<span class="sourceLineNo">342</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.342"></a>
+<span class="sourceLineNo">343</span> * associated with the pool. If the
object fails to validate, then<a name="line.343"></a>
+<span class="sourceLineNo">344</span> *
<code>borrowObject()</code> will fail.<a name="line.344"></a>
<span class="sourceLineNo">345</span> *<a name="line.345"></a>
-<span class="sourceLineNo">346</span> * @see #setTestOnBorrow<a
name="line.346"></a>
-<span class="sourceLineNo">347</span> */<a name="line.347"></a>
-<span class="sourceLineNo">348</span> public final boolean
getTestOnBorrow() {<a name="line.348"></a>
-<span class="sourceLineNo">349</span> return testOnBorrow;<a
name="line.349"></a>
-<span class="sourceLineNo">350</span> }<a name="line.350"></a>
-<span class="sourceLineNo">351</span><a name="line.351"></a>
-<span class="sourceLineNo">352</span> /**<a name="line.352"></a>
-<span class="sourceLineNo">353</span> * Sets whether objects borrowed from
the pool will be validated before<a name="line.353"></a>
-<span class="sourceLineNo">354</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.354"></a>
-<span class="sourceLineNo">355</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.355"></a>
-<span class="sourceLineNo">356</span> * associated with the pool. If the
object fails to validate, it will be<a name="line.356"></a>
-<span class="sourceLineNo">357</span> * removed from the pool and
destroyed, and a new attempt will be made to<a name="line.357"></a>
-<span class="sourceLineNo">358</span> * borrow an object from the pool.<a
name="line.358"></a>
-<span class="sourceLineNo">359</span> *<a name="line.359"></a>
-<span class="sourceLineNo">360</span> * @param testOnBorrow
<code>true</code> if objects should be validated<a
name="line.360"></a>
-<span class="sourceLineNo">361</span> * before being
returned from the<a name="line.361"></a>
-<span class="sourceLineNo">362</span> *
<code>borrowObject()</code> method<a name="line.362"></a>
-<span class="sourceLineNo">363</span> *<a name="line.363"></a>
-<span class="sourceLineNo">364</span> * @see #getTestOnBorrow<a
name="line.364"></a>
-<span class="sourceLineNo">365</span> */<a name="line.365"></a>
-<span class="sourceLineNo">366</span> public final void
setTestOnBorrow(final boolean testOnBorrow) {<a name="line.366"></a>
-<span class="sourceLineNo">367</span> this.testOnBorrow =
testOnBorrow;<a name="line.367"></a>
-<span class="sourceLineNo">368</span> }<a name="line.368"></a>
-<span class="sourceLineNo">369</span><a name="line.369"></a>
-<span class="sourceLineNo">370</span> /**<a name="line.370"></a>
-<span class="sourceLineNo">371</span> * Returns whether objects borrowed
from the pool will be validated when<a name="line.371"></a>
-<span class="sourceLineNo">372</span> * they are returned to the pool via
the <code>returnObject()</code> method.<a name="line.372"></a>
-<span class="sourceLineNo">373</span> * Validation is performed by the
<code>validateObject()</code> method of<a name="line.373"></a>
-<span class="sourceLineNo">374</span> * the factory associated with the
pool. Returning objects that fail validation<a name="line.374"></a>
-<span class="sourceLineNo">375</span> * are destroyed rather then being
returned the pool.<a name="line.375"></a>
-<span class="sourceLineNo">376</span> *<a name="line.376"></a>
-<span class="sourceLineNo">377</span> * @return
<code>true</code> if objects are validated on return to<a
name="line.377"></a>
-<span class="sourceLineNo">378</span> * the pool via the
<code>returnObject()</code> method<a name="line.378"></a>
-<span class="sourceLineNo">379</span> *<a name="line.379"></a>
-<span class="sourceLineNo">380</span> * @see #setTestOnReturn<a
name="line.380"></a>
-<span class="sourceLineNo">381</span> */<a name="line.381"></a>
-<span class="sourceLineNo">382</span> public final boolean
getTestOnReturn() {<a name="line.382"></a>
-<span class="sourceLineNo">383</span> return testOnReturn;<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> /**<a name="line.386"></a>
-<span class="sourceLineNo">387</span> * Sets whether objects borrowed from
the pool will be validated when<a name="line.387"></a>
-<span class="sourceLineNo">388</span> * they are returned to the pool via
the <code>returnObject()</code> method.<a name="line.388"></a>
-<span class="sourceLineNo">389</span> * Validation is performed by the
<code>validateObject()</code> method of<a name="line.389"></a>
-<span class="sourceLineNo">390</span> * the factory associated with the
pool. Returning objects that fail validation<a name="line.390"></a>
-<span class="sourceLineNo">391</span> * are destroyed rather then being
returned the pool.<a name="line.391"></a>
-<span class="sourceLineNo">392</span> *<a name="line.392"></a>
-<span class="sourceLineNo">393</span> * @param testOnReturn
<code>true</code> if objects are validated on<a name="line.393"></a>
-<span class="sourceLineNo">394</span> * return to the
pool via the<a name="line.394"></a>
-<span class="sourceLineNo">395</span> *
<code>returnObject()</code> method<a name="line.395"></a>
-<span class="sourceLineNo">396</span> *<a name="line.396"></a>
-<span class="sourceLineNo">397</span> * @see #getTestOnReturn<a
name="line.397"></a>
-<span class="sourceLineNo">398</span> */<a name="line.398"></a>
-<span class="sourceLineNo">399</span> public final void
setTestOnReturn(final boolean testOnReturn) {<a name="line.399"></a>
-<span class="sourceLineNo">400</span> this.testOnReturn =
testOnReturn;<a name="line.400"></a>
-<span class="sourceLineNo">401</span> }<a name="line.401"></a>
-<span class="sourceLineNo">402</span><a name="line.402"></a>
-<span class="sourceLineNo">403</span> /**<a name="line.403"></a>
-<span class="sourceLineNo">404</span> * Returns whether objects sitting
idle in the pool will be validated by the<a name="line.404"></a>
-<span class="sourceLineNo">405</span> * idle object evictor (if any -
see<a name="line.405"></a>
-<span class="sourceLineNo">406</span> * {@link
#setTimeBetweenEvictionRunsMillis(long)}). Validation is performed<a
name="line.406"></a>
-<span class="sourceLineNo">407</span> * by the
<code>validateObject()</code> method of the factory associated<a
name="line.407"></a>
-<span class="sourceLineNo">408</span> * with the pool. If the object fails
to validate, it will be removed from<a name="line.408"></a>
-<span class="sourceLineNo">409</span> * the pool and destroyed.<a
name="line.409"></a>
-<span class="sourceLineNo">410</span> *<a name="line.410"></a>
-<span class="sourceLineNo">411</span> * @return
<code>true</code> if objects will be validated by the evictor<a
name="line.411"></a>
-<span class="sourceLineNo">412</span> *<a name="line.412"></a>
-<span class="sourceLineNo">413</span> * @see #setTestWhileIdle<a
name="line.413"></a>
-<span class="sourceLineNo">414</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.414"></a>
-<span class="sourceLineNo">415</span> */<a name="line.415"></a>
-<span class="sourceLineNo">416</span> public final boolean
getTestWhileIdle() {<a name="line.416"></a>
-<span class="sourceLineNo">417</span> return testWhileIdle;<a
name="line.417"></a>
-<span class="sourceLineNo">418</span> }<a name="line.418"></a>
-<span class="sourceLineNo">419</span><a name="line.419"></a>
-<span class="sourceLineNo">420</span> /**<a name="line.420"></a>
-<span class="sourceLineNo">421</span> * Returns whether objects sitting
idle in the pool will be validated by the<a name="line.421"></a>
-<span class="sourceLineNo">422</span> * idle object evictor (if any -
see<a name="line.422"></a>
-<span class="sourceLineNo">423</span> * {@link
#setTimeBetweenEvictionRunsMillis(long)}). Validation is performed<a
name="line.423"></a>
-<span class="sourceLineNo">424</span> * by the
<code>validateObject()</code> method of the factory associated<a
name="line.424"></a>
-<span class="sourceLineNo">425</span> * with the pool. If the object fails
to validate, it will be removed from<a name="line.425"></a>
-<span class="sourceLineNo">426</span> * the pool and destroyed. Note that
setting this property has no effect<a name="line.426"></a>
-<span class="sourceLineNo">427</span> * unless the idle object evictor is
enabled by setting<a name="line.427"></a>
-<span class="sourceLineNo">428</span> *
<code>timeBetweenEvictionRunsMillis</code> to a positive value.<a
name="line.428"></a>
-<span class="sourceLineNo">429</span> *<a name="line.429"></a>
-<span class="sourceLineNo">430</span> * @param testWhileIdle<a
name="line.430"></a>
-<span class="sourceLineNo">431</span> *
<code>true</code> so objects will be validated by the evictor<a
name="line.431"></a>
-<span class="sourceLineNo">432</span> *<a name="line.432"></a>
-<span class="sourceLineNo">433</span> * @see #getTestWhileIdle<a
name="line.433"></a>
-<span class="sourceLineNo">434</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.434"></a>
-<span class="sourceLineNo">435</span> */<a name="line.435"></a>
-<span class="sourceLineNo">436</span> public final void
setTestWhileIdle(final boolean testWhileIdle) {<a name="line.436"></a>
-<span class="sourceLineNo">437</span> this.testWhileIdle =
testWhileIdle;<a name="line.437"></a>
-<span class="sourceLineNo">438</span> }<a name="line.438"></a>
-<span class="sourceLineNo">439</span><a name="line.439"></a>
-<span class="sourceLineNo">440</span> /**<a name="line.440"></a>
-<span class="sourceLineNo">441</span> * Returns the number of milliseconds
to sleep between runs of the idle<a name="line.441"></a>
-<span class="sourceLineNo">442</span> * object evictor thread. When
non-positive, no idle object evictor thread<a name="line.442"></a>
-<span class="sourceLineNo">443</span> * will be run.<a name="line.443"></a>
-<span class="sourceLineNo">444</span> *<a name="line.444"></a>
-<span class="sourceLineNo">445</span> * @return number of milliseconds to
sleep between evictor runs<a name="line.445"></a>
-<span class="sourceLineNo">446</span> *<a name="line.446"></a>
-<span class="sourceLineNo">447</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.447"></a>
-<span class="sourceLineNo">448</span> */<a name="line.448"></a>
-<span class="sourceLineNo">449</span> public final long
getTimeBetweenEvictionRunsMillis() {<a name="line.449"></a>
-<span class="sourceLineNo">450</span> return
timeBetweenEvictionRunsMillis;<a name="line.450"></a>
-<span class="sourceLineNo">451</span> }<a name="line.451"></a>
-<span class="sourceLineNo">452</span><a name="line.452"></a>
-<span class="sourceLineNo">453</span> /**<a name="line.453"></a>
-<span class="sourceLineNo">454</span> * Sets the number of milliseconds to
sleep between runs of the idle object evictor thread.<a name="line.454"></a>
-<span class="sourceLineNo">455</span> * <ul><a name="line.455"></a>
-<span class="sourceLineNo">456</span> * <li>When positive, the idle
object evictor thread starts.</li><a name="line.456"></a>
-<span class="sourceLineNo">457</span> * <li>When non-positive, no
idle object evictor thread runs.</li><a name="line.457"></a>
-<span class="sourceLineNo">458</span> * </ul><a name="line.458"></a>
-<span class="sourceLineNo">459</span> *<a name="line.459"></a>
-<span class="sourceLineNo">460</span> * @param
timeBetweenEvictionRunsMillis<a name="line.460"></a>
-<span class="sourceLineNo">461</span> * number of milliseconds
to sleep between evictor runs<a name="line.461"></a>
-<span class="sourceLineNo">462</span> *<a name="line.462"></a>
-<span class="sourceLineNo">463</span> * @see
#getTimeBetweenEvictionRunsMillis<a name="line.463"></a>
-<span class="sourceLineNo">464</span> */<a name="line.464"></a>
-<span class="sourceLineNo">465</span> public final void
setTimeBetweenEvictionRunsMillis(<a name="line.465"></a>
-<span class="sourceLineNo">466</span> final long
timeBetweenEvictionRunsMillis) {<a name="line.466"></a>
-<span class="sourceLineNo">467</span>
this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis;<a
name="line.467"></a>
-<span class="sourceLineNo">468</span>
startEvictor(timeBetweenEvictionRunsMillis);<a name="line.468"></a>
-<span class="sourceLineNo">469</span> }<a name="line.469"></a>
-<span class="sourceLineNo">470</span><a name="line.470"></a>
-<span class="sourceLineNo">471</span> /**<a name="line.471"></a>
-<span class="sourceLineNo">472</span> * Returns the maximum number of
objects to examine during each run (if any)<a name="line.472"></a>
-<span class="sourceLineNo">473</span> * of the idle object evictor thread.
When positive, the number of tests<a name="line.473"></a>
-<span class="sourceLineNo">474</span> * performed for a run will be the
minimum of the configured value and the<a name="line.474"></a>
-<span class="sourceLineNo">475</span> * number of idle instances in the
pool. When negative, the number of tests<a name="line.475"></a>
-<span class="sourceLineNo">476</span> * performed will be
<code>ceil({@link #getNumIdle}/<a name="line.476"></a>
-<span class="sourceLineNo">477</span> * abs({@link
#getNumTestsPerEvictionRun}))</code> which means that when the<a
name="line.477"></a>
-<span class="sourceLineNo">478</span> * value is
<code>-n</code> roughly one nth of the idle objects will be<a
name="line.478"></a>
-<span class="sourceLineNo">479</span> * tested per run.<a
name="line.479"></a>
-<span class="sourceLineNo">480</span> *<a name="line.480"></a>
-<span class="sourceLineNo">481</span> * @return max number of objects to
examine during each evictor run<a name="line.481"></a>
+<span class="sourceLineNo">346</span> * @param testOnCreate
<code>true</code> if newly created objects should be<a
name="line.346"></a>
+<span class="sourceLineNo">347</span> * validated
before being returned from the<a name="line.347"></a>
+<span class="sourceLineNo">348</span> *
<code>borrowObject()</code> method<a name="line.348"></a>
+<span class="sourceLineNo">349</span> *<a name="line.349"></a>
+<span class="sourceLineNo">350</span> * @see #getTestOnCreate<a
name="line.350"></a>
+<span class="sourceLineNo">351</span> *<a name="line.351"></a>
+<span class="sourceLineNo">352</span> * @since 2.2<a name="line.352"></a>
+<span class="sourceLineNo">353</span> */<a name="line.353"></a>
+<span class="sourceLineNo">354</span> public final void
setTestOnCreate(final boolean testOnCreate) {<a name="line.354"></a>
+<span class="sourceLineNo">355</span> this.testOnCreate =
testOnCreate;<a name="line.355"></a>
+<span class="sourceLineNo">356</span> }<a name="line.356"></a>
+<span class="sourceLineNo">357</span><a name="line.357"></a>
+<span class="sourceLineNo">358</span> /**<a name="line.358"></a>
+<span class="sourceLineNo">359</span> * Returns whether objects borrowed
from the pool will be validated before<a name="line.359"></a>
+<span class="sourceLineNo">360</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.360"></a>
+<span class="sourceLineNo">361</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.361"></a>
+<span class="sourceLineNo">362</span> * associated with the pool. If the
object fails to validate, it will be<a name="line.362"></a>
+<span class="sourceLineNo">363</span> * removed from the pool and
destroyed, and a new attempt will be made to<a name="line.363"></a>
+<span class="sourceLineNo">364</span> * borrow an object from the pool.<a
name="line.364"></a>
+<span class="sourceLineNo">365</span> *<a name="line.365"></a>
+<span class="sourceLineNo">366</span> * @return
<code>true</code> if objects are validated before being returned<a
name="line.366"></a>
+<span class="sourceLineNo">367</span> * from the
<code>borrowObject()</code> method<a name="line.367"></a>
+<span class="sourceLineNo">368</span> *<a name="line.368"></a>
+<span class="sourceLineNo">369</span> * @see #setTestOnBorrow<a
name="line.369"></a>
+<span class="sourceLineNo">370</span> */<a name="line.370"></a>
+<span class="sourceLineNo">371</span> public final boolean
getTestOnBorrow() {<a name="line.371"></a>
+<span class="sourceLineNo">372</span> return testOnBorrow;<a
name="line.372"></a>
+<span class="sourceLineNo">373</span> }<a name="line.373"></a>
+<span class="sourceLineNo">374</span><a name="line.374"></a>
+<span class="sourceLineNo">375</span> /**<a name="line.375"></a>
+<span class="sourceLineNo">376</span> * Sets whether objects borrowed from
the pool will be validated before<a name="line.376"></a>
+<span class="sourceLineNo">377</span> * being returned from the
<code>borrowObject()</code> method. Validation is<a
name="line.377"></a>
+<span class="sourceLineNo">378</span> * performed by the
<code>validateObject()</code> method of the factory<a
name="line.378"></a>
+<span class="sourceLineNo">379</span> * associated with the pool. If the
object fails to validate, it will be<a name="line.379"></a>
+<span class="sourceLineNo">380</span> * removed from the pool and
destroyed, and a new attempt will be made to<a name="line.380"></a>
+<span class="sourceLineNo">381</span> * borrow an object from the pool.<a
name="line.381"></a>
+<span class="sourceLineNo">382</span> *<a name="line.382"></a>
+<span class="sourceLineNo">383</span> * @param testOnBorrow
<code>true</code> if objects should be validated<a
name="line.383"></a>
+<span class="sourceLineNo">384</span> * before being
returned from the<a name="line.384"></a>
+<span class="sourceLineNo">385</span> *
<code>borrowObject()</code> method<a name="line.385"></a>
+<span class="sourceLineNo">386</span> *<a name="line.386"></a>
+<span class="sourceLineNo">387</span> * @see #getTestOnBorrow<a
name="line.387"></a>
+<span class="sourceLineNo">388</span> */<a name="line.388"></a>
+<span class="sourceLineNo">389</span> public final void
setTestOnBorrow(final boolean testOnBorrow) {<a name="line.389"></a>
+<span class="sourceLineNo">390</span> this.testOnBorrow =
testOnBorrow;<a name="line.390"></a>
+<span class="sourceLineNo">391</span> }<a name="line.391"></a>
+<span class="sourceLineNo">392</span><a name="line.392"></a>
+<span class="sourceLineNo">393</span> /**<a name="line.393"></a>
+<span class="sourceLineNo">394</span> * Returns whether objects borrowed
from the pool will be validated when<a name="line.394"></a>
+<span class="sourceLineNo">395</span> * they are returned to the pool via
the <code>returnObject()</code> method.<a name="line.395"></a>
+<span class="sourceLineNo">396</span> * Validation is performed by the
<code>validateObject()</code> method of<a name="line.396"></a>
+<span class="sourceLineNo">397</span> * the factory associated with the
pool. Returning objects that fail validation<a name="line.397"></a>
+<span class="sourceLineNo">398</span> * are destroyed rather then being
returned the pool.<a name="line.398"></a>
+<span class="sourceLineNo">399</span> *<a name="line.399"></a>
+<span class="sourceLineNo">400</span> * @return
<code>true</code> if objects are validated on return to<a
name="line.400"></a>
+<span class="sourceLineNo">401</span> * the pool via the
<code>returnObject()</code> method<a name="line.401"></a>
+<span class="sourceLineNo">402</span> *<a name="line.402"></a>
+<span class="sourceLineNo">403</span> * @see #setTestOnReturn<a
name="line.403"></a>
+<span class="sourceLineNo">404</span> */<a name="line.404"></a>
+<span class="sourceLineNo">405</span> public final boolean
getTestOnReturn() {<a name="line.405"></a>
+<span class="sourceLineNo">406</span> return testOnReturn;<a
name="line.406"></a>
+<span class="sourceLineNo">407</span> }<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> * Sets whether objects borrowed from
the pool will be validated when<a name="line.410"></a>
+<span class="sourceLineNo">411</span> * they are returned to the pool via
the <code>returnObject()</code> method.<a name="line.411"></a>
+<span class="sourceLineNo">412</span> * Validation is performed by the
<code>validateObject()</code> method of<a name="line.412"></a>
+<span class="sourceLineNo">413</span> * the factory associated with the
pool. Returning objects that fail validation<a name="line.413"></a>
+<span class="sourceLineNo">414</span> * are destroyed rather then being
returned the pool.<a name="line.414"></a>
+<span class="sourceLineNo">415</span> *<a name="line.415"></a>
+<span class="sourceLineNo">416</span> * @param testOnReturn
<code>true</code> if objects are validated on<a name="line.416"></a>
+<span class="sourceLineNo">417</span> * return to the
pool via the<a name="line.417"></a>
+<span class="sourceLineNo">418</span> *
<code>returnObject()</code> method<a name="line.418"></a>
+<span class="sourceLineNo">419</span> *<a name="line.419"></a>
+<span class="sourceLineNo">420</span> * @see #getTestOnReturn<a
name="line.420"></a>
+<span class="sourceLineNo">421</span> */<a name="line.421"></a>
+<span class="sourceLineNo">422</span> public final void
setTestOnReturn(final boolean testOnReturn) {<a name="line.422"></a>
+<span class="sourceLineNo">423</span> this.testOnReturn =
testOnReturn;<a name="line.423"></a>
+<span class="sourceLineNo">424</span> }<a name="line.424"></a>
+<span class="sourceLineNo">425</span><a name="line.425"></a>
+<span class="sourceLineNo">426</span> /**<a name="line.426"></a>
+<span class="sourceLineNo">427</span> * Returns whether objects sitting
idle in the pool will be validated by the<a name="line.427"></a>
+<span class="sourceLineNo">428</span> * idle object evictor (if any -
see<a name="line.428"></a>
+<span class="sourceLineNo">429</span> * {@link
#setTimeBetweenEvictionRunsMillis(long)}). Validation is performed<a
name="line.429"></a>
+<span class="sourceLineNo">430</span> * by the
<code>validateObject()</code> method of the factory associated<a
name="line.430"></a>
+<span class="sourceLineNo">431</span> * with the pool. If the object fails
to validate, it will be removed from<a name="line.431"></a>
+<span class="sourceLineNo">432</span> * the pool and destroyed.<a
name="line.432"></a>
+<span class="sourceLineNo">433</span> *<a name="line.433"></a>
+<span class="sourceLineNo">434</span> * @return
<code>true</code> if objects will be validated by the evictor<a
name="line.434"></a>
+<span class="sourceLineNo">435</span> *<a name="line.435"></a>
+<span class="sourceLineNo">436</span> * @see #setTestWhileIdle<a
name="line.436"></a>
+<span class="sourceLineNo">437</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.437"></a>
+<span class="sourceLineNo">438</span> */<a name="line.438"></a>
+<span class="sourceLineNo">439</span> public final boolean
getTestWhileIdle() {<a name="line.439"></a>
+<span class="sourceLineNo">440</span> return testWhileIdle;<a
name="line.440"></a>
+<span class="sourceLineNo">441</span> }<a name="line.441"></a>
+<span class="sourceLineNo">442</span><a name="line.442"></a>
+<span class="sourceLineNo">443</span> /**<a name="line.443"></a>
+<span class="sourceLineNo">444</span> * Returns whether objects sitting
idle in the pool will be validated by the<a name="line.444"></a>
+<span class="sourceLineNo">445</span> * idle object evictor (if any -
see<a name="line.445"></a>
+<span class="sourceLineNo">446</span> * {@link
#setTimeBetweenEvictionRunsMillis(long)}). Validation is performed<a
name="line.446"></a>
+<span class="sourceLineNo">447</span> * by the
<code>validateObject()</code> method of the factory associated<a
name="line.447"></a>
+<span class="sourceLineNo">448</span> * with the pool. If the object fails
to validate, it will be removed from<a name="line.448"></a>
+<span class="sourceLineNo">449</span> * the pool and destroyed. Note that
setting this property has no effect<a name="line.449"></a>
+<span class="sourceLineNo">450</span> * unless the idle object evictor is
enabled by setting<a name="line.450"></a>
+<span class="sourceLineNo">451</span> *
<code>timeBetweenEvictionRunsMillis</code> to a positive value.<a
name="line.451"></a>
+<span class="sourceLineNo">452</span> *<a name="line.452"></a>
+<span class="sourceLineNo">453</span> * @param testWhileIdle<a
name="line.453"></a>
+<span class="sourceLineNo">454</span> *
<code>true</code> so objects will be validated by the evictor<a
name="line.454"></a>
+<span class="sourceLineNo">455</span> *<a name="line.455"></a>
+<span class="sourceLineNo">456</span> * @see #getTestWhileIdle<a
name="line.456"></a>
+<span class="sourceLineNo">457</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.457"></a>
+<span class="sourceLineNo">458</span> */<a name="line.458"></a>
+<span class="sourceLineNo">459</span> public final void
setTestWhileIdle(final boolean testWhileIdle) {<a name="line.459"></a>
+<span class="sourceLineNo">460</span> this.testWhileIdle =
testWhileIdle;<a name="line.460"></a>
+<span class="sourceLineNo">461</span> }<a name="line.461"></a>
+<span class="sourceLineNo">462</span><a name="line.462"></a>
+<span class="sourceLineNo">463</span> /**<a name="line.463"></a>
+<span class="sourceLineNo">464</span> * Returns the number of milliseconds
to sleep between runs of the idle<a name="line.464"></a>
+<span class="sourceLineNo">465</span> * object evictor thread. When
non-positive, no idle object evictor thread<a name="line.465"></a>
+<span class="sourceLineNo">466</span> * will be run.<a name="line.466"></a>
+<span class="sourceLineNo">467</span> *<a name="line.467"></a>
+<span class="sourceLineNo">468</span> * @return number of milliseconds to
sleep between evictor runs<a name="line.468"></a>
+<span class="sourceLineNo">469</span> *<a name="line.469"></a>
+<span class="sourceLineNo">470</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.470"></a>
+<span class="sourceLineNo">471</span> */<a name="line.471"></a>
+<span class="sourceLineNo">472</span> public final long
getTimeBetweenEvictionRunsMillis() {<a name="line.472"></a>
+<span class="sourceLineNo">473</span> return
timeBetweenEvictionRunsMillis;<a name="line.473"></a>
+<span class="sourceLineNo">474</span> }<a name="line.474"></a>
+<span class="sourceLineNo">475</span><a name="line.475"></a>
+<span class="sourceLineNo">476</span> /**<a name="line.476"></a>
+<span class="sourceLineNo">477</span> * Sets the number of milliseconds to
sleep between runs of the idle object evictor thread.<a name="line.477"></a>
+<span class="sourceLineNo">478</span> * <ul><a name="line.478"></a>
+<span class="sourceLineNo">479</span> * <li>When positive, the idle
object evictor thread starts.</li><a name="line.479"></a>
+<span class="sourceLineNo">480</span> * <li>When non-positive, no
idle object evictor thread runs.</li><a name="line.480"></a>
+<span class="sourceLineNo">481</span> * </ul><a name="line.481"></a>
<span class="sourceLineNo">482</span> *<a name="line.482"></a>
-<span class="sourceLineNo">483</span> * @see #setNumTestsPerEvictionRun<a
name="line.483"></a>
-<span class="sourceLineNo">484</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.484"></a>
-<span class="sourceLineNo">485</span> */<a name="line.485"></a>
-<span class="sourceLineNo">486</span> public final int
getNumTestsPerEvictionRun() {<a name="line.486"></a>
-<span class="sourceLineNo">487</span> return numTestsPerEvictionRun;<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> * Sets the maximum number of objects
to examine during each run (if any)<a name="line.491"></a>
-<span class="sourceLineNo">492</span> * of the idle object evictor thread.
When positive, the number of tests<a name="line.492"></a>
-<span class="sourceLineNo">493</span> * performed for a run will be the
minimum of the configured value and the<a name="line.493"></a>
-<span class="sourceLineNo">494</span> * number of idle instances in the
pool. When negative, the number of tests<a name="line.494"></a>
-<span class="sourceLineNo">495</span> * performed will be
<code>ceil({@link #getNumIdle}/<a name="line.495"></a>
-<span class="sourceLineNo">496</span> * abs({@link
#getNumTestsPerEvictionRun}))</code> which means that when the<a
name="line.496"></a>
-<span class="sourceLineNo">497</span> * value is
<code>-n</code> roughly one nth of the idle objects will be<a
name="line.497"></a>
-<span class="sourceLineNo">498</span> * tested per run.<a
name="line.498"></a>
-<span class="sourceLineNo">499</span> *<a name="line.499"></a>
-<span class="sourceLineNo">500</span> * @param numTestsPerEvictionRun<a
name="line.500"></a>
-<span class="sourceLineNo">501</span> * max number of objects
to examine during each evictor run<a name="line.501"></a>
-<span class="sourceLineNo">502</span> *<a name="line.502"></a>
-<span class="sourceLineNo">503</span> * @see #getNumTestsPerEvictionRun<a
name="line.503"></a>
-<span class="sourceLineNo">504</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.504"></a>
-<span class="sourceLineNo">505</span> */<a name="line.505"></a>
-<span class="sourceLineNo">506</span> public final void
setNumTestsPerEvictionRun(final int numTestsPerEvictionRun) {<a
name="line.506"></a>
-<span class="sourceLineNo">507</span> this.numTestsPerEvictionRun =
numTestsPerEvictionRun;<a name="line.507"></a>
-<span class="sourceLineNo">508</span> }<a name="line.508"></a>
-<span class="sourceLineNo">509</span><a name="line.509"></a>
-<span class="sourceLineNo">510</span> /**<a name="line.510"></a>
-<span class="sourceLineNo">511</span> * Returns the minimum amount of time
an object may sit idle in the pool<a name="line.511"></a>
-<span class="sourceLineNo">512</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.512"></a>
-<span class="sourceLineNo">513</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}). When non-positive,<a
name="line.513"></a>
-<span class="sourceLineNo">514</span> * no objects will be evicted from
the pool due to idle time alone.<a name="line.514"></a>
-<span class="sourceLineNo">515</span> *<a name="line.515"></a>
-<span class="sourceLineNo">516</span> * @return minimum amount of time an
object may sit idle in the pool before<a name="line.516"></a>
-<span class="sourceLineNo">517</span> * it is eligible for
eviction<a name="line.517"></a>
-<span class="sourceLineNo">518</span> *<a name="line.518"></a>
-<span class="sourceLineNo">519</span> * @see
#setMinEvictableIdleTimeMillis<a name="line.519"></a>
-<span class="sourceLineNo">520</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.520"></a>
-<span class="sourceLineNo">521</span> */<a name="line.521"></a>
-<span class="sourceLineNo">522</span> public final long
getMinEvictableIdleTimeMillis() {<a name="line.522"></a>
-<span class="sourceLineNo">523</span> return
minEvictableIdleTimeMillis;<a name="line.523"></a>
-<span class="sourceLineNo">524</span> }<a name="line.524"></a>
-<span class="sourceLineNo">525</span><a name="line.525"></a>
-<span class="sourceLineNo">526</span> /**<a name="line.526"></a>
-<span class="sourceLineNo">527</span> * Sets the minimum amount of time an
object may sit idle in the pool<a name="line.527"></a>
-<span class="sourceLineNo">528</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.528"></a>
-<span class="sourceLineNo">529</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}). When non-positive,<a
name="line.529"></a>
-<span class="sourceLineNo">530</span> * no objects will be evicted from
the pool due to idle time alone.<a name="line.530"></a>
-<span class="sourceLineNo">531</span> *<a name="line.531"></a>
-<span class="sourceLineNo">532</span> * @param
minEvictableIdleTimeMillis<a name="line.532"></a>
-<span class="sourceLineNo">533</span> * minimum amount of time
an object may sit idle in the pool<a name="line.533"></a>
-<span class="sourceLineNo">534</span> * before it is eligible
for eviction<a name="line.534"></a>
-<span class="sourceLineNo">535</span> *<a name="line.535"></a>
-<span class="sourceLineNo">536</span> * @see
#getMinEvictableIdleTimeMillis<a name="line.536"></a>
-<span class="sourceLineNo">537</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.537"></a>
-<span class="sourceLineNo">538</span> */<a name="line.538"></a>
-<span class="sourceLineNo">539</span> public final void
setMinEvictableIdleTimeMillis(<a name="line.539"></a>
-<span class="sourceLineNo">540</span> final long
minEvictableIdleTimeMillis) {<a name="line.540"></a>
-<span class="sourceLineNo">541</span> this.minEvictableIdleTimeMillis =
minEvictableIdleTimeMillis;<a name="line.541"></a>
-<span class="sourceLineNo">542</span> }<a name="line.542"></a>
-<span class="sourceLineNo">543</span><a name="line.543"></a>
-<span class="sourceLineNo">544</span> /**<a name="line.544"></a>
-<span class="sourceLineNo">545</span> * Returns the minimum amount of time
an object may sit idle in the pool<a name="line.545"></a>
-<span class="sourceLineNo">546</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.546"></a>
-<span class="sourceLineNo">547</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}),<a name="line.547"></a>
-<span class="sourceLineNo">548</span> * with the extra condition that at
least <code>minIdle</code> object<a name="line.548"></a>
-<span class="sourceLineNo">549</span> * instances remain in the pool. This
setting is overridden by<a name="line.549"></a>
-<span class="sourceLineNo">550</span> * {@link
#getMinEvictableIdleTimeMillis} (that is, if<a name="line.550"></a>
-<span class="sourceLineNo">551</span> * {@link
#getMinEvictableIdleTimeMillis} is positive, then<a name="line.551"></a>
-<span class="sourceLineNo">552</span> * {@link
#getSoftMinEvictableIdleTimeMillis} is ignored).<a name="line.552"></a>
-<span class="sourceLineNo">553</span> *<a name="line.553"></a>
-<span class="sourceLineNo">554</span> * @return minimum amount of time an
object may sit idle in the pool before<a name="line.554"></a>
-<span class="sourceLineNo">555</span> * it is eligible for
eviction if minIdle instances are available<a name="line.555"></a>
-<span class="sourceLineNo">556</span> *<a name="line.556"></a>
-<span class="sourceLineNo">557</span> * @see
#setSoftMinEvictableIdleTimeMillis<a name="line.557"></a>
-<span class="sourceLineNo">558</span> */<a name="line.558"></a>
-<span class="sourceLineNo">559</span> public final long
getSoftMinEvictableIdleTimeMillis() {<a name="line.559"></a>
-<span class="sourceLineNo">560</span> return
softMinEvictableIdleTimeMillis;<a name="line.560"></a>
-<span class="sourceLineNo">561</span> }<a name="line.561"></a>
-<span class="sourceLineNo">562</span><a name="line.562"></a>
-<span class="sourceLineNo">563</span> /**<a name="line.563"></a>
-<span class="sourceLineNo">564</span> * Sets the minimum amount of time an
object may sit idle in the pool<a name="line.564"></a>
-<span class="sourceLineNo">565</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.565"></a>
-<span class="sourceLineNo">566</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}),<a name="line.566"></a>
-<span class="sourceLineNo">567</span> * with the extra condition that at
least <code>minIdle</code> object<a name="line.567"></a>
-<span class="sourceLineNo">568</span> * instances remain in the pool. This
setting is overridden by<a name="line.568"></a>
-<span class="sourceLineNo">569</span> * {@link
#getMinEvictableIdleTimeMillis} (that is, if<a name="line.569"></a>
-<span class="sourceLineNo">570</span> * {@link
#getMinEvictableIdleTimeMillis} is positive, then<a name="line.570"></a>
-<span class="sourceLineNo">571</span> * {@link
#getSoftMinEvictableIdleTimeMillis} is ignored).<a name="line.571"></a>
-<span class="sourceLineNo">572</span> *<a name="line.572"></a>
-<span class="sourceLineNo">573</span> * @param
softMinEvictableIdleTimeMillis<a name="line.573"></a>
-<span class="sourceLineNo">574</span> * minimum amount of time
an object may sit idle in the pool<a name="line.574"></a>
-<span class="sourceLineNo">575</span> * before it is eligible
for eviction if minIdle instances are<a name="line.575"></a>
-<span class="sourceLineNo">576</span> * available<a
name="line.576"></a>
-<span class="sourceLineNo">577</span> *<a name="line.577"></a>
-<span class="sourceLineNo">578</span> * @see
#getSoftMinEvictableIdleTimeMillis<a name="line.578"></a>
-<span class="sourceLineNo">579</span> */<a name="line.579"></a>
-<span class="sourceLineNo">580</span> public final void
setSoftMinEvictableIdleTimeMillis(<a name="line.580"></a>
-<span class="sourceLineNo">581</span> final long
softMinEvictableIdleTimeMillis) {<a name="line.581"></a>
-<span class="sourceLineNo">582</span>
this.softMinEvictableIdleTimeMillis = softMinEvictableIdleTimeMillis;<a
name="line.582"></a>
-<span class="sourceLineNo">583</span> }<a name="line.583"></a>
-<span class="sourceLineNo">584</span><a name="line.584"></a>
-<span class="sourceLineNo">585</span> /**<a name="line.585"></a>
-<span class="sourceLineNo">586</span> * Returns the name of the {@link
EvictionPolicy} implementation that is<a name="line.586"></a>
-<span class="sourceLineNo">587</span> * used by this pool.<a
name="line.587"></a>
-<span class="sourceLineNo">588</span> *<a name="line.588"></a>
-<span class="sourceLineNo">589</span> * @return The fully qualified class
name of the {@link EvictionPolicy}<a name="line.589"></a>
-<span class="sourceLineNo">590</span> *<a name="line.590"></a>
-<span class="sourceLineNo">591</span> * @see
#setEvictionPolicyClassName(String)<a name="line.591"></a>
-<span class="sourceLineNo">592</span> */<a name="line.592"></a>
-<span class="sourceLineNo">593</span> public final String
getEvictionPolicyClassName() {<a name="line.593"></a>
-<span class="sourceLineNo">594</span> return
evictionPolicy.getClass().getName();<a name="line.594"></a>
-<span class="sourceLineNo">595</span> }<a name="line.595"></a>
-<span class="sourceLineNo">596</span><a name="line.596"></a>
-<span class="sourceLineNo">597</span> /**<a name="line.597"></a>
-<span class="sourceLineNo">598</span> * Sets the eviction policy for this
pool.<a name="line.598"></a>
-<span class="sourceLineNo">599</span> *<a name="line.599"></a>
-<span class="sourceLineNo">600</span> * @param evictionPolicy<a
name="line.600"></a>
-<span class="sourceLineNo">601</span> * the eviction policy for
this pool.<a name="line.601"></a>
-<span class="sourceLineNo">602</span> * @since 2.6.0<a name="line.602"></a>
-<span class="sourceLineNo">603</span> */<a name="line.603"></a>
-<span class="sourceLineNo">604</span> public void setEvictionPolicy(final
EvictionPolicy<T> evictionPolicy) {<a name="line.604"></a>
-<span class="sourceLineNo">605</span> this.evictionPolicy =
evictionPolicy;<a name="line.605"></a>
+<span class="sourceLineNo">483</span> * @param
timeBetweenEvictionRunsMillis<a name="line.483"></a>
+<span class="sourceLineNo">484</span> * number of milliseconds
to sleep between evictor runs<a name="line.484"></a>
+<span class="sourceLineNo">485</span> *<a name="line.485"></a>
+<span class="sourceLineNo">486</span> * @see
#getTimeBetweenEvictionRunsMillis<a name="line.486"></a>
+<span class="sourceLineNo">487</span> */<a name="line.487"></a>
+<span class="sourceLineNo">488</span> public final void
setTimeBetweenEvictionRunsMillis(<a name="line.488"></a>
+<span class="sourceLineNo">489</span> final long
timeBetweenEvictionRunsMillis) {<a name="line.489"></a>
+<span class="sourceLineNo">490</span>
this.timeBetweenEvictionRunsMillis = timeBetweenEvictionRunsMillis;<a
name="line.490"></a>
+<span class="sourceLineNo">491</span>
startEvictor(timeBetweenEvictionRunsMillis);<a name="line.491"></a>
+<span class="sourceLineNo">492</span> }<a name="line.492"></a>
+<span class="sourceLineNo">493</span><a name="line.493"></a>
+<span class="sourceLineNo">494</span> /**<a name="line.494"></a>
+<span class="sourceLineNo">495</span> * Returns the maximum number of
objects to examine during each run (if any)<a name="line.495"></a>
+<span class="sourceLineNo">496</span> * of the idle object evictor thread.
When positive, the number of tests<a name="line.496"></a>
+<span class="sourceLineNo">497</span> * performed for a run will be the
minimum of the configured value and the<a name="line.497"></a>
+<span class="sourceLineNo">498</span> * number of idle instances in the
pool. When negative, the number of tests<a name="line.498"></a>
+<span class="sourceLineNo">499</span> * performed will be
<code>ceil({@link #getNumIdle}/<a name="line.499"></a>
+<span class="sourceLineNo">500</span> * abs({@link
#getNumTestsPerEvictionRun}))</code> which means that when the<a
name="line.500"></a>
+<span class="sourceLineNo">501</span> * value is
<code>-n</code> roughly one nth of the idle objects will be<a
name="line.501"></a>
+<span class="sourceLineNo">502</span> * tested per run.<a
name="line.502"></a>
+<span class="sourceLineNo">503</span> *<a name="line.503"></a>
+<span class="sourceLineNo">504</span> * @return max number of objects to
examine during each evictor run<a name="line.504"></a>
+<span class="sourceLineNo">505</span> *<a name="line.505"></a>
+<span class="sourceLineNo">506</span> * @see #setNumTestsPerEvictionRun<a
name="line.506"></a>
+<span class="sourceLineNo">507</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.507"></a>
+<span class="sourceLineNo">508</span> */<a name="line.508"></a>
+<span class="sourceLineNo">509</span> public final int
getNumTestsPerEvictionRun() {<a name="line.509"></a>
+<span class="sourceLineNo">510</span> return numTestsPerEvictionRun;<a
name="line.510"></a>
+<span class="sourceLineNo">511</span> }<a name="line.511"></a>
+<span class="sourceLineNo">512</span><a name="line.512"></a>
+<span class="sourceLineNo">513</span> /**<a name="line.513"></a>
+<span class="sourceLineNo">514</span> * Sets the maximum number of objects
to examine during each run (if any)<a name="line.514"></a>
+<span class="sourceLineNo">515</span> * of the idle object evictor thread.
When positive, the number of tests<a name="line.515"></a>
+<span class="sourceLineNo">516</span> * performed for a run will be the
minimum of the configured value and the<a name="line.516"></a>
+<span class="sourceLineNo">517</span> * number of idle instances in the
pool. When negative, the number of tests<a name="line.517"></a>
+<span class="sourceLineNo">518</span> * performed will be
<code>ceil({@link #getNumIdle}/<a name="line.518"></a>
+<span class="sourceLineNo">519</span> * abs({@link
#getNumTestsPerEvictionRun}))</code> which means that when the<a
name="line.519"></a>
+<span class="sourceLineNo">520</span> * value is
<code>-n</code> roughly one nth of the idle objects will be<a
name="line.520"></a>
+<span class="sourceLineNo">521</span> * tested per run.<a
name="line.521"></a>
+<span class="sourceLineNo">522</span> *<a name="line.522"></a>
+<span class="sourceLineNo">523</span> * @param numTestsPerEvictionRun<a
name="line.523"></a>
+<span class="sourceLineNo">524</span> * max number of objects
to examine during each evictor run<a name="line.524"></a>
+<span class="sourceLineNo">525</span> *<a name="line.525"></a>
+<span class="sourceLineNo">526</span> * @see #getNumTestsPerEvictionRun<a
name="line.526"></a>
+<span class="sourceLineNo">527</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.527"></a>
+<span class="sourceLineNo">528</span> */<a name="line.528"></a>
+<span class="sourceLineNo">529</span> public final void
setNumTestsPerEvictionRun(final int numTestsPerEvictionRun) {<a
name="line.529"></a>
+<span class="sourceLineNo">530</span> this.numTestsPerEvictionRun =
numTestsPerEvictionRun;<a name="line.530"></a>
+<span class="sourceLineNo">531</span> }<a name="line.531"></a>
+<span class="sourceLineNo">532</span><a name="line.532"></a>
+<span class="sourceLineNo">533</span> /**<a name="line.533"></a>
+<span class="sourceLineNo">534</span> * Returns the minimum amount of time
an object may sit idle in the pool<a name="line.534"></a>
+<span class="sourceLineNo">535</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.535"></a>
+<span class="sourceLineNo">536</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}). When non-positive,<a
name="line.536"></a>
+<span class="sourceLineNo">537</span> * no objects will be evicted from
the pool due to idle time alone.<a name="line.537"></a>
+<span class="sourceLineNo">538</span> *<a name="line.538"></a>
+<span class="sourceLineNo">539</span> * @return minimum amount of time an
object may sit idle in the pool before<a name="line.539"></a>
+<span class="sourceLineNo">540</span> * it is eligible for
eviction<a name="line.540"></a>
+<span class="sourceLineNo">541</span> *<a name="line.541"></a>
+<span class="sourceLineNo">542</span> * @see
#setMinEvictableIdleTimeMillis<a name="line.542"></a>
+<span class="sourceLineNo">543</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.543"></a>
+<span class="sourceLineNo">544</span> */<a name="line.544"></a>
+<span class="sourceLineNo">545</span> public final long
getMinEvictableIdleTimeMillis() {<a name="line.545"></a>
+<span class="sourceLineNo">546</span> return
minEvictableIdleTimeMillis;<a name="line.546"></a>
+<span class="sourceLineNo">547</span> }<a name="line.547"></a>
+<span class="sourceLineNo">548</span><a name="line.548"></a>
+<span class="sourceLineNo">549</span> /**<a name="line.549"></a>
+<span class="sourceLineNo">550</span> * Sets the minimum amount of time an
object may sit idle in the pool<a name="line.550"></a>
+<span class="sourceLineNo">551</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.551"></a>
+<span class="sourceLineNo">552</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}). When non-positive,<a
name="line.552"></a>
+<span class="sourceLineNo">553</span> * no objects will be evicted from
the pool due to idle time alone.<a name="line.553"></a>
+<span class="sourceLineNo">554</span> *<a name="line.554"></a>
+<span class="sourceLineNo">555</span> * @param
minEvictableIdleTimeMillis<a name="line.555"></a>
+<span class="sourceLineNo">556</span> * minimum amount of time
an object may sit idle in the pool<a name="line.556"></a>
+<span class="sourceLineNo">557</span> * before it is eligible
for eviction<a name="line.557"></a>
+<span class="sourceLineNo">558</span> *<a name="line.558"></a>
+<span class="sourceLineNo">559</span> * @see
#getMinEvictableIdleTimeMillis<a name="line.559"></a>
+<span class="sourceLineNo">560</span> * @see
#setTimeBetweenEvictionRunsMillis<a name="line.560"></a>
+<span class="sourceLineNo">561</span> */<a name="line.561"></a>
+<span class="sourceLineNo">562</span> public final void
setMinEvictableIdleTimeMillis(<a name="line.562"></a>
+<span class="sourceLineNo">563</span> final long
minEvictableIdleTimeMillis) {<a name="line.563"></a>
+<span class="sourceLineNo">564</span> this.minEvictableIdleTimeMillis =
minEvictableIdleTimeMillis;<a name="line.564"></a>
+<span class="sourceLineNo">565</span> }<a name="line.565"></a>
+<span class="sourceLineNo">566</span><a name="line.566"></a>
+<span class="sourceLineNo">567</span> /**<a name="line.567"></a>
+<span class="sourceLineNo">568</span> * Returns the minimum amount of time
an object may sit idle in the pool<a name="line.568"></a>
+<span class="sourceLineNo">569</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.569"></a>
+<span class="sourceLineNo">570</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}),<a name="line.570"></a>
+<span class="sourceLineNo">571</span> * with the extra condition that at
least <code>minIdle</code> object<a name="line.571"></a>
+<span class="sourceLineNo">572</span> * instances remain in the pool. This
setting is overridden by<a name="line.572"></a>
+<span class="sourceLineNo">573</span> * {@link
#getMinEvictableIdleTimeMillis} (that is, if<a name="line.573"></a>
+<span class="sourceLineNo">574</span> * {@link
#getMinEvictableIdleTimeMillis} is positive, then<a name="line.574"></a>
+<span class="sourceLineNo">575</span> * {@link
#getSoftMinEvictableIdleTimeMillis} is ignored).<a name="line.575"></a>
+<span class="sourceLineNo">576</span> *<a name="line.576"></a>
+<span class="sourceLineNo">577</span> * @return minimum amount of time an
object may sit idle in the pool before<a name="line.577"></a>
+<span class="sourceLineNo">578</span> * it is eligible for
eviction if minIdle instances are available<a name="line.578"></a>
+<span class="sourceLineNo">579</span> *<a name="line.579"></a>
+<span class="sourceLineNo">580</span> * @see
#setSoftMinEvictableIdleTimeMillis<a name="line.580"></a>
+<span class="sourceLineNo">581</span> */<a name="line.581"></a>
+<span class="sourceLineNo">582</span> public final long
getSoftMinEvictableIdleTimeMillis() {<a name="line.582"></a>
+<span class="sourceLineNo">583</span> return
softMinEvictableIdleTimeMillis;<a name="line.583"></a>
+<span class="sourceLineNo">584</span> }<a name="line.584"></a>
+<span class="sourceLineNo">585</span><a name="line.585"></a>
+<span class="sourceLineNo">586</span> /**<a name="line.586"></a>
+<span class="sourceLineNo">587</span> * Sets the minimum amount of time an
object may sit idle in the pool<a name="line.587"></a>
+<span class="sourceLineNo">588</span> * before it is eligible for eviction
by the idle object evictor (if any -<a name="line.588"></a>
+<span class="sourceLineNo">589</span> * see {@link
#setTimeBetweenEvictionRunsMillis(long)}),<a name="line.589"></a>
+<span class="sourceLineNo">590</span> * with the extra condition that at
least <code>minIdle</code> object<a name="line.590"></a>
+<span class="sourceLineNo">591</span> * instances remain in the pool. This
setting is overridden by<a name="line.591"></a>
+<span class="sourceLineNo">592</span> * {@link
#getMinEvictableIdleTimeMillis} (that is, if<a name="line.592"></a>
+<span class="sourceLineNo">593</span> * {@link
#getMinEvictableIdleTimeMillis} is positive, then<a name="line.593"></a>
+<span class="sourceLineNo">594</span> * {@link
#getSoftMinEvictableIdleTimeMillis} is ignored).<a name="line.594"></a>
+<span class="sourceLineNo">595</span> *<a name="line.595"></a>
+<span class="sourceLineNo">596</span> * @param
softMinEvictableIdleTimeMillis<a name="line.596"></a>
+<span class="sourceLineNo">597</span> * minimum amount of time
an object may sit idle in the pool<a name="line.597"></a>
+<span class="sourceLineNo">598</span> * before it is eligible
for eviction if minIdle instances are<a name="line.598"></a>
+<span class="sourceLineNo">599</span> * available<a
name="line.599"></a>
+<span class="sourceLineNo">600</span> *<a name="line.600"></a>
+<span class="sourceLineNo">601</span> * @see
#getSoftMinEvictableIdleTimeMillis<a name="line.601"></a>
+<span class="sourceLineNo">602</span> */<a name="line.602"></a>
+<span class="sourceLineNo">603</span> public final void
setSoftMinEvictableIdleTimeMillis(<a name="line.603"></a>
+<span class="sourceLineNo">604</span> final long
softMinEvictableIdleTimeMillis) {<a name="line.604"></a>
+<span class="sourceLineNo">605</span>
this.softMinEvictableIdleTimeMillis = softMinEvictableIdleTimeMillis;<a
name="line.605"></a>
<span class="sourceLineNo">606</span> }<a name="line.606"></a>
<span class="sourceLineNo">607</span><a name="line.607"></a>
<span class="sourceLineNo">608</span> /**<a name="line.608"></a>
-<span class="sourceLineNo">609</span> * Sets the name of the {@link
EvictionPolicy} implementation that is used by this pool. The Pool will attempt
to<a name="line.609"></a>
-<span class="sourceLineNo">610</span> * load the class using the given
class loader. If that fails, use the class loader for the {@link
EvictionPolicy}<a name="line.610"></a>
-<span class="sourceLineNo">611</span> * interface.<a name="line.611"></a>
-<span class="sourceLineNo">612</span> *<a name="line.612"></a>
-<span class="sourceLineNo">613</span> * @param evictionPolicyClassName<a
name="line.613"></a>
-<span class="sourceLineNo">614</span> * the fully qualified
class name of the new eviction policy<a name="line.614"></a>
-<span class="sourceLineNo">615</span> * @param classLoader<a
name="line.615"></a>
-<span class="sourceLineNo">616</span> * the class loader to
load the given {@code evictionPolicyClassName}.<a name="line.616"></a>
-<span class="sourceLineNo">617</span> *<a name="line.617"></a>
-<span class="sourceLineNo">618</span> * @see
#getEvictionPolicyClassName()<a name="line.618"></a>
-<span class="sourceLineNo">619</span> * @since 2.6.0 If loading the class
using the given class loader fails, use the class loader for the<a
name="line.619"></a>
-<span class="sourceLineNo">620</span> * {@link EvictionPolicy}
interface.<a name="line.620"></a>
-<span class="sourceLineNo">621</span> */<a name="line.621"></a>
-<span class="sourceLineNo">622</span> public final void
setEvictionPolicyClassName(final String evictionPolicyClassName, final
ClassLoader classLoader) {<a name="line.622"></a>
-<span class="sourceLineNo">623</span> // Getting epClass here and now
best matches the caller's environment<a name="line.623"></a>
-<span class="sourceLineNo">624</span> final Class<?> epClass =
EvictionPolicy.class;<a name="line.624"></a>
-<span class="sourceLineNo">625</span> final ClassLoader epClassLoader =
epClass.getClassLoader();<a name="line.625"></a>
-<span class="sourceLineNo">626</span> try {<a name="line.626"></a>
-<span class="sourceLineNo">627</span> try {<a name="line.627"></a>
-<span class="sourceLineNo">628</span>
setEvictionPolicy(evictionPolicyClassName, classLoader);<a name="line.628"></a>
-<span class="sourceLineNo">629</span> } catch (final
ClassCastException | ClassNotFoundException e) {<a name="line.629"></a>
-<span class="sourceLineNo">630</span>
setEvictionPolicy(evictionPolicyClassName, epClassLoader);<a
name="line.630"></a>
-<span class="sourceLineNo">631</span> }<a name="line.631"></a>
-<span class="sourceLineNo">632</span> } catch (final ClassCastException
e) {<a name="line.632"></a>
-<span class="sourceLineNo">633</span> throw new
IllegalArgumentException("Class " + evictionPolicyClassName + " from class
loaders ["<a name="line.633"></a>
-<span class="sourceLineNo">634</span> + classLoader + ", "
+ epClassLoader + "] do not implement " + EVICTION_POLICY_TYPE_NAME);<a
name="line.634"></a>
-<span class="sourceLineNo">635</span> } catch (final
ClassNotFoundException | InstantiationException | IllegalAccessException<a
name="line.635"></a>
-<span class="sourceLineNo">636</span> |
InvocationTargetException | NoSuchMethodException e) {<a name="line.636"></a>
-<span class="sourceLineNo">637</span> final String exMessage =
"Unable to create " + EVICTION_POLICY_TYPE_NAME + " instance of type "<a
name="line.637"></a>
-<span class="sourceLineNo">638</span> +
evictionPolicyClassName;<a name="line.638"></a>
-<span class="sourceLineNo">639</span> throw new
IllegalArgumentException(exMessage, e);<a name="line.639"></a>
-<span class="sourceLineNo">640</span> }<a name="line.640"></a>
-<span class="sourceLineNo">641</span> }<a name="line.641"></a>
-<span class="sourceLineNo">642</span><a name="line.642"></a>
-<span class="sourceLineNo">643</span> @SuppressWarnings("unchecked")<a
name="line.643"></a>
-<span class="sourceLineNo">644</span> private void setEvictionPolicy(final
String className, final ClassLoader classLoader)<a name="line.644"></a>
-<span class="sourceLineNo">645</span> throws
ClassNotFoundException, InstantiationException, IllegalAccessException,
InvocationTargetException, NoSuchMethodException {<a name="line.645"></a>
-<span class="sourceLineNo">646</span> final Class<?> clazz =
Class.forName(className, true, classLoader);<a name="line.646"></a>
-<span class="sourceLineNo">647</span> final Object policy =
clazz.getConstructor().newInstance();<a name="line.647"></a>
-<span class="sourceLineNo">648</span> this.evictionPolicy =
(EvictionPolicy<T>) policy;<a name="line.648"></a>
-<span class="sourceLineNo">649</span> }<a name="line.649"></a>
-<span class="sourceLineNo">650</span><a name="line.650"></a>
-<span class="sourceLineNo">651</span> /**<a name="line.651"></a>
-<span class="sourceLineNo">652</span> * Sets the name of the {@link
EvictionPolicy} implementation that is used by this pool. The Pool will attempt
to<a name="line.652"></a>
-<span class="sourceLineNo">653</span> * load the class using the thread
context class loader. If that fails, the use the class loader for the<a
name="line.653"></a>
-<span class="sourceLineNo">654</span> * {@link EvictionPolicy}
interface.<a name="line.654"></a>
-<span class="sourceLineNo">655</span> *<a name="line.655"></a>
-<span class="sourceLineNo">656</span> * @param evictionPolicyClassName<a
name="line.656"></a>
-<span class="sourceLineNo">657</span> * the fully qualified
class name of the new eviction policy<a name="line.657"></a>
-<span class="sourceLineNo">658</span> *<a name="line.658"></a>
-<span class="sourceLineNo">659</span> * @see
#getEvictionPolicyClassName()<a name="line.659"></a>
-<span class="sourceLineNo">660</span> * @since 2.6.0 If loading the class
using the thread context class loader fails, use the class loader for the<a
name="line.660"></a>
-<span class="sourceLineNo">661</span> * {@link EvictionPolicy}
interface.<a name="line.661"></a>
-<span class="sourceLineNo">662</span> */<a name="line.662"></a>
-<span class="sourceLineNo">663</span> public final void
setEvictionPolicyClassName(final String evictionPolicyClassName) {<a
name="line.663"></a>
-<span class="sourceLineNo">664</span>
setEvictionPolicyClassName(evictionPolicyClassName,
Thread.currentThread().getContextClassLoader());<a name="line.664"></a>
-<span class="sourceLineNo">665</span> }<a name="line.665"></a>
-<span class="sourceLineNo">666</span><a name="line.666"></a>
-<span class="sourceLineNo">667</span> /**<a name="line.667"></a>
-<span class="sourceLineNo">668</span> * Gets the timeout that will be used
when waiting for the Evictor to<a name="line.668"></a>
-<span class="sourceLineNo">669</span> * shutdown if this pool is closed
and it is the only pool still using the<a name="line.669"></a>
-<span class="sourceLineNo">670</span> * the value for the Evictor.<a
name="line.670"></a>
-<span class="sourceLineNo">671</span> *<a name="line.671"></a>
-<span class="sourceLineNo">672</span> * @return The timeout in
milliseconds that will be used while waiting for<a name="line.672"></a>
-<span class="sourceLineNo">673</span> * the Evictor to shut
down.<a name="line.673"></a>
-<span class="sourceLineNo">674</span> */<a name="line.674"></a>
-<span class="sourceLineNo">675</span> public final long
getEvictorShutdownTimeoutMillis() {<a name="line.675"></a>
-<span class="sourceLineNo">676</span> return
evictorShutdownTimeoutMillis;<a name="line.676"></a>
-<span class="sourceLineNo">677</span> }<a name="line.677"></a>
-<span class="sourceLineNo">678</span><a name="line.678"></a>
-<span class="sourceLineNo">679</span> /**<a name="line.679"></a>
-<span class="sourceLineNo">680</span> * Sets the timeout that will be used
when waiting for the Evictor to<a name="line.680"></a>
-<span class="sourceLineNo">681</span> * shutdown if this pool is closed
and it is the only pool still using the<a name="line.681"></a>
-<span class="sourceLineNo">682</span> * the value for the Evictor.<a
name="line.682"></a>
-<span class="sourceLineNo">683</span> *<a name="line.683"></a>
-<span class="sourceLineNo">684</span> * @param
evictorShutdownTimeoutMillis the timeout in milliseconds that<a
name="line.684"></a>
-<span class="sourceLineNo">685</span> *
will be used while waiting for the<a name="line.685"></a>
[... 1487 lines stripped ...]
