All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.pool2.BasePooledObjectFactory Maven / Gradle / Ivy

There is a newer version: 2.12.0
Show newest version
/*
 * 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 {@code PoolableObjectFactory}.
 * 

* All operations defined here are essentially no-op's. *

* This class is immutable, and therefore thread-safe * * @param Type of element managed in this factory. * * @see PooledObjectFactory * @see BaseKeyedPooledObjectFactory * * @since 2.0 */ public abstract class BasePooledObjectFactory extends BaseObject implements PooledObjectFactory { /** * No-op. * * @param p ignored */ @Override public void activateObject(final PooledObject p) throws Exception { // The default implementation is a no-op. } /** * Creates an object instance, to be wrapped in a {@link PooledObject}. *

This method must support concurrent, multi-threaded * activation.

* * @return an instance to be served by the pool * * @throws Exception if there is a problem creating a new instance, * this will be propagated to the code requesting an object. */ public abstract T create() throws Exception; /** * No-op. * * @param p ignored */ @Override public void destroyObject(final PooledObject p) throws Exception { // The default implementation is a no-op. } @Override public PooledObject makeObject() throws Exception { return wrap(create()); } /** * No-op. * * @param p ignored */ @Override public void passivateObject(final PooledObject p) throws Exception { // The default implementation is a no-op. } /** * This implementation always returns {@code true}. * * @param p ignored * * @return {@code true} */ @Override public boolean validateObject(final PooledObject p) { return true; } /** * Wrap the provided instance with an implementation of * {@link PooledObject}. * * @param obj the instance to wrap * * @return The provided instance, wrapped by a {@link PooledObject} */ public abstract PooledObject wrap(T obj); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy