Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/BasePooledObjectFactory.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/BasePooledObjectFactory.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/BasePooledObjectFactory.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,175 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css"
title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software
Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See
the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information
regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You
under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this
file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of
the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *
http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or
agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is
distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific
language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a
name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.pool2;<a
name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * A base implementation of
<code>PoolableObjectFactory</code>.<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * <p><a name="line.21"></a>
+<span class="sourceLineNo">022</span> * All operations defined here are
essentially no-op's.<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * <p><a name="line.23"></a>
+<span class="sourceLineNo">024</span> * This class is immutable, and therefore
thread-safe<a name="line.24"></a>
+<span class="sourceLineNo">025</span> *<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * @param <T> Type of element
managed in this factory.<a name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * @see PooledObjectFactory<a
name="line.28"></a>
+<span class="sourceLineNo">029</span> * @see BaseKeyedPooledObjectFactory<a
name="line.29"></a>
+<span class="sourceLineNo">030</span> *<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * @version $Revision: 1333925 $<a
name="line.31"></a>
+<span class="sourceLineNo">032</span> *<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * @since 2.0<a name="line.33"></a>
+<span class="sourceLineNo">034</span> */<a name="line.34"></a>
+<span class="sourceLineNo">035</span>public abstract class
BasePooledObjectFactory<T> implements PooledObjectFactory<T> {<a
name="line.35"></a>
+<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * Creates an object instance, to be
wrapped in a {@link PooledObject}.<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * <p>This method
<strong>must</strong> support concurrent, multi-threaded<a
name="line.38"></a>
+<span class="sourceLineNo">039</span> * activation.</p><a
name="line.39"></a>
+<span class="sourceLineNo">040</span> *<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * @return an instance to be served
by the pool<a name="line.41"></a>
+<span class="sourceLineNo">042</span> *<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * @throws Exception if there is a
problem creating a new instance,<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * this will be propagated to the
code requesting an object.<a name="line.44"></a>
+<span class="sourceLineNo">045</span> */<a name="line.45"></a>
+<span class="sourceLineNo">046</span> public abstract T create() throws
Exception;<a name="line.46"></a>
+<span class="sourceLineNo">047</span><a name="line.47"></a>
+<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * Wrap the provided instance with an
implementation of<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * {@link PooledObject}.<a
name="line.50"></a>
+<span class="sourceLineNo">051</span> *<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * @param obj the instance to wrap<a
name="line.52"></a>
+<span class="sourceLineNo">053</span> *<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * @return The provided instance,
wrapped by a {@link PooledObject}<a name="line.54"></a>
+<span class="sourceLineNo">055</span> */<a name="line.55"></a>
+<span class="sourceLineNo">056</span> public abstract PooledObject<T>
wrap(T obj);<a name="line.56"></a>
+<span class="sourceLineNo">057</span><a name="line.57"></a>
+<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
+<span class="sourceLineNo">059</span> public PooledObject<T>
makeObject() throws Exception {<a name="line.59"></a>
+<span class="sourceLineNo">060</span> return wrap(create());<a
name="line.60"></a>
+<span class="sourceLineNo">061</span> }<a name="line.61"></a>
+<span class="sourceLineNo">062</span><a name="line.62"></a>
+<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * No-op.<a name="line.64"></a>
+<span class="sourceLineNo">065</span> *<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * @param p ignored<a
name="line.66"></a>
+<span class="sourceLineNo">067</span> */<a name="line.67"></a>
+<span class="sourceLineNo">068</span> @Override<a name="line.68"></a>
+<span class="sourceLineNo">069</span> public void
destroyObject(PooledObject<T> p)<a name="line.69"></a>
+<span class="sourceLineNo">070</span> throws Exception {<a
name="line.70"></a>
+<span class="sourceLineNo">071</span> }<a name="line.71"></a>
+<span class="sourceLineNo">072</span><a name="line.72"></a>
+<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * This implementation always returns
{@code true}.<a name="line.74"></a>
+<span class="sourceLineNo">075</span> *<a name="line.75"></a>
+<span class="sourceLineNo">076</span> * @param p ignored<a
name="line.76"></a>
+<span class="sourceLineNo">077</span> *<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * @return {@code true}<a
name="line.78"></a>
+<span class="sourceLineNo">079</span> */<a name="line.79"></a>
+<span class="sourceLineNo">080</span> @Override<a name="line.80"></a>
+<span class="sourceLineNo">081</span> public boolean
validateObject(PooledObject<T> p) {<a name="line.81"></a>
+<span class="sourceLineNo">082</span> return true;<a name="line.82"></a>
+<span class="sourceLineNo">083</span> }<a name="line.83"></a>
+<span class="sourceLineNo">084</span><a name="line.84"></a>
+<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * No-op.<a name="line.86"></a>
+<span class="sourceLineNo">087</span> *<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * @param p ignored<a
name="line.88"></a>
+<span class="sourceLineNo">089</span> */<a name="line.89"></a>
+<span class="sourceLineNo">090</span> @Override<a name="line.90"></a>
+<span class="sourceLineNo">091</span> public void
activateObject(PooledObject<T> p) throws Exception {<a name="line.91"></a>
+<span class="sourceLineNo">092</span> }<a name="line.92"></a>
+<span class="sourceLineNo">093</span><a name="line.93"></a>
+<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * No-op.<a name="line.95"></a>
+<span class="sourceLineNo">096</span> *<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * @param p ignored<a
name="line.97"></a>
+<span class="sourceLineNo">098</span> */<a name="line.98"></a>
+<span class="sourceLineNo">099</span> @Override<a name="line.99"></a>
+<span class="sourceLineNo">100</span> public void
passivateObject(PooledObject<T> p)<a name="line.100"></a>
+<span class="sourceLineNo">101</span> throws Exception {<a
name="line.101"></a>
+<span class="sourceLineNo">102</span> }<a name="line.102"></a>
+<span class="sourceLineNo">103</span>}<a name="line.103"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/BasePooledObjectFactory.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedObjectPool.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedObjectPool.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedObjectPool.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,302 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css"
title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software
Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See
the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information
regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You
under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this
file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of
the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *
http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or
agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is
distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific
language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a
name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.pool2;<a
name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import
java.util.NoSuchElementException;<a name="line.19"></a>
+<span class="sourceLineNo">020</span><a name="line.20"></a>
+<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * A "keyed" pooling interface.<a
name="line.22"></a>
+<span class="sourceLineNo">023</span> * <p><a name="line.23"></a>
+<span class="sourceLineNo">024</span> * A keyed pool maintains a pool of
instances for each key value.<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * <p><a name="line.25"></a>
+<span class="sourceLineNo">026</span> * Example of use:<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * <pre style="border:solid thin;
padding: 1ex;"<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * > Object obj = <code
style="color:#00C">null</code>;<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * Object key = <code
style="color:#C00">"Key"</code>;<a name="line.29"></a>
+<span class="sourceLineNo">030</span> *<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * <code
style="color:#00C">try</code> {<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * obj = pool.borrowObject(key);<a
name="line.32"></a>
+<span class="sourceLineNo">033</span> * <code
style="color:#0C0">//...use the object...</code><a name="line.33"></a>
+<span class="sourceLineNo">034</span> * } <code
style="color:#00C">catch</code>(Exception e) {<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * <code style="color:#0C0">//
invalidate the object</code><a name="line.35"></a>
+<span class="sourceLineNo">036</span> * pool.invalidateObject(key, obj);<a
name="line.36"></a>
+<span class="sourceLineNo">037</span> * <code style="color:#0C0">//
do not return the object to the pool twice</code><a name="line.37"></a>
+<span class="sourceLineNo">038</span> * obj = <code
style="color:#00C">null</code>;<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * } <code
style="color:#00C">finally</code> {<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * <code style="color:#0C0">//
make sure the object is returned to the pool</code><a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <code
style="color:#00C">if</code>(<code
style="color:#00C">null</code> != obj) {<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * pool.returnObject(key, obj);<a
name="line.42"></a>
+<span class="sourceLineNo">043</span> * }<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * }</pre><a name="line.44"></a>
+<span class="sourceLineNo">045</span> * <p><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * {@link KeyedObjectPool}
implementations <i>may</i> choose to store at most<a
name="line.46"></a>
+<span class="sourceLineNo">047</span> * one instance per key value, or may
choose to maintain a pool of instances<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * for each key (essentially creating a
{@link java.util.Map Map} of<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * {@link ObjectPool pools}).<a
name="line.49"></a>
+<span class="sourceLineNo">050</span> * <p><a name="line.50"></a>
+<span class="sourceLineNo">051</span> * See {@link
org.apache.commons.pool2.impl.GenericKeyedObjectPool<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * GenericKeyedObjectPool} for an
implementation.<a name="line.52"></a>
+<span class="sourceLineNo">053</span> *<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * @param <K> The type of keys
maintained by this pool.<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * @param <V> Type of element
pooled in this pool.<a name="line.55"></a>
+<span class="sourceLineNo">056</span> *<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * @see KeyedPooledObjectFactory<a
name="line.57"></a>
+<span class="sourceLineNo">058</span> * @see ObjectPool<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * @see
org.apache.commons.pool2.impl.GenericKeyedObjectPool GenericKeyedObjectPool<a
name="line.59"></a>
+<span class="sourceLineNo">060</span> *<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * @version $Revision: 1566605 $<a
name="line.61"></a>
+<span class="sourceLineNo">062</span> *<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * @since 2.0<a name="line.63"></a>
+<span class="sourceLineNo">064</span> */<a name="line.64"></a>
+<span class="sourceLineNo">065</span>public interface
KeyedObjectPool<K,V> {<a name="line.65"></a>
+<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * Obtains an instance from this pool
for the specified <code>key</code>.<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * <p><a name="line.68"></a>
+<span class="sourceLineNo">069</span> * Instances returned from this
method will have been either newly created<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * with {@link
KeyedPooledObjectFactory#makeObject makeObject} or will be<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * a previously idle object and have
been activated with<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * {@link
KeyedPooledObjectFactory#activateObject activateObject} and then<a
name="line.72"></a>
+<span class="sourceLineNo">073</span> * (optionally) validated with<a
name="line.73"></a>
+<span class="sourceLineNo">074</span> * {@link
KeyedPooledObjectFactory#validateObject validateObject}.<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * <p><a name="line.75"></a>
+<span class="sourceLineNo">076</span> * By contract, clients
<strong>must</strong> return the borrowed object<a
name="line.76"></a>
+<span class="sourceLineNo">077</span> * using {@link #returnObject
returnObject},<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * {@link #invalidateObject
invalidateObject}, or a related method as<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * defined in an implementation or
sub-interface, using a <code>key</code><a name="line.79"></a>
+<span class="sourceLineNo">080</span> * that is {@link Object#equals
equivalent} to the one used to borrow the<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * instance in the first place.<a
name="line.81"></a>
+<span class="sourceLineNo">082</span> * <p><a name="line.82"></a>
+<span class="sourceLineNo">083</span> * The behaviour of this method when
the pool has been exhausted is not<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * strictly specified (although it
may be specified by implementations).<a name="line.84"></a>
+<span class="sourceLineNo">085</span> *<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * @param key the key used to obtain
the object<a name="line.86"></a>
+<span class="sourceLineNo">087</span> *<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * @return an instance from this
pool.<a name="line.88"></a>
+<span class="sourceLineNo">089</span> *<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * @throws IllegalStateException<a
name="line.90"></a>
+<span class="sourceLineNo">091</span> * after {@link #close
close} has been called on this pool<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * @throws Exception<a
name="line.92"></a>
+<span class="sourceLineNo">093</span> * when {@link
KeyedPooledObjectFactory#makeObject<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * makeObject} throws an
exception<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * @throws NoSuchElementException<a
name="line.95"></a>
+<span class="sourceLineNo">096</span> * when the pool is
exhausted and cannot or will not return<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * another instance<a
name="line.97"></a>
+<span class="sourceLineNo">098</span> */<a name="line.98"></a>
+<span class="sourceLineNo">099</span> V borrowObject(K key) throws
Exception, NoSuchElementException, IllegalStateException;<a name="line.99"></a>
+<span class="sourceLineNo">100</span><a name="line.100"></a>
+<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * Return an instance to the pool. By
contract, <code>obj</code><a name="line.102"></a>
+<span class="sourceLineNo">103</span> * <strong>must</strong>
have been obtained using<a name="line.103"></a>
+<span class="sourceLineNo">104</span> * {@link #borrowObject borrowObject}
or a related method as defined in an<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * implementation or sub-interface
using a <code>key</code> that is<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * equivalent to the one used to
borrow the instance in the first place.<a name="line.106"></a>
+<span class="sourceLineNo">107</span> *<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * @param key the key used to obtain
the object<a name="line.108"></a>
+<span class="sourceLineNo">109</span> * @param obj a {@link #borrowObject
borrowed} instance to be returned.<a name="line.109"></a>
+<span class="sourceLineNo">110</span> *<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * @throws IllegalStateException<a
name="line.111"></a>
+<span class="sourceLineNo">112</span> * if an attempt is made
to return an object to the pool that<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * is in any state other
than allocated (i.e. borrowed).<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * Attempting to return
an object more than once or attempting<a name="line.114"></a>
+<span class="sourceLineNo">115</span> * to return an object
that was never borrowed from the pool<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * will trigger this
exception.<a name="line.116"></a>
+<span class="sourceLineNo">117</span> *<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * @throws Exception if an instance
cannot be returned to the pool<a name="line.118"></a>
+<span class="sourceLineNo">119</span> */<a name="line.119"></a>
+<span class="sourceLineNo">120</span> void returnObject(K key, V obj)
throws Exception;<a name="line.120"></a>
+<span class="sourceLineNo">121</span><a name="line.121"></a>
+<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * Invalidates an object from the
pool.<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * <p><a name="line.124"></a>
+<span class="sourceLineNo">125</span> * By contract,
<code>obj</code> <strong>must</strong> have been
obtained<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * using {@link #borrowObject
borrowObject} or a related method as defined<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * in an implementation or
sub-interface using a <code>key</code> that is<a
name="line.127"></a>
+<span class="sourceLineNo">128</span> * equivalent to the one used to
borrow the <code>Object</code> in the first<a name="line.128"></a>
+<span class="sourceLineNo">129</span> * place.<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * <p><a name="line.130"></a>
+<span class="sourceLineNo">131</span> * This method should be used when an
object that has been borrowed is<a name="line.131"></a>
+<span class="sourceLineNo">132</span> * determined (due to an exception or
other problem) to be invalid.<a name="line.132"></a>
+<span class="sourceLineNo">133</span> *<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * @param key the key used to obtain
the object<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * @param obj a {@link #borrowObject
borrowed} instance to be returned.<a name="line.135"></a>
+<span class="sourceLineNo">136</span> *<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * @throws Exception if the instance
cannot be invalidated<a name="line.137"></a>
+<span class="sourceLineNo">138</span> */<a name="line.138"></a>
+<span class="sourceLineNo">139</span> void invalidateObject(K key, V obj)
throws Exception;<a name="line.139"></a>
+<span class="sourceLineNo">140</span><a name="line.140"></a>
+<span class="sourceLineNo">141</span> /**<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * Create an object using the {@link
KeyedPooledObjectFactory factory} or<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * other implementation dependent
mechanism, passivate it, and then place it<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * in the idle object pool.
<code>addObject</code> is useful for<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * "pre-loading" a pool with idle
objects (Optional operation).<a name="line.145"></a>
+<span class="sourceLineNo">146</span> *<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * @param key the key a new instance
should be added to<a name="line.147"></a>
+<span class="sourceLineNo">148</span> *<a name="line.148"></a>
+<span class="sourceLineNo">149</span> * @throws Exception<a
name="line.149"></a>
+<span class="sourceLineNo">150</span> * when {@link
KeyedPooledObjectFactory#makeObject} fails.<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * @throws IllegalStateException<a
name="line.151"></a>
+<span class="sourceLineNo">152</span> * after {@link #close}
has been called on this pool.<a name="line.152"></a>
+<span class="sourceLineNo">153</span> * @throws
UnsupportedOperationException<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * when this pool cannot
add new idle objects.<a name="line.154"></a>
+<span class="sourceLineNo">155</span> */<a name="line.155"></a>
+<span class="sourceLineNo">156</span> void addObject(K key) throws
Exception, IllegalStateException,<a name="line.156"></a>
+<span class="sourceLineNo">157</span>
UnsupportedOperationException;<a name="line.157"></a>
+<span class="sourceLineNo">158</span><a name="line.158"></a>
+<span class="sourceLineNo">159</span> /**<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * Returns the number of instances
corresponding to the given<a name="line.160"></a>
+<span class="sourceLineNo">161</span> * <code>key</code>
currently idle in this pool. Returns a negative value if<a name="line.161"></a>
+<span class="sourceLineNo">162</span> * this information is not
available.<a name="line.162"></a>
+<span class="sourceLineNo">163</span> *<a name="line.163"></a>
+<span class="sourceLineNo">164</span> * @param key the key to query<a
name="line.164"></a>
+<span class="sourceLineNo">165</span> * @return the number of instances
corresponding to the given<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * <code>key</code>
currently idle in this pool.<a name="line.166"></a>
+<span class="sourceLineNo">167</span> */<a name="line.167"></a>
+<span class="sourceLineNo">168</span> int getNumIdle(K key);<a
name="line.168"></a>
+<span class="sourceLineNo">169</span><a name="line.169"></a>
+<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
+<span class="sourceLineNo">171</span> * Returns the number of instances
currently borrowed from but not yet<a name="line.171"></a>
+<span class="sourceLineNo">172</span> * returned to the pool corresponding
to the given <code>key</code>.<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * Returns a negative value if this
information is not available.<a name="line.173"></a>
+<span class="sourceLineNo">174</span> *<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * @param key the key to query<a
name="line.175"></a>
+<span class="sourceLineNo">176</span> * @return the number of instances
currently borrowed from but not yet<a name="line.176"></a>
+<span class="sourceLineNo">177</span> * returned to the pool corresponding
to the given <code>key</code>.<a name="line.177"></a>
+<span class="sourceLineNo">178</span>= */<a name="line.178"></a>
+<span class="sourceLineNo">179</span> int getNumActive(K key);<a
name="line.179"></a>
+<span class="sourceLineNo">180</span><a name="line.180"></a>
+<span class="sourceLineNo">181</span> /**<a name="line.181"></a>
+<span class="sourceLineNo">182</span> * Returns the total number of
instances currently idle in this pool.<a name="line.182"></a>
+<span class="sourceLineNo">183</span> * Returns a negative value if this
information is not available.<a name="line.183"></a>
+<span class="sourceLineNo">184</span> * @return the total number of
instances currently idle in this pool.<a name="line.184"></a>
+<span class="sourceLineNo">185</span> = */<a name="line.185"></a>
+<span class="sourceLineNo">186</span> int getNumIdle();<a
name="line.186"></a>
+<span class="sourceLineNo">187</span><a name="line.187"></a>
+<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
+<span class="sourceLineNo">189</span> * Returns the total number of
instances current borrowed from this pool but<a name="line.189"></a>
+<span class="sourceLineNo">190</span> * not yet returned. Returns a
negative value if this information is not<a name="line.190"></a>
+<span class="sourceLineNo">191</span> * available.<a name="line.191"></a>
+<span class="sourceLineNo">192</span> * @return the total number of
instances current borrowed from this pool but<a name="line.192"></a>
+<span class="sourceLineNo">193</span> * not yet returned.<a
name="line.193"></a>
+<span class="sourceLineNo">194</span> */<a name="line.194"></a>
+<span class="sourceLineNo">195</span> int getNumActive();<a
name="line.195"></a>
+<span class="sourceLineNo">196</span><a name="line.196"></a>
+<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
+<span class="sourceLineNo">198</span> * Clears the pool, removing all
pooled instances (optional operation).<a name="line.198"></a>
+<span class="sourceLineNo">199</span> *<a name="line.199"></a>
+<span class="sourceLineNo">200</span> * @throws
UnsupportedOperationException when this implementation doesn't<a
name="line.200"></a>
+<span class="sourceLineNo">201</span> *
support the operation<a name="line.201"></a>
+<span class="sourceLineNo">202</span> *<a name="line.202"></a>
+<span class="sourceLineNo">203</span> * @throws Exception if the pool
cannot be cleared<a name="line.203"></a>
+<span class="sourceLineNo">204</span> */<a name="line.204"></a>
+<span class="sourceLineNo">205</span> void clear() throws Exception,
UnsupportedOperationException;<a name="line.205"></a>
+<span class="sourceLineNo">206</span><a name="line.206"></a>
+<span class="sourceLineNo">207</span> /**<a name="line.207"></a>
+<span class="sourceLineNo">208</span> * Clears the specified pool,
removing all pooled instances corresponding to<a name="line.208"></a>
+<span class="sourceLineNo">209</span> * the given
<code>key</code> (optional operation).<a name="line.209"></a>
+<span class="sourceLineNo">210</span> *<a name="line.210"></a>
+<span class="sourceLineNo">211</span> * @param key the key to clear<a
name="line.211"></a>
+<span class="sourceLineNo">212</span> *<a name="line.212"></a>
+<span class="sourceLineNo">213</span> * @throws
UnsupportedOperationException when this implementation doesn't<a
name="line.213"></a>
+<span class="sourceLineNo">214</span> *
support the operation<a name="line.214"></a>
+<span class="sourceLineNo">215</span> *<a name="line.215"></a>
+<span class="sourceLineNo">216</span> * @throws Exception if the key
cannot be cleared<a name="line.216"></a>
+<span class="sourceLineNo">217</span> */<a name="line.217"></a>
+<span class="sourceLineNo">218</span> void clear(K key) throws Exception,
UnsupportedOperationException;<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> * Close this pool, and free any
resources associated with it.<a name="line.221"></a>
+<span class="sourceLineNo">222</span> * <p><a name="line.222"></a>
+<span class="sourceLineNo">223</span> * Calling {@link #addObject
addObject} or<a name="line.223"></a>
+<span class="sourceLineNo">224</span> * {@link #borrowObject borrowObject}
after invoking this method on a pool<a name="line.224"></a>
+<span class="sourceLineNo">225</span> * will cause them to throw an {@link
IllegalStateException}.<a name="line.225"></a>
+<span class="sourceLineNo">226</span> * <p><a name="line.226"></a>
+<span class="sourceLineNo">227</span> * Implementations should silently
fail if not all resources can be freed.<a name="line.227"></a>
+<span class="sourceLineNo">228</span> */<a name="line.228"></a>
+<span class="sourceLineNo">229</span> void close();<a name="line.229"></a>
+<span class="sourceLineNo">230</span>}<a name="line.230"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedObjectPool.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,222 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css"
title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software
Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See
the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information
regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You
under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this
file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of
the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *
http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or
agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is
distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific
language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a
name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.pool2;<a
name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
+<span class="sourceLineNo">020</span> * An interface defining life-cycle
methods for<a name="line.20"></a>
+<span class="sourceLineNo">021</span> * instances to be served by a {@link
KeyedObjectPool}.<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * <p><a name="line.22"></a>
+<span class="sourceLineNo">023</span> * By contract, when an {@link
KeyedObjectPool}<a name="line.23"></a>
+<span class="sourceLineNo">024</span> * delegates to a {@link
KeyedPooledObjectFactory},<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * <ol><a name="line.25"></a>
+<span class="sourceLineNo">026</span> * <li><a name="line.26"></a>
+<span class="sourceLineNo">027</span> * {@link #makeObject} is called
whenever a new instance is needed.<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * </li><a name="line.28"></a>
+<span class="sourceLineNo">029</span> * <li><a name="line.29"></a>
+<span class="sourceLineNo">030</span> * {@link #activateObject} is invoked
on every instance that has been<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * {@link #passivateObject passivated}
before it is<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * {@link KeyedObjectPool#borrowObject
borrowed} from the pool.<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * </li><a name="line.33"></a>
+<span class="sourceLineNo">034</span> * <li><a name="line.34"></a>
+<span class="sourceLineNo">035</span> * {@link #validateObject} may be
invoked on {@link #activateObject activated}<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * instances to make sure they can be<a
name="line.36"></a>
+<span class="sourceLineNo">037</span> * {@link KeyedObjectPool#borrowObject
borrowed} from the pool.<a name="line.37"></a>
+<span class="sourceLineNo">038</span> *
<code>validateObject</code> may also be used to test an<a
name="line.38"></a>
+<span class="sourceLineNo">039</span> * instance being {@link
KeyedObjectPool#returnObject returned} to the pool<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * before it is {@link #passivateObject
passivated}. It will only be invoked<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * on an activated instance.<a
name="line.41"></a>
+<span class="sourceLineNo">042</span> * </li><a name="line.42"></a>
+<span class="sourceLineNo">043</span> * <li><a name="line.43"></a>
+<span class="sourceLineNo">044</span> * {@link #passivateObject
passivateObject}<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * is invoked on every instance when it
is returned to the pool.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * </li><a name="line.46"></a>
+<span class="sourceLineNo">047</span> * <li><a name="line.47"></a>
+<span class="sourceLineNo">048</span> * {@link #destroyObject
destroyObject}<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * is invoked on every instance when it
is being "dropped" from the<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * pool (whether due to the response
from <code>validateObject</code>,<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * or for reasons specific to the pool
implementation.) There is no<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * guarantee that the instance being
destroyed will<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * be considered active, passive or in
a generally consistent state.<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * </li><a name="line.54"></a>
+<span class="sourceLineNo">055</span> * </ol><a name="line.55"></a>
+<span class="sourceLineNo">056</span> * {@link KeyedPooledObjectFactory} must
be thread-safe. The only promise<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * an {@link KeyedObjectPool} makes is
that the same instance of an object will<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * not be passed to more than one method
of a<a name="line.58"></a>
+<span class="sourceLineNo">059</span> *
<code>KeyedPoolableObjectFactory</code> at a time.<a
name="line.59"></a>
+<span class="sourceLineNo">060</span> * <p><a name="line.60"></a>
+<span class="sourceLineNo">061</span> * While clients of a {@link
KeyedObjectPool} borrow and return instances of<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * the underlying value type V, the
factory methods act on instances of<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * {@link PooledObject
PooledObject&lt;V&gt;}. These are the object wrappers that<a
name="line.63"></a>
+<span class="sourceLineNo">064</span> * pools use to track and maintain state
informations about the objects that<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * they manage.<a name="line.65"></a>
+<span class="sourceLineNo">066</span> *<a name="line.66"></a>
+<span class="sourceLineNo">067</span> * @see KeyedObjectPool<a
name="line.67"></a>
+<span class="sourceLineNo">068</span> * @see BaseKeyedPooledObjectFactory<a
name="line.68"></a>
+<span class="sourceLineNo">069</span> *<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * @param <K> The type of keys
managed by this factory.<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * @param <V> Type of element
managed by this factory.<a name="line.71"></a>
+<span class="sourceLineNo">072</span> *<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * @version $Revision: 1333925 $<a
name="line.73"></a>
+<span class="sourceLineNo">074</span> *<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * @since 2.0<a name="line.75"></a>
+<span class="sourceLineNo">076</span> */<a name="line.76"></a>
+<span class="sourceLineNo">077</span>public interface
KeyedPooledObjectFactory<K,V> {<a name="line.77"></a>
+<span class="sourceLineNo">078</span> /**<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * Create an instance that can be
served by the pool and<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * wrap it in a {@link PooledObject}
to be managed by the pool.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> *<a name="line.81"></a>
+<span class="sourceLineNo">082</span> * @param key the key used when
constructing the object<a name="line.82"></a>
+<span class="sourceLineNo">083</span> *<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * @return a {@code PooledObject}
wrapping an instance that can<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * be served by the pool.<a
name="line.85"></a>
+<span class="sourceLineNo">086</span> *<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * @throws Exception if there is a
problem creating a new instance,<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * this will be propagated to the
code requesting an object.<a name="line.88"></a>
+<span class="sourceLineNo">089</span> */<a name="line.89"></a>
+<span class="sourceLineNo">090</span> PooledObject<V> makeObject(K
key) throws Exception;<a name="line.90"></a>
+<span class="sourceLineNo">091</span><a name="line.91"></a>
+<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * Destroy an instance no longer
needed by the pool.<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * <p><a name="line.94"></a>
+<span class="sourceLineNo">095</span> * It is important for
implementations of this method to be aware that there<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * is no guarantee about what state
<code>obj</code> will be in and the<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * implementation should be prepared
to handle unexpected errors.<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * <p><a name="line.98"></a>
+<span class="sourceLineNo">099</span> * Also, an implementation must take
in to consideration that instances lost<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * to the garbage collector may never
be destroyed.<a name="line.100"></a>
+<span class="sourceLineNo">101</span> *<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * @param key the key used when
selecting the instance<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * @param p a {@code PooledObject}
wrapping the instance to be destroyed<a name="line.103"></a>
+<span class="sourceLineNo">104</span> *<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * @throws Exception should be
avoided as it may be swallowed by<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * the pool implementation.<a
name="line.106"></a>
+<span class="sourceLineNo">107</span> *<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * @see #validateObject<a
name="line.108"></a>
+<span class="sourceLineNo">109</span> * @see
KeyedObjectPool#invalidateObject<a name="line.109"></a>
+<span class="sourceLineNo">110</span> */<a name="line.110"></a>
+<span class="sourceLineNo">111</span> void destroyObject(K key,
PooledObject<V> p) throws Exception;<a name="line.111"></a>
+<span class="sourceLineNo">112</span><a name="line.112"></a>
+<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * Ensures that the instance is safe
to be returned by the pool.<a name="line.114"></a>
+<span class="sourceLineNo">115</span> *<a name="line.115"></a>
+<span class="sourceLineNo">116</span> * @param key the key used when
selecting the object<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * @param p a {@code PooledObject}
wrapping the instance to be validated<a name="line.117"></a>
+<span class="sourceLineNo">118</span> *<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * @return
<code>false</code> if <code>obj</code> is not valid and
should<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * be dropped from the pool,
<code>true</code> otherwise.<a name="line.120"></a>
+<span class="sourceLineNo">121</span> */<a name="line.121"></a>
+<span class="sourceLineNo">122</span> boolean validateObject(K key,
PooledObject<V> p);<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * Reinitialize an instance to be
returned by the pool.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> *<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * @param key the key used when
selecting the object<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * @param p a {@code PooledObject}
wrapping the instance to be activated<a name="line.128"></a>
+<span class="sourceLineNo">129</span> *<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * @throws Exception if there is a
problem activating <code>obj</code>,<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * this exception may be swallowed
by the pool.<a name="line.131"></a>
+<span class="sourceLineNo">132</span> *<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * @see #destroyObject<a
name="line.133"></a>
+<span class="sourceLineNo">134</span> */<a name="line.134"></a>
+<span class="sourceLineNo">135</span> void activateObject(K key,
PooledObject<V> p) throws Exception;<a name="line.135"></a>
+<span class="sourceLineNo">136</span><a name="line.136"></a>
+<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * Uninitialize an instance to be
returned to the idle object pool.<a name="line.138"></a>
+<span class="sourceLineNo">139</span> *<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * @param key the key used when
selecting the object<a name="line.140"></a>
+<span class="sourceLineNo">141</span> * @param p a {@code PooledObject}
wrapping the instance to be passivated<a name="line.141"></a>
+<span class="sourceLineNo">142</span> *<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * @throws Exception if there is a
problem passivating <code>obj</code>,<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * this exception may be swallowed
by the pool.<a name="line.144"></a>
+<span class="sourceLineNo">145</span> *<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @see #destroyObject<a
name="line.146"></a>
+<span class="sourceLineNo">147</span> */<a name="line.147"></a>
+<span class="sourceLineNo">148</span> void passivateObject(K key,
PooledObject<V> p) throws Exception;<a name="line.148"></a>
+<span class="sourceLineNo">149</span>}<a name="line.149"></a>
+<span class="sourceLineNo">150</span><a name="line.150"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html
------------------------------------------------------------------------------
svn:eol-style = native
Added:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/ObjectPool.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/ObjectPool.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/ObjectPool.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,250 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css"
title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software
Foundation (ASF) under one or more<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * contributor license agreements. See
the NOTICE file distributed with<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * this work for additional information
regarding copyright ownership.<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * The ASF licenses this file to You
under the Apache License, Version 2.0<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * (the "License"); you may not use this
file except in compliance with<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * the License. You may obtain a copy of
the License at<a name="line.7"></a>
+<span class="sourceLineNo">008</span> *<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *
http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *<a name="line.10"></a>
+<span class="sourceLineNo">011</span> * Unless required by applicable law or
agreed to in writing, software<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * distributed under the License is
distributed on an "AS IS" BASIS,<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied.<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * See the License for the specific
language governing permissions and<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * limitations under the License.<a
name="line.15"></a>
+<span class="sourceLineNo">016</span> */<a name="line.16"></a>
+<span class="sourceLineNo">017</span>package org.apache.commons.pool2;<a
name="line.17"></a>
+<span class="sourceLineNo">018</span><a name="line.18"></a>
+<span class="sourceLineNo">019</span>import
java.util.NoSuchElementException;<a name="line.19"></a>
+<span class="sourceLineNo">020</span><a name="line.20"></a>
+<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
+<span class="sourceLineNo">022</span> * A pooling simple interface.<a
name="line.22"></a>
+<span class="sourceLineNo">023</span> * <p><a name="line.23"></a>
+<span class="sourceLineNo">024</span> * Example of use:<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * <pre style="border:solid thin;
padding: 1ex;"<a name="line.25"></a>
+<span class="sourceLineNo">026</span> * > Object obj = <code
style="color:#00C">null</code>;<a name="line.26"></a>
+<span class="sourceLineNo">027</span> *<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * <code
style="color:#00C">try</code> {<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * obj = pool.borrowObject();<a
name="line.29"></a>
+<span class="sourceLineNo">030</span> * <code
style="color:#00C">try</code> {<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * <code
style="color:#0C0">//...use the object...</code><a name="line.31"></a>
+<span class="sourceLineNo">032</span> * } <code
style="color:#00C">catch</code>(Exception e) {<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * <code
style="color:#0C0">// invalidate the object</code><a
name="line.33"></a>
+<span class="sourceLineNo">034</span> * pool.invalidateObject(obj);<a
name="line.34"></a>
+<span class="sourceLineNo">035</span> * <code
style="color:#0C0">// do not return the object to the pool
twice</code><a name="line.35"></a>
+<span class="sourceLineNo">036</span> * obj = <code
style="color:#00C">null</code>;<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * } <code
style="color:#00C">finally</code> {<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * <code
style="color:#0C0">// make sure the object is returned to the
pool</code><a name="line.38"></a>
+<span class="sourceLineNo">039</span> * <code
style="color:#00C">if</code>(<code
style="color:#00C">null</code> != obj) {<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * pool.returnObject(obj);<a
name="line.40"></a>
+<span class="sourceLineNo">041</span> * }<a name="line.41"></a>
+<span class="sourceLineNo">042</span> * }<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * } <code
style="color:#00C">catch</code>(Exception e) {<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * <code
style="color:#0C0">// failed to borrow an object</code><a
name="line.44"></a>
+<span class="sourceLineNo">045</span> * }</pre><a name="line.45"></a>
+<span class="sourceLineNo">046</span> * <p><a name="line.46"></a>
+<span class="sourceLineNo">047</span> * See {@link BaseObjectPool} for a
simple base implementation.<a name="line.47"></a>
+<span class="sourceLineNo">048</span> *<a name="line.48"></a>
+<span class="sourceLineNo">049</span> * @param <T> Type of element
pooled in this pool.<a name="line.49"></a>
+<span class="sourceLineNo">050</span> *<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * @see PooledObjectFactory<a
name="line.51"></a>
+<span class="sourceLineNo">052</span> * @see KeyedObjectPool<a
name="line.52"></a>
+<span class="sourceLineNo">053</span> * @see BaseObjectPool<a
name="line.53"></a>
+<span class="sourceLineNo">054</span> *<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * @version $Revision: 1566605 $<a
name="line.55"></a>
+<span class="sourceLineNo">056</span> *<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * @since 2.0<a name="line.57"></a>
+<span class="sourceLineNo">058</span> */<a name="line.58"></a>
+<span class="sourceLineNo">059</span>public interface ObjectPool<T> {<a
name="line.59"></a>
+<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * Obtains an instance from this
pool.<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * <p><a name="line.62"></a>
+<span class="sourceLineNo">063</span> * Instances returned from this
method will have been either newly created<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * with {@link
PooledObjectFactory#makeObject} or will be a previously<a name="line.64"></a>
+<span class="sourceLineNo">065</span> * idle object and have been
activated with<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * {@link
PooledObjectFactory#activateObject} and then validated with<a
name="line.66"></a>
+<span class="sourceLineNo">067</span> * {@link
PooledObjectFactory#validateObject}.<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * <p><a name="line.68"></a>
+<span class="sourceLineNo">069</span> * By contract, clients
<strong>must</strong> return the borrowed instance<a
name="line.69"></a>
+<span class="sourceLineNo">070</span> * using {@link #returnObject},
{@link #invalidateObject}, or a related<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * method as defined in an
implementation or sub-interface.<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * <p><a name="line.72"></a>
+<span class="sourceLineNo">073</span> * The behaviour of this method when
the pool has been exhausted<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * is not strictly specified
(although it may be specified by<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * implementations).<a
name="line.75"></a>
+<span class="sourceLineNo">076</span> *<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * @return an instance from this
pool.<a name="line.77"></a>
+<span class="sourceLineNo">078</span> *<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * @throws IllegalStateException<a
name="line.79"></a>
+<span class="sourceLineNo">080</span> * after {@link #close
close} has been called on this pool.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> * @throws Exception<a
name="line.81"></a>
+<span class="sourceLineNo">082</span> * when {@link
PooledObjectFactory#makeObject} throws an<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * exception.<a
name="line.83"></a>
+<span class="sourceLineNo">084</span> * @throws NoSuchElementException<a
name="line.84"></a>
+<span class="sourceLineNo">085</span> * when the pool is
exhausted and cannot or will not return<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * another instance.<a
name="line.86"></a>
+<span class="sourceLineNo">087</span> */<a name="line.87"></a>
+<span class="sourceLineNo">088</span> T borrowObject() throws Exception,
NoSuchElementException,<a name="line.88"></a>
+<span class="sourceLineNo">089</span> IllegalStateException;<a
name="line.89"></a>
+<span class="sourceLineNo">090</span><a name="line.90"></a>
+<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * Return an instance to the pool. By
contract, <code>obj</code><a name="line.92"></a>
+<span class="sourceLineNo">093</span> * <strong>must</strong>
have been obtained using {@link #borrowObject()} or<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * a related method as defined in an
implementation or sub-interface.<a name="line.94"></a>
+<span class="sourceLineNo">095</span> *<a name="line.95"></a>
+<span class="sourceLineNo">096</span> * @param obj a {@link #borrowObject
borrowed} instance to be returned.<a name="line.96"></a>
+<span class="sourceLineNo">097</span> *<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * @throws IllegalStateException<a
name="line.98"></a>
+<span class="sourceLineNo">099</span> * if an attempt is made
to return an object to the pool that<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * is in any state other
than allocated (i.e. borrowed).<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * Attempting to return
an object more than once or attempting<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * to return an object
that was never borrowed from the pool<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * will trigger this
exception.<a name="line.103"></a>
+<span class="sourceLineNo">104</span> *<a name="line.104"></a>
+<span class="sourceLineNo">105</span> * @throws Exception if an instance
cannot be returned to the pool<a name="line.105"></a>
+<span class="sourceLineNo">106</span> */<a name="line.106"></a>
+<span class="sourceLineNo">107</span> void returnObject(T obj) throws
Exception;<a name="line.107"></a>
+<span class="sourceLineNo">108</span><a name="line.108"></a>
+<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * Invalidates an object from the
pool.<a name="line.110"></a>
+<span class="sourceLineNo">111</span> * <p><a name="line.111"></a>
+<span class="sourceLineNo">112</span> * By contract,
<code>obj</code> <strong>must</strong> have been
obtained<a name="line.112"></a>
+<span class="sourceLineNo">113</span> * using {@link #borrowObject} or a
related method as defined in an<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * implementation or sub-interface.<a
name="line.114"></a>
+<span class="sourceLineNo">115</span> * <p><a name="line.115"></a>
+<span class="sourceLineNo">116</span> * This method should be used when an
object that has been borrowed is<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * determined (due to an exception or
other problem) to be invalid.<a name="line.117"></a>
+<span class="sourceLineNo">118</span> *<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * @param obj a {@link #borrowObject
borrowed} instance to be disposed.<a name="line.119"></a>
+<span class="sourceLineNo">120</span> *<a name="line.120"></a>
+<span class="sourceLineNo">121</span> * @throws Exception if the instance
cannot be invalidated<a name="line.121"></a>
+<span class="sourceLineNo">122</span> */<a name="line.122"></a>
+<span class="sourceLineNo">123</span> void invalidateObject(T obj) throws
Exception;<a name="line.123"></a>
+<span class="sourceLineNo">124</span><a name="line.124"></a>
+<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * Create an object using the {@link
PooledObjectFactory factory} or other<a name="line.126"></a>
+<span class="sourceLineNo">127</span> * implementation dependent
mechanism, passivate it, and then place it in<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * the idle object pool.
<code>addObject</code> is useful for "pre-loading"<a
name="line.128"></a>
+<span class="sourceLineNo">129</span> * a pool with idle objects.
(Optional operation).<a name="line.129"></a>
+<span class="sourceLineNo">130</span> *<a name="line.130"></a>
+<span class="sourceLineNo">131</span> * @throws Exception<a
name="line.131"></a>
+<span class="sourceLineNo">132</span> * when {@link
PooledObjectFactory#makeObject} fails.<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * @throws IllegalStateException<a
name="line.133"></a>
+<span class="sourceLineNo">134</span> * after {@link #close}
has been called on this pool.<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * @throws
UnsupportedOperationException<a name="line.135"></a>
+<span class="sourceLineNo">136</span> * when this pool cannot
add new idle objects.<a name="line.136"></a>
+<span class="sourceLineNo">137</span> */<a name="line.137"></a>
+<span class="sourceLineNo">138</span> void addObject() throws Exception,
IllegalStateException,<a name="line.138"></a>
+<span class="sourceLineNo">139</span>
UnsupportedOperationException;<a name="line.139"></a>
+<span class="sourceLineNo">140</span><a name="line.140"></a>
+<span class="sourceLineNo">141</span> /**<a name="line.141"></a>
+<span class="sourceLineNo">142</span> * Return the number of instances
currently idle in this pool. This may be<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * considered an approximation of the
number of objects that can be<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * {@link #borrowObject borrowed}
without creating any new instances.<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * Returns a negative value if this
information is not available.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @return the number of instances
currently idle in this pool.<a name="line.146"></a>
+<span class="sourceLineNo">147</span> */<a name="line.147"></a>
+<span class="sourceLineNo">148</span> int getNumIdle();<a
name="line.148"></a>
+<span class="sourceLineNo">149</span><a name="line.149"></a>
+<span class="sourceLineNo">150</span> /**<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * Return the number of instances
currently borrowed from this pool. Returns<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * a negative value if this
information is not available.<a name="line.152"></a>
+<span class="sourceLineNo">153</span> * @return the number of instances
currently borrowed from this pool.<a name="line.153"></a>
+<span class="sourceLineNo">154</span> */<a name="line.154"></a>
+<span class="sourceLineNo">155</span> int getNumActive();<a
name="line.155"></a>
+<span class="sourceLineNo">156</span><a name="line.156"></a>
+<span class="sourceLineNo">157</span> /**<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * Clears any objects sitting idle in
the pool, releasing any associated<a name="line.158"></a>
+<span class="sourceLineNo">159</span> * resources (optional operation).
Idle objects cleared must be<a name="line.159"></a>
+<span class="sourceLineNo">160</span> * {@link
PooledObjectFactory#destroyObject(PooledObject)}.<a name="line.160"></a>
+<span class="sourceLineNo">161</span> *<a name="line.161"></a>
+<span class="sourceLineNo">162</span> * @throws
UnsupportedOperationException<a name="line.162"></a>
+<span class="sourceLineNo">163</span> * if this
implementation does not support the operation<a name="line.163"></a>
+<span class="sourceLineNo">164</span> *<a name="line.164"></a>
+<span class="sourceLineNo">165</span> * @throws Exception if the pool
cannot be cleared<a name="line.165"></a>
+<span class="sourceLineNo">166</span> */<a name="line.166"></a>
+<span class="sourceLineNo">167</span> void clear() throws Exception,
UnsupportedOperationException;<a name="line.167"></a>
+<span class="sourceLineNo">168</span><a name="line.168"></a>
+<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
+<span class="sourceLineNo">170</span> * Close this pool, and free any
resources associated with it.<a name="line.170"></a>
+<span class="sourceLineNo">171</span> * <p><a name="line.171"></a>
+<span class="sourceLineNo">172</span> * Calling {@link #addObject} or
{@link #borrowObject} after invoking this<a name="line.172"></a>
+<span class="sourceLineNo">173</span> * method on a pool will cause them
to throw an {@link IllegalStateException}.<a name="line.173"></a>
+<span class="sourceLineNo">174</span> * <p><a name="line.174"></a>
+<span class="sourceLineNo">175</span> * Implementations should silently
fail if not all resources can be freed.<a name="line.175"></a>
+<span class="sourceLineNo">176</span> */<a name="line.176"></a>
+<span class="sourceLineNo">177</span> void close();<a name="line.177"></a>
+<span class="sourceLineNo">178</span>}<a name="line.178"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
\ No newline at end of file
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/ObjectPool.html
------------------------------------------------------------------------------
svn:eol-style = native
