org.picocontainer.Startable Maven / Gradle / Ivy
The newest version!
/*****************************************************************************
* 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.html file. *
* *
* Idea by Rachel Davies, Original code by Aslak Hellesoy and Paul Hammant *
*****************************************************************************/
package org.picocontainer;
/**
* An interface which is implemented by components that can be started and stopped. The {@link Startable#start()}
* must be called at the begin of the component lifecycle. It can be called again only after a call to
* {@link Startable#stop()}. The {@link Startable#stop()} method must be called at the end of the component lifecycle,
* and can further be called after every {@link Startable#start()}. If a component implements the {@link Disposable}
* interface as well, {@link Startable#stop()} should be called before {@link Disposable#dispose()}.
*
* For more advanced and pluggable lifecycle support, see the functionality offered by picocontainer-gems
* subproject.
* @see org.picocontainer.Disposable the Disposable interface if you need to dispose() semantics.
* @author Paul Hammant
* @author Aslak Hellesøy
*/
public interface Startable {
/**
* Start this component. Called initially at the begin of the lifecycle. It can be called again after a stop.
*/
void start();
/**
* Stop this component. Called near the end of the lifecycle. It can be called again after a further start. Implement
* {@link Disposable} if you need a single call at the definite end of the lifecycle.
*/
void stop();
}