Propchange: websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPool.html ------------------------------------------------------------------------------ svn:eol-style = native
Added: websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPoolConfig.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPoolConfig.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPoolConfig.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,218 @@ +<!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.impl;<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 simple "struct" encapsulating the configuration for a<a name="line.20"></a> +<span class="sourceLineNo">021</span> * {@link GenericObjectPool}.<a name="line.21"></a> +<span class="sourceLineNo">022</span> *<a name="line.22"></a> +<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> +<span class="sourceLineNo">024</span> * This class is not thread-safe; it is only intended to be used to provide<a name="line.24"></a> +<span class="sourceLineNo">025</span> * attributes used when creating a pool.<a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * @version $Revision: $<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * @since 2.0<a name="line.29"></a> +<span class="sourceLineNo">030</span> */<a name="line.30"></a> +<span class="sourceLineNo">031</span>public class GenericObjectPoolConfig extends BaseObjectPoolConfig {<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * The default value for the {@code maxTotal} configuration attribute.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * @see GenericObjectPool#getMaxTotal()<a name="line.35"></a> +<span class="sourceLineNo">036</span> */<a name="line.36"></a> +<span class="sourceLineNo">037</span> public static final int DEFAULT_MAX_TOTAL = 8;<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span> /**<a name="line.39"></a> +<span class="sourceLineNo">040</span> * The default value for the {@code maxIdle} configuration attribute.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @see GenericObjectPool#getMaxIdle()<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> public static final int DEFAULT_MAX_IDLE = 8;<a name="line.43"></a> +<span class="sourceLineNo">044</span><a name="line.44"></a> +<span class="sourceLineNo">045</span> /**<a name="line.45"></a> +<span class="sourceLineNo">046</span> * The default value for the {@code minIdle} configuration attribute.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @see GenericObjectPool#getMinIdle()<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span> public static final int DEFAULT_MIN_IDLE = 0;<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> private int maxTotal = DEFAULT_MAX_TOTAL;<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> private int maxIdle = DEFAULT_MAX_IDLE;<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> private int minIdle = DEFAULT_MIN_IDLE;<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * Get the value for the {@code maxTotal} configuration attribute<a name="line.59"></a> +<span class="sourceLineNo">060</span> * for pools created with this configuration instance.<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @return The current setting of {@code maxTotal} for this<a name="line.62"></a> +<span class="sourceLineNo">063</span> * configuration instance<a name="line.63"></a> +<span class="sourceLineNo">064</span> *<a name="line.64"></a> +<span class="sourceLineNo">065</span> * @see GenericObjectPool#getMaxTotal()<a name="line.65"></a> +<span class="sourceLineNo">066</span> */<a name="line.66"></a> +<span class="sourceLineNo">067</span> public int getMaxTotal() {<a name="line.67"></a> +<span class="sourceLineNo">068</span> return maxTotal;<a name="line.68"></a> +<span class="sourceLineNo">069</span> }<a name="line.69"></a> +<span class="sourceLineNo">070</span><a name="line.70"></a> +<span class="sourceLineNo">071</span> /**<a name="line.71"></a> +<span class="sourceLineNo">072</span> * Set the value for the {@code maxTotal} configuration attribute for<a name="line.72"></a> +<span class="sourceLineNo">073</span> * pools created with this configuration instance.<a name="line.73"></a> +<span class="sourceLineNo">074</span> *<a name="line.74"></a> +<span class="sourceLineNo">075</span> * @param maxTotal The new setting of {@code maxTotal}<a name="line.75"></a> +<span class="sourceLineNo">076</span> * for this configuration instance<a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * @see GenericObjectPool#setMaxTotal(int)<a name="line.78"></a> +<span class="sourceLineNo">079</span> */<a name="line.79"></a> +<span class="sourceLineNo">080</span> public void setMaxTotal(int maxTotal) {<a name="line.80"></a> +<span class="sourceLineNo">081</span> this.maxTotal = maxTotal;<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<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> * Get the value for the {@code maxIdle} configuration attribute<a name="line.86"></a> +<span class="sourceLineNo">087</span> * for pools created with this configuration instance.<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @return The current setting of {@code maxIdle} for this<a name="line.89"></a> +<span class="sourceLineNo">090</span> * configuration instance<a name="line.90"></a> +<span class="sourceLineNo">091</span> *<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @see GenericObjectPool#getMaxIdle()<a name="line.92"></a> +<span class="sourceLineNo">093</span> */<a name="line.93"></a> +<span class="sourceLineNo">094</span> public int getMaxIdle() {<a name="line.94"></a> +<span class="sourceLineNo">095</span> return maxIdle;<a name="line.95"></a> +<span class="sourceLineNo">096</span> }<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * Set the value for the {@code maxIdle} configuration attribute for<a name="line.99"></a> +<span class="sourceLineNo">100</span> * pools created with this configuration instance.<a name="line.100"></a> +<span class="sourceLineNo">101</span> *<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param maxIdle The new setting of {@code maxIdle}<a name="line.102"></a> +<span class="sourceLineNo">103</span> * for this configuration instance<a name="line.103"></a> +<span class="sourceLineNo">104</span> *<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @see GenericObjectPool#setMaxIdle(int)<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> public void setMaxIdle(int maxIdle) {<a name="line.107"></a> +<span class="sourceLineNo">108</span> this.maxIdle = maxIdle;<a name="line.108"></a> +<span class="sourceLineNo">109</span> }<a name="line.109"></a> +<span class="sourceLineNo">110</span><a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> /**<a name="line.112"></a> +<span class="sourceLineNo">113</span> * Get the value for the {@code minIdle} configuration attribute<a name="line.113"></a> +<span class="sourceLineNo">114</span> * for pools created with this configuration instance.<a name="line.114"></a> +<span class="sourceLineNo">115</span> *<a name="line.115"></a> +<span class="sourceLineNo">116</span> * @return The current setting of {@code minIdle} for this<a name="line.116"></a> +<span class="sourceLineNo">117</span> * configuration instance<a name="line.117"></a> +<span class="sourceLineNo">118</span> *<a name="line.118"></a> +<span class="sourceLineNo">119</span> * @see GenericObjectPool#getMinIdle()<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> public int getMinIdle() {<a name="line.121"></a> +<span class="sourceLineNo">122</span> return minIdle;<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> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * Set the value for the {@code minIdle} configuration attribute for<a name="line.126"></a> +<span class="sourceLineNo">127</span> * pools created with this configuration instance.<a name="line.127"></a> +<span class="sourceLineNo">128</span> *<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @param minIdle The new setting of {@code minIdle}<a name="line.129"></a> +<span class="sourceLineNo">130</span> * for this configuration instance<a name="line.130"></a> +<span class="sourceLineNo">131</span> *<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @see GenericObjectPool#setMinIdle(int)<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> public void setMinIdle(int minIdle) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> this.minIdle = minIdle;<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> @Override<a name="line.138"></a> +<span class="sourceLineNo">139</span> public GenericObjectPoolConfig clone() {<a name="line.139"></a> +<span class="sourceLineNo">140</span> try {<a name="line.140"></a> +<span class="sourceLineNo">141</span> return (GenericObjectPoolConfig) super.clone();<a name="line.141"></a> +<span class="sourceLineNo">142</span> } catch (CloneNotSupportedException e) {<a name="line.142"></a> +<span class="sourceLineNo">143</span> throw new AssertionError(); // Can't happen<a name="line.143"></a> +<span class="sourceLineNo">144</span> }<a name="line.144"></a> +<span class="sourceLineNo">145</span> }<a name="line.145"></a> +<span class="sourceLineNo">146</span>}<a name="line.146"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</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/impl/GenericObjectPoolConfig.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,293 @@ +<!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.impl;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.util.Set;<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> * Defines the methods that will be made available via JMX.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * NOTE: This interface exists only to define those attributes and methods that<a name="line.24"></a> +<span class="sourceLineNo">025</span> * will be made available via JMX. It must not be implemented by clients<a name="line.25"></a> +<span class="sourceLineNo">026</span> * as it is subject to change between major, minor and patch version<a name="line.26"></a> +<span class="sourceLineNo">027</span> * releases of commons pool. Clients that implement this interface may<a name="line.27"></a> +<span class="sourceLineNo">028</span> * not, therefore, be able to upgrade to a new minor or patch release<a name="line.28"></a> +<span class="sourceLineNo">029</span> * without requiring code changes.<a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * @version $Revision: $<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 interface GenericObjectPoolMXBean {<a name="line.35"></a> +<span class="sourceLineNo">036</span> // Getters for basic configuration settings<a name="line.36"></a> +<span class="sourceLineNo">037</span> /**<a name="line.37"></a> +<span class="sourceLineNo">038</span> * See {@link GenericObjectPool#getBlockWhenExhausted()}<a name="line.38"></a> +<span class="sourceLineNo">039</span> * @return See {@link GenericObjectPool#getBlockWhenExhausted()}<a name="line.39"></a> +<span class="sourceLineNo">040</span> */<a name="line.40"></a> +<span class="sourceLineNo">041</span> boolean getBlockWhenExhausted();<a name="line.41"></a> +<span class="sourceLineNo">042</span> /**<a name="line.42"></a> +<span class="sourceLineNo">043</span> * See {@link GenericObjectPool#getLifo()}<a name="line.43"></a> +<span class="sourceLineNo">044</span> * @return See {@link GenericObjectPool#getLifo()}<a name="line.44"></a> +<span class="sourceLineNo">045</span> */<a name="line.45"></a> +<span class="sourceLineNo">046</span> boolean getFairness();<a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * See {@link GenericObjectPool#getFairness()}<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @return See {@link GenericObjectPool#getFairness()}<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> boolean getLifo();<a name="line.51"></a> +<span class="sourceLineNo">052</span> /**<a name="line.52"></a> +<span class="sourceLineNo">053</span> * See {@link GenericObjectPool#getMaxIdle()}<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @return See {@link GenericObjectPool#getMaxIdle()}<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> int getMaxIdle();<a name="line.56"></a> +<span class="sourceLineNo">057</span> /**<a name="line.57"></a> +<span class="sourceLineNo">058</span> * See {@link GenericObjectPool#getMaxTotal()}<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return See {@link GenericObjectPool#getMaxTotal()}<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> int getMaxTotal();<a name="line.61"></a> +<span class="sourceLineNo">062</span> /**<a name="line.62"></a> +<span class="sourceLineNo">063</span> * See {@link GenericObjectPool#getMaxWaitMillis()}<a name="line.63"></a> +<span class="sourceLineNo">064</span> * @return See {@link GenericObjectPool#getMaxWaitMillis()}<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> long getMaxWaitMillis();<a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * See {@link GenericObjectPool#getMinEvictableIdleTimeMillis()}<a name="line.68"></a> +<span class="sourceLineNo">069</span> * @return See {@link GenericObjectPool#getMinEvictableIdleTimeMillis()}<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> long getMinEvictableIdleTimeMillis();<a name="line.71"></a> +<span class="sourceLineNo">072</span> /**<a name="line.72"></a> +<span class="sourceLineNo">073</span> * See {@link GenericObjectPool#getMinIdle()}<a name="line.73"></a> +<span class="sourceLineNo">074</span> * @return See {@link GenericObjectPool#getMinIdle()}<a name="line.74"></a> +<span class="sourceLineNo">075</span> */<a name="line.75"></a> +<span class="sourceLineNo">076</span> int getMinIdle();<a name="line.76"></a> +<span class="sourceLineNo">077</span> /**<a name="line.77"></a> +<span class="sourceLineNo">078</span> * See {@link GenericObjectPool#getNumActive()}<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @return See {@link GenericObjectPool#getNumActive()}<a name="line.79"></a> +<span class="sourceLineNo">080</span> */<a name="line.80"></a> +<span class="sourceLineNo">081</span> int getNumActive();<a name="line.81"></a> +<span class="sourceLineNo">082</span> /**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * See {@link GenericObjectPool#getNumIdle()}<a name="line.83"></a> +<span class="sourceLineNo">084</span> * @return See {@link GenericObjectPool#getNumIdle()}<a name="line.84"></a> +<span class="sourceLineNo">085</span> */<a name="line.85"></a> +<span class="sourceLineNo">086</span> int getNumIdle();<a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * See {@link GenericObjectPool#getNumTestsPerEvictionRun()}<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @return See {@link GenericObjectPool#getNumTestsPerEvictionRun()}<a name="line.89"></a> +<span class="sourceLineNo">090</span> */<a name="line.90"></a> +<span class="sourceLineNo">091</span> int getNumTestsPerEvictionRun();<a name="line.91"></a> +<span class="sourceLineNo">092</span> /**<a name="line.92"></a> +<span class="sourceLineNo">093</span> * See {@link GenericObjectPool#getTestOnCreate()}<a name="line.93"></a> +<span class="sourceLineNo">094</span> * @return See {@link GenericObjectPool#getTestOnCreate()}<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @since 2.2<a name="line.95"></a> +<span class="sourceLineNo">096</span> */<a name="line.96"></a> +<span class="sourceLineNo">097</span> boolean getTestOnCreate();<a name="line.97"></a> +<span class="sourceLineNo">098</span> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * See {@link GenericObjectPool#getTestOnBorrow()}<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @return See {@link GenericObjectPool#getTestOnBorrow()}<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> boolean getTestOnBorrow();<a name="line.102"></a> +<span class="sourceLineNo">103</span> /**<a name="line.103"></a> +<span class="sourceLineNo">104</span> * See {@link GenericObjectPool#getTestOnReturn()}<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @return See {@link GenericObjectPool#getTestOnReturn()}<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> boolean getTestOnReturn();<a name="line.107"></a> +<span class="sourceLineNo">108</span> /**<a name="line.108"></a> +<span class="sourceLineNo">109</span> * See {@link GenericObjectPool#getTestWhileIdle()}<a name="line.109"></a> +<span class="sourceLineNo">110</span> * @return See {@link GenericObjectPool#getTestWhileIdle()}<a name="line.110"></a> +<span class="sourceLineNo">111</span> */<a name="line.111"></a> +<span class="sourceLineNo">112</span> boolean getTestWhileIdle();<a name="line.112"></a> +<span class="sourceLineNo">113</span> /**<a name="line.113"></a> +<span class="sourceLineNo">114</span> * See {@link GenericObjectPool#getTimeBetweenEvictionRunsMillis()}<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @return See {@link GenericObjectPool#getTimeBetweenEvictionRunsMillis()}<a name="line.115"></a> +<span class="sourceLineNo">116</span> */<a name="line.116"></a> +<span class="sourceLineNo">117</span> long getTimeBetweenEvictionRunsMillis();<a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * See {@link GenericObjectPool#isClosed()}<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @return See {@link GenericObjectPool#isClosed()}<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> boolean isClosed();<a name="line.122"></a> +<span class="sourceLineNo">123</span> // Getters for monitoring attributes<a name="line.123"></a> +<span class="sourceLineNo">124</span> /**<a name="line.124"></a> +<span class="sourceLineNo">125</span> * See {@link GenericObjectPool#getBorrowedCount()}<a name="line.125"></a> +<span class="sourceLineNo">126</span> * @return See {@link GenericObjectPool#getBorrowedCount()}<a name="line.126"></a> +<span class="sourceLineNo">127</span> */<a name="line.127"></a> +<span class="sourceLineNo">128</span> long getBorrowedCount();<a name="line.128"></a> +<span class="sourceLineNo">129</span> /**<a name="line.129"></a> +<span class="sourceLineNo">130</span> * See {@link GenericObjectPool#getReturnedCount()}<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @return See {@link GenericObjectPool#getReturnedCount()}<a name="line.131"></a> +<span class="sourceLineNo">132</span> */<a name="line.132"></a> +<span class="sourceLineNo">133</span> long getReturnedCount();<a name="line.133"></a> +<span class="sourceLineNo">134</span> /**<a name="line.134"></a> +<span class="sourceLineNo">135</span> * See {@link GenericObjectPool#getCreatedCount()}<a name="line.135"></a> +<span class="sourceLineNo">136</span> * @return See {@link GenericObjectPool#getCreatedCount()}<a name="line.136"></a> +<span class="sourceLineNo">137</span> */<a name="line.137"></a> +<span class="sourceLineNo">138</span> long getCreatedCount();<a name="line.138"></a> +<span class="sourceLineNo">139</span> /**<a name="line.139"></a> +<span class="sourceLineNo">140</span> * See {@link GenericObjectPool#getDestroyedCount()}<a name="line.140"></a> +<span class="sourceLineNo">141</span> * @return See {@link GenericObjectPool#getDestroyedCount()}<a name="line.141"></a> +<span class="sourceLineNo">142</span> */<a name="line.142"></a> +<span class="sourceLineNo">143</span> long getDestroyedCount();<a name="line.143"></a> +<span class="sourceLineNo">144</span> /**<a name="line.144"></a> +<span class="sourceLineNo">145</span> * See {@link GenericObjectPool#getDestroyedByEvictorCount()}<a name="line.145"></a> +<span class="sourceLineNo">146</span> * @return See {@link GenericObjectPool#getDestroyedByEvictorCount()}<a name="line.146"></a> +<span class="sourceLineNo">147</span> */<a name="line.147"></a> +<span class="sourceLineNo">148</span> long getDestroyedByEvictorCount();<a name="line.148"></a> +<span class="sourceLineNo">149</span> /**<a name="line.149"></a> +<span class="sourceLineNo">150</span> * See {@link GenericObjectPool#getDestroyedByBorrowValidationCount()}<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @return See {@link GenericObjectPool#getDestroyedByBorrowValidationCount()}<a name="line.151"></a> +<span class="sourceLineNo">152</span> */<a name="line.152"></a> +<span class="sourceLineNo">153</span> long getDestroyedByBorrowValidationCount();<a name="line.153"></a> +<span class="sourceLineNo">154</span> /**<a name="line.154"></a> +<span class="sourceLineNo">155</span> * See {@link GenericObjectPool#getMeanActiveTimeMillis()}<a name="line.155"></a> +<span class="sourceLineNo">156</span> * @return See {@link GenericObjectPool#getMeanActiveTimeMillis()}<a name="line.156"></a> +<span class="sourceLineNo">157</span> */<a name="line.157"></a> +<span class="sourceLineNo">158</span> long getMeanActiveTimeMillis();<a name="line.158"></a> +<span class="sourceLineNo">159</span> /**<a name="line.159"></a> +<span class="sourceLineNo">160</span> * See {@link GenericObjectPool#getMeanIdleTimeMillis()}<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @return See {@link GenericObjectPool#getMeanIdleTimeMillis()}<a name="line.161"></a> +<span class="sourceLineNo">162</span> */<a name="line.162"></a> +<span class="sourceLineNo">163</span> long getMeanIdleTimeMillis();<a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * See {@link GenericObjectPool#getMeanBorrowWaitTimeMillis()}<a name="line.165"></a> +<span class="sourceLineNo">166</span> * @return See {@link GenericObjectPool#getMeanBorrowWaitTimeMillis()}<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> long getMeanBorrowWaitTimeMillis();<a name="line.168"></a> +<span class="sourceLineNo">169</span> /**<a name="line.169"></a> +<span class="sourceLineNo">170</span> * See {@link GenericObjectPool#getMaxBorrowWaitTimeMillis()}<a name="line.170"></a> +<span class="sourceLineNo">171</span> * @return See {@link GenericObjectPool#getMaxBorrowWaitTimeMillis()}<a name="line.171"></a> +<span class="sourceLineNo">172</span> */<a name="line.172"></a> +<span class="sourceLineNo">173</span> long getMaxBorrowWaitTimeMillis();<a name="line.173"></a> +<span class="sourceLineNo">174</span> /**<a name="line.174"></a> +<span class="sourceLineNo">175</span> * See {@link GenericObjectPool#getCreationStackTrace()}<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @return See {@link GenericObjectPool#getCreationStackTrace()}<a name="line.176"></a> +<span class="sourceLineNo">177</span> */<a name="line.177"></a> +<span class="sourceLineNo">178</span> String getCreationStackTrace();<a name="line.178"></a> +<span class="sourceLineNo">179</span> /**<a name="line.179"></a> +<span class="sourceLineNo">180</span> * See {@link GenericObjectPool#getNumWaiters()}<a name="line.180"></a> +<span class="sourceLineNo">181</span> * @return See {@link GenericObjectPool#getNumWaiters()}<a name="line.181"></a> +<span class="sourceLineNo">182</span> */<a name="line.182"></a> +<span class="sourceLineNo">183</span> int getNumWaiters();<a name="line.183"></a> +<span class="sourceLineNo">184</span><a name="line.184"></a> +<span class="sourceLineNo">185</span> // Getters for abandoned object removal configuration<a name="line.185"></a> +<span class="sourceLineNo">186</span> /**<a name="line.186"></a> +<span class="sourceLineNo">187</span> * See {@link GenericObjectPool#isAbandonedConfig()}<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @return See {@link GenericObjectPool#isAbandonedConfig()}<a name="line.188"></a> +<span class="sourceLineNo">189</span> */<a name="line.189"></a> +<span class="sourceLineNo">190</span> boolean isAbandonedConfig();<a name="line.190"></a> +<span class="sourceLineNo">191</span> /**<a name="line.191"></a> +<span class="sourceLineNo">192</span> * See {@link GenericObjectPool#getLogAbandoned()}<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @return See {@link GenericObjectPool#getLogAbandoned()}<a name="line.193"></a> +<span class="sourceLineNo">194</span> */<a name="line.194"></a> +<span class="sourceLineNo">195</span> boolean getLogAbandoned();<a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * See {@link GenericObjectPool#getRemoveAbandonedOnBorrow()}<a name="line.197"></a> +<span class="sourceLineNo">198</span> * @return See {@link GenericObjectPool#getRemoveAbandonedOnBorrow()}<a name="line.198"></a> +<span class="sourceLineNo">199</span> */<a name="line.199"></a> +<span class="sourceLineNo">200</span> boolean getRemoveAbandonedOnBorrow();<a name="line.200"></a> +<span class="sourceLineNo">201</span> /**<a name="line.201"></a> +<span class="sourceLineNo">202</span> * See {@link GenericObjectPool#getRemoveAbandonedOnMaintenance()}<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @return See {@link GenericObjectPool#getRemoveAbandonedOnMaintenance()}<a name="line.203"></a> +<span class="sourceLineNo">204</span> */<a name="line.204"></a> +<span class="sourceLineNo">205</span> boolean getRemoveAbandonedOnMaintenance();<a name="line.205"></a> +<span class="sourceLineNo">206</span> /**<a name="line.206"></a> +<span class="sourceLineNo">207</span> * See {@link GenericObjectPool#getRemoveAbandonedTimeout()}<a name="line.207"></a> +<span class="sourceLineNo">208</span> * @return See {@link GenericObjectPool#getRemoveAbandonedTimeout()}<a name="line.208"></a> +<span class="sourceLineNo">209</span> */<a name="line.209"></a> +<span class="sourceLineNo">210</span> int getRemoveAbandonedTimeout();<a name="line.210"></a> +<span class="sourceLineNo">211</span> /**<a name="line.211"></a> +<span class="sourceLineNo">212</span> * See {@link GenericObjectPool#getFactoryType()}<a name="line.212"></a> +<span class="sourceLineNo">213</span> * @return See {@link GenericObjectPool#getFactoryType()}<a name="line.213"></a> +<span class="sourceLineNo">214</span> */<a name="line.214"></a> +<span class="sourceLineNo">215</span> public String getFactoryType();<a name="line.215"></a> +<span class="sourceLineNo">216</span> /**<a name="line.216"></a> +<span class="sourceLineNo">217</span> * See {@link GenericObjectPool#listAllObjects()}<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @return See {@link GenericObjectPool#listAllObjects()}<a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> Set<DefaultPooledObjectInfo> listAllObjects();<a name="line.220"></a> +<span class="sourceLineNo">221</span>}<a name="line.221"></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/impl/GenericObjectPoolMXBean.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/PooledSoftReference.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/PooledSoftReference.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/src-html/org/apache/commons/pool2/impl/PooledSoftReference.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,172 @@ +<!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.impl;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.lang.ref.SoftReference;<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> * Extension of {@link DefaultPooledObject} to wrap pooled soft references.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p>This class is intended to be thread-safe.</p><a name="line.24"></a> +<span class="sourceLineNo">025</span> *<a name="line.25"></a> +<span class="sourceLineNo">026</span> * @param <T> the type of the underlying object that the wrapped SoftReference<a name="line.26"></a> +<span class="sourceLineNo">027</span> * refers to.<a name="line.27"></a> +<span class="sourceLineNo">028</span> *<a name="line.28"></a> +<span class="sourceLineNo">029</span> * @version $Revision: $<a name="line.29"></a> +<span class="sourceLineNo">030</span> *<a name="line.30"></a> +<span class="sourceLineNo">031</span> * @since 2.0<a name="line.31"></a> +<span class="sourceLineNo">032</span> */<a name="line.32"></a> +<span class="sourceLineNo">033</span>public class PooledSoftReference<T> extends DefaultPooledObject<T> {<a name="line.33"></a> +<span class="sourceLineNo">034</span><a name="line.34"></a> +<span class="sourceLineNo">035</span> /** SoftReference wrapped by this object */<a name="line.35"></a> +<span class="sourceLineNo">036</span> private volatile SoftReference<T> reference;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Creates a new PooledSoftReference wrapping the provided reference.<a name="line.39"></a> +<span class="sourceLineNo">040</span> *<a name="line.40"></a> +<span class="sourceLineNo">041</span> * @param reference SoftReference to be managed by the pool<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> public PooledSoftReference(SoftReference<T> reference) {<a name="line.43"></a> +<span class="sourceLineNo">044</span> super(null); // Null the hard reference in the parent<a name="line.44"></a> +<span class="sourceLineNo">045</span> this.reference = reference;<a name="line.45"></a> +<span class="sourceLineNo">046</span> }<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> * Returns the object that the wrapped SoftReference refers to.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * <p><a name="line.50"></a> +<span class="sourceLineNo">051</span> * Note that if the reference has been cleared, this method will return<a name="line.51"></a> +<span class="sourceLineNo">052</span> * null.<a name="line.52"></a> +<span class="sourceLineNo">053</span> *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @return Object referred to by the SoftReference<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> @Override<a name="line.56"></a> +<span class="sourceLineNo">057</span> public T getObject() {<a name="line.57"></a> +<span class="sourceLineNo">058</span> return reference.get();<a name="line.58"></a> +<span class="sourceLineNo">059</span> }<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span> /**<a name="line.61"></a> +<span class="sourceLineNo">062</span> * {@inheritDoc}<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> @Override<a name="line.64"></a> +<span class="sourceLineNo">065</span> public String toString() {<a name="line.65"></a> +<span class="sourceLineNo">066</span> StringBuilder result = new StringBuilder();<a name="line.66"></a> +<span class="sourceLineNo">067</span> result.append("Referenced Object: ");<a name="line.67"></a> +<span class="sourceLineNo">068</span> result.append(getObject().toString());<a name="line.68"></a> +<span class="sourceLineNo">069</span> result.append(", State: ");<a name="line.69"></a> +<span class="sourceLineNo">070</span> synchronized (this) {<a name="line.70"></a> +<span class="sourceLineNo">071</span> result.append(getState().toString());<a name="line.71"></a> +<span class="sourceLineNo">072</span> }<a name="line.72"></a> +<span class="sourceLineNo">073</span> return result.toString();<a name="line.73"></a> +<span class="sourceLineNo">074</span> // TODO add other attributes<a name="line.74"></a> +<span class="sourceLineNo">075</span> // TODO encapsulate state and other attribute display in parent<a name="line.75"></a> +<span class="sourceLineNo">076</span> }<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> /**<a name="line.78"></a> +<span class="sourceLineNo">079</span> * Returns the SoftReference wrapped by this object.<a name="line.79"></a> +<span class="sourceLineNo">080</span> *<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @return underlying SoftReference<a name="line.81"></a> +<span class="sourceLineNo">082</span> */<a name="line.82"></a> +<span class="sourceLineNo">083</span> public synchronized SoftReference<T> getReference() {<a name="line.83"></a> +<span class="sourceLineNo">084</span> return reference;<a name="line.84"></a> +<span class="sourceLineNo">085</span> }<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Sets the wrapped reference.<a name="line.88"></a> +<span class="sourceLineNo">089</span> *<a name="line.89"></a> +<span class="sourceLineNo">090</span> * <p>This method exists to allow a new, non-registered reference to be<a name="line.90"></a> +<span class="sourceLineNo">091</span> * held by the pool to track objects that have been checked out of the pool.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * The actual parameter <strong>should</strong> be a reference to the same<a name="line.92"></a> +<span class="sourceLineNo">093</span> * object that {@link #getObject()} returns before calling this method.</p><a name="line.93"></a> +<span class="sourceLineNo">094</span> *<a name="line.94"></a> +<span class="sourceLineNo">095</span> * @param reference new reference<a name="line.95"></a> +<span class="sourceLineNo">096</span> */<a name="line.96"></a> +<span class="sourceLineNo">097</span> public synchronized void setReference(SoftReference<T> reference) {<a name="line.97"></a> +<span class="sourceLineNo">098</span> this.reference = reference;<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span>}<a name="line.100"></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/impl/PooledSoftReference.html ------------------------------------------------------------------------------ svn:eol-style = native