org.picocontainer.LifecycleStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of picocontainer-debug Show documentation
There is a newer version: 2.15
/*****************************************************************************
 * Copyright (C) PicoContainer Organization. All rights reserved.            *
 * ------------------------------------------------------------------------- *
 * The software in this package is published under the terms of the BSD      *
 * style license a copy of which has been included with this distribution in *
 * the LICENSE.txt file.                                                     *
 *****************************************************************************/
package org.picocontainer;

/**
 * An interface which specifies the lifecycle strategy on the component instance.
 * Lifecycle strategies are used by component adapters to delegate the lifecycle
 * operations on the component instances.
 *
 * @author Paul Hammant
 * @author Peter Royal
 * @author Jörg Schaible
 * @author Mauro Talevi
 * @see org.picocontainer.Startable
 * @see org.picocontainer.Disposable
 */
public interface LifecycleStrategy {
    
    /**
     * Invoke the "start" method on the component instance if this is startable.
     * It is up to the implementation of the strategy what "start" and "startable" means.
     * 
     * @param component the instance of the component to start
     */
    void start(Object component);
    
    /**
     * Invoke the "stop" method on the component instance if this is stoppable.
     * It is up to the implementation of the strategy what "stop" and "stoppable" means.
     * 
     * @param component the instance of the component to stop
     */
    void stop(Object component);

    /**
     * Invoke the "dispose" method on the component instance if this is disposable.
     * It is up to the implementation of the strategy what "dispose" and "disposable" means.
     * 
     * @param component the instance of the component to dispose
     */
    void dispose(Object component);

    /**
     * Test if a component instance has a lifecycle.
     * @param type the component's type
     * 
     * @return true if the component has a lifecycle
     */
    boolean hasLifecycle(Class type);

    /**
     * Is a component eager (not lazy) in that it should start when start() or equivalent is called,
     * or lazy (it will only start on first getComponent() ).
     * The default is the first of those two.
     *
     * @param adapter
     * @return true if lazy, false if not lazy
     */
    boolean isLazy(ComponentAdapter adapter);
}