framework/src/org/apache/tapestry/util/pool/IPoolableAdaptor.java

//  Copyright 2004 The Apache Software Foundation
//
// Licensed 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.tapestry.util.pool;

/**
 *  Defines methods that define an adaptor to provide
 *  {@link org.apache.tapestry.util.pool.IPoolable}
 *  type behavior to arbitrary objects.
 *
 *  @author Howard Lewis Ship
 *  @version $Id$
 *  @since 3.0
 *
 **/

public interface IPoolableAdaptor
{
    /**
     *  Invoked just as an object is returned to the pool; this
     *  allows it to reset any state back to newly initialized.
     * 
     **/
    
    public void resetForPool(Object object);
    
    /**
     *  Invoked when a pooled object is discarded from the pool.
     * 
     **/
    
    public void discardFromPool(Object object);
}