KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > pool > BaseObjectPool


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.apache.commons.pool;
18
19 /**
20  * A simple base impementation of {@link ObjectPool}.
21  * All optional operations are implemented as throwing
22  * {@link UnsupportedOperationException}.
23  *
24  * @author Rodney Waldhoff
25  * @version $Revision$ $Date: 2005-02-26 05:13:28 -0800 (Sat, 26 Feb 2005) $
26  */
27 public abstract class BaseObjectPool implements ObjectPool {
28     public abstract Object JavaDoc borrowObject() throws Exception JavaDoc;
29     public abstract void returnObject(Object JavaDoc obj) throws Exception JavaDoc;
30     public abstract void invalidateObject(Object JavaDoc obj) throws Exception JavaDoc;
31
32     /**
33      * Not supported in this base implementation.
34      */
35     public int getNumIdle() throws UnsupportedOperationException JavaDoc {
36         throw new UnsupportedOperationException JavaDoc();
37     }
38
39     /**
40      * Not supported in this base implementation.
41      */
42     public int getNumActive() throws UnsupportedOperationException JavaDoc {
43         throw new UnsupportedOperationException JavaDoc();
44     }
45
46     /**
47      * Not supported in this base implementation.
48      */
49     public void clear() throws Exception JavaDoc, UnsupportedOperationException JavaDoc {
50         throw new UnsupportedOperationException JavaDoc();
51     }
52
53     /**
54      * Not supported in this base implementation.
55      */
56     public void addObject() throws Exception JavaDoc, UnsupportedOperationException JavaDoc {
57         throw new UnsupportedOperationException JavaDoc();
58     }
59
60     public void close() throws Exception JavaDoc {
61         assertOpen();
62         closed = true;
63     }
64
65     /**
66      * Not supported in this base implementation.
67      */
68     public void setFactory(PoolableObjectFactory factory) throws IllegalStateException JavaDoc, UnsupportedOperationException JavaDoc {
69         throw new UnsupportedOperationException JavaDoc();
70     }
71     
72     protected final boolean isClosed() {
73         return closed;
74     }
75     
76     protected final void assertOpen() throws IllegalStateException JavaDoc {
77         if(isClosed()) {
78             throw new IllegalStateException JavaDoc("Pool not open");
79         }
80     }
81     
82     private boolean closed = false;
83 }
84
Popular Tags