org.apache.commons.pool2.BaseKeyedPooledObjectFactory Maven / Gradle / Ivy
Show all versions of commons-pool2 Show documentation
/*
* 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.pool2;
/**
* A base implementation of KeyedPooledObjectFactory.
*
* All operations defined here are essentially no-op's.
*
* This class is immutable, and therefore thread-safe.
*
* @see KeyedPooledObjectFactory
*
* @param The type of keys managed by this factory.
* @param Type of element managed by this factory.
*
* @version $Revision: 1333925 $
*
* @since 2.0
*/
public abstract class BaseKeyedPooledObjectFactory
implements KeyedPooledObjectFactory {
/**
* Create an instance that can be served by the pool.
*
* @param key the key used when constructing the object
* @return an instance that can be served by the pool
*/
public abstract V create(K key)
throws Exception;
/**
* Wrap the provided instance with an implementation of
* {@link PooledObject}.
*
* @param value the instance to wrap
*
* @return The provided instance, wrapped by a {@link PooledObject}
*/
public abstract PooledObject wrap(V value);
@Override
public PooledObject makeObject(K key) throws Exception {
return wrap(create(key));
}
/**
* Destroy an instance no longer needed by the pool.
*
* The default implementation is a no-op.
*
* @param key the key used when selecting the instance
* @param p a {@code PooledObject} wrapping the the instance to be destroyed
*/
@Override
public void destroyObject(K key, PooledObject p)
throws Exception {
}
/**
* Ensures that the instance is safe to be returned by the pool.
*
* The default implementation always returns true.
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the the instance to be validated
* @return always true in the default implementation
*/
@Override
public boolean validateObject(K key, PooledObject p) {
return true;
}
/**
* Reinitialize an instance to be returned by the pool.
*
* The default implementation is a no-op.
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the the instance to be activated
*/
@Override
public void activateObject(K key, PooledObject p)
throws Exception {
}
/**
* Uninitialize an instance to be returned to the idle object pool.
*
* The default implementation is a no-op.
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the the instance to be passivated
*/
@Override
public void passivateObject(K key, PooledObject p)
throws Exception {
}
}