Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.apache.commons.pool;

A simple base implementation of ObjectPool. Optional operations are implemented to either do nothing, return a value indicating it is unsupported or throw java.lang.UnsupportedOperationException.

Parameters:
<T> the type of objects held in this pool
Author(s):
Rodney Waldhoff
Sandy McArthur
Version:
$Revision: 1222396 $ $Date: 2011-12-22 14:02:25 -0500 (Thu, 22 Dec 2011) $
Since:
Pool 1.0
 
 public abstract class BaseObjectPool<T> implements ObjectPool<T> {
    
Obtains an instance from the pool.

Returns:
an instance from the pool
Throws:
java.lang.Exception if an instance cannot be obtained from the pool
 
     public abstract T borrowObject() throws Exception;
    
    
Returns an instance to the pool.

Parameters:
obj instance to return to the pool
 
     public abstract void returnObject(T objthrows Exception;
    
    

Invalidates an object from the pool.

By contract, obj must have been obtained using borrowObject.

This method should be used when an object that has been borrowed is determined (due to an exception or other problem) to be invalid.

Parameters:
obj a borrowed instance to be disposed.
Throws:
java.lang.Exception
 
     public abstract void invalidateObject(T objthrows Exception;

    
Not supported in this base implementation.

Returns:
a negative value.
Throws:
java.lang.UnsupportedOperationException
 
     public int getNumIdle() throws UnsupportedOperationException {
         return -1;
     }

    
Not supported in this base implementation.

Returns:
a negative value.
Throws:
java.lang.UnsupportedOperationException
 
     public int getNumActive() throws UnsupportedOperationException {
         return -1;
     }

    
Not supported in this base implementation.

 
     public void clear() throws ExceptionUnsupportedOperationException {
         throw new UnsupportedOperationException();
     }

    
Not supported in this base implementation. Always throws an java.lang.UnsupportedOperationException, subclasses should override this behavior.

 
     public void addObject() throws ExceptionUnsupportedOperationException {
         throw new UnsupportedOperationException();
    }

    
Close this pool. This affects the behavior of isClosed and assertOpen.
    public void close() throws Exception {
         = true;
    }

    
Not supported in this base implementation. Always throws an java.lang.UnsupportedOperationException, subclasses should override this behavior.

Deprecated:
to be removed in pool 2.0
Parameters:
factory the PoolableObjectFactory
Throws:
java.lang.UnsupportedOperationException
java.lang.IllegalStateException
    @Deprecated
        throw new UnsupportedOperationException();
    }

    
Has this pool instance been closed.

Returns:
true when this pool has been closed.
    public final boolean isClosed() {
        return ;
    }

    
Throws an IllegalStateException when this pool has been closed.

Throws:
java.lang.IllegalStateException when this pool has been closed.
See also:
isClosed()
    protected final void assertOpen() throws IllegalStateException {
        if (isClosed()) {
            throw new IllegalStateException("Pool not open");
        }
    }

    
Whether or not the pool is closed
    private volatile boolean closed = false;
New to GrepCode? Check out our FAQ X