src/java/org/apache/jcs/utils/threads/IThreadPoolRunnable.java

package org.apache.jcs.utils.threads;


/*
 * Copyright 2001-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.
 */


/**
 * Implemented if you want to run a piece of code inside a thread pool. * A
 * thread pool that is trying to copy the apache process management. asmuts --
 * Pulled out of tomcat, since it seems to move around and hide. Trying to
 * reduce the number of dependencies
 *
 */
public interface IThreadPoolRunnable
{
    // XXX use notes or a hashtable-like
    // Important: ThreadData in JDK1.2 is implemented as a Hashtable( Thread -> object ),
    // expensive.

    /**
     * Called when this object is first loaded in the thread pool. Important:
     * all workers in a pool must be of the same type, otherwise the mechanism
     * becomes more complex.
     *
     * @return The initData value
     */
    public Object[] getInitData();

    /**
     * This method will be executed in one of the pool's threads. The thread
     * will be returned to the pool.
     */
    public void runIt( Object thData[] );

}