keyedobjectpool.html

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

<a name="98" href="#98">98</a>  <em>     * If the connection should be validated before or after borrowing,</em>
<a name="99" href="#99">99</a>  <em>     * then the {@link PoolableObjectFactory#validateObject} method should be</em>
<a name="100" href="#100">100</a> <em>     * used instead.</em>
<a name="101" href="#101">101</a> <em>     *</em>
<a name="102" href="#102">102</a> <em>     * @param obj a {@link #borrowObject borrowed} instance to be returned.</em>
<a name="103" href="#103">103</a> <em>     */</em>
<a name="104" href="#104">104</a>     <strong>void</strong> invalidateObject(Object key, Object obj) throws Exception;
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em>/**<em>*</em></em>
<a name="107" href="#107">107</a> <em>     * Create an object using my {@link #setFactory factory} or other</em>
<a name="108" href="#108">108</a> <em>     * implementation dependent mechanism, and place it into the pool.</em>
<a name="109" href="#109">109</a> <em>     * addObject() is useful for "pre-loading" a pool with idle objects.</em>
<a name="110" href="#110">110</a> <em>     * (Optional operation).</em>
<a name="111" href="#111">111</a> <em>     */</em>
<a name="112" href="#112">112</a>     <strong>void</strong> addObject(Object key) throws Exception;
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a>     <em>/**<em>*</em></em>
<a name="115" href="#115">115</a> <em>     * Returns the number of instances</em>
<a name="116" href="#116">116</a> <em>     * corresponding to the given &lt;i>key&lt;/i></em>
<a name="117" href="#117">117</a> <em>     * currently idle in my pool (optional operation).</em>
<a name="118" href="#118">118</a> <em>     * Throws {@link UnsupportedOperationException}</em>
<a name="119" href="#119">119</a> <em>     * if this information is not available.</em>
<a name="120" href="#120">120</a> <em>     *</em>
<a name="121" href="#121">121</a> <em>     * @param key the key</em>
<a name="122" href="#122">122</a> <em>     * @return the number of instances corresponding to the given &lt;i>key&lt;/i> currently idle in my pool</em>
<a name="123" href="#123">123</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="124" href="#124">124</a> <em>     */</em>
<a name="125" href="#125">125</a>     <strong>int</strong> getNumIdle(Object key) throws UnsupportedOperationException;
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>     <em>/**<em>*</em></em>
<a name="128" href="#128">128</a> <em>     * Returns the number of instances</em>
<a name="129" href="#129">129</a> <em>     * currently borrowed from but not yet returned</em>
<a name="130" href="#130">130</a> <em>     * to my pool corresponding to the</em>
<a name="131" href="#131">131</a> <em>     * given &lt;i>key&lt;/i> (optional operation).</em>
<a name="132" href="#132">132</a> <em>     * Throws {@link UnsupportedOperationException}</em>
<a name="133" href="#133">133</a> <em>     * if this information is not available.</em>
<a name="134" href="#134">134</a> <em>     *</em>
<a name="135" href="#135">135</a> <em>     * @param key the key</em>
<a name="136" href="#136">136</a> <em>     * @return the number of instances corresponding to the given &lt;i>key&lt;/i> currently borrowed in my pool</em>
<a name="137" href="#137">137</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="138" href="#138">138</a> <em>     */</em>
<a name="139" href="#139">139</a>     <strong>int</strong> getNumActive(Object key) throws UnsupportedOperationException;
<a name="140" href="#140">140</a> 
<a name="141" href="#141">141</a>     <em>/**<em>*</em></em>
<a name="142" href="#142">142</a> <em>     * Returns the total number of instances</em>
<a name="143" href="#143">143</a> <em>     * currently idle in my pool (optional operation).</em>
<a name="144" href="#144">144</a> <em>     * Throws {@link UnsupportedOperationException}</em>
<a name="145" href="#145">145</a> <em>     * if this information is not available.</em>
<a name="146" href="#146">146</a> <em>     *</em>
<a name="147" href="#147">147</a> <em>     * @return the total number of instances currently idle in my pool</em>
<a name="148" href="#148">148</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="149" href="#149">149</a> <em>     */</em>
<a name="150" href="#150">150</a>     <strong>int</strong> getNumIdle() throws UnsupportedOperationException;
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>     <em>/**<em>*</em></em>
<a name="153" href="#153">153</a> <em>     * Returns the total number of instances</em>
<a name="154" href="#154">154</a> <em>     * current borrowed from my pool but not</em>
<a name="155" href="#155">155</a> <em>     * yet returned (optional operation).</em>
<a name="156" href="#156">156</a> <em>     * Throws {@link UnsupportedOperationException}</em>
<a name="157" href="#157">157</a> <em>     * if this information is not available.</em>
<a name="158" href="#158">158</a> <em>     *</em>
<a name="159" href="#159">159</a> <em>     * @return the total number of instances currently borrowed from my pool</em>
<a name="160" href="#160">160</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="161" href="#161">161</a> <em>     */</em>
<a name="162" href="#162">162</a>     <strong>int</strong> getNumActive() throws UnsupportedOperationException;
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>     <em>/**<em>*</em></em>
<a name="165" href="#165">165</a> <em>     * Clears my pool, removing all pooled instances</em>
<a name="166" href="#166">166</a> <em>     * (optional operation).</em>
<a name="167" href="#167">167</a> <em>     * Throws {@link UnsupportedOperationException}</em>
<a name="168" href="#168">168</a> <em>     * if the pool cannot be cleared.</em>
<a name="169" href="#169">169</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="170" href="#170">170</a> <em>     */</em>
<a name="171" href="#171">171</a>     <strong>void</strong> clear() throws Exception, UnsupportedOperationException;
<a name="172" href="#172">172</a> 
<a name="173" href="#173">173</a>     <em>/**<em>*</em></em>
<a name="174" href="#174">174</a> <em>     * Clears the specified pool, removing all</em>
<a name="175" href="#175">175</a> <em>     * pooled instances corresponding to</em>
<a name="176" href="#176">176</a> <em>     * the given &lt;i>key&lt;/i>  (optional operation).</em>
<a name="177" href="#177">177</a> <em>     * Throws {@link UnsupportedOperationException}</em>
<a name="178" href="#178">178</a> <em>     * if the pool cannot be cleared.</em>
<a name="179" href="#179">179</a> <em>     * @param key the key to clear</em>
<a name="180" href="#180">180</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="181" href="#181">181</a> <em>     */</em>
<a name="182" href="#182">182</a>     <strong>void</strong> clear(Object key) throws Exception, UnsupportedOperationException;
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>     <em>/**<em>*</em></em>
<a name="185" href="#185">185</a> <em>     * Close this pool, and free any resources associated with it.</em>
<a name="186" href="#186">186</a> <em>     */</em>
<a name="187" href="#187">187</a>     <strong>void</strong> close() throws Exception;
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>     <em>/**<em>*</em></em>
<a name="190" href="#190">190</a> <em>     * Sets the {@link KeyedPoolableObjectFactory factory} I use</em>
<a name="191" href="#191">191</a> <em>     * to create new instances (optional operation).</em>
<a name="192" href="#192">192</a> <em>     * @param factory the {@link KeyedPoolableObjectFactory} I use to create new instances.</em>
<a name="193" href="#193">193</a> <em>     * @throws IllegalStateException when the factory cannot be set at this time</em>
<a name="194" href="#194">194</a> <em>     * @throws UnsupportedOperationException when this implementation doesn't support the operation</em>
<a name="195" href="#195">195</a> <em>     */</em>
<a name="196" href="#196">196</a>     <strong>void</strong> setFactory(<a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html">KeyedPoolableObjectFactory</a> factory) throws IllegalStateException, UnsupportedOperationException;
<a name="197" href="#197">197</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>