com.fredhopper.lifecycle

Class Container

java.lang.Object

com.fredhopper.lifecycle.AbstractLifeCycle

com.fredhopper.lifecycle.Container

All Implemented Interfaces:

LifeCycle, Resumable, Stateful, Supplier<State>

public class Container
extends AbstractLifeCycle

A container manages an instance of LifeCycle through its stages potentially in different Threads. It is a common pattern that LifeCycle stages need to occur in a different thread than the current one. Though, this is not a hard restriction.

Author:

bnobakht

Constructor Summary

Constructors

Constructor and Description
Container(LifeCycle lifeCycle) By default, container uses separate threads for life cycle stages and installs a JVM shutdown hook.See Container(LifeCycle, boolean, boolean).
Container(LifeCycle lifeCycle, boolean separateThreads, boolean shutdownHook) C'tor.

Method Summary

Modifier and Type	Method and Description
protected void	doInitLifeCycle() Similar to AbstractLifeCycle.initLifeCycle() for inherited classes.
protected void	doPause() Similar to AbstractLifeCycle.pause() for inherited classes.
protected void	doResume() Similar to AbstractLifeCycle.resume() for inherited classes.
protected void	doStartLifeCycle() Similar to AbstractLifeCycle.startLifeCycle() for inherited classes.
protected void	doStopLifeCycle() Similar to AbstractLifeCycle.stopLifeCycle() for inherited classes.
State	getState()
String	toString()

Methods inherited from class com.fredhopper.lifecycle.AbstractLifeCycle

addStateListener, changeState, getStateListeners, initLifeCycle, pause, publishState, removeStateListener, resume, startLifeCycle, stopLifeCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.fredhopper.lifecycle.Stateful

get

Constructor Detail

Container

public Container(LifeCycle lifeCycle)

By default, container uses separate threads for life cycle stages and installs a JVM shutdown hook.See Container(LifeCycle, boolean, boolean).

Parameters:

lifeCycle - the managed LifeCycle object

Container

public Container(LifeCycle lifeCycle,
                 boolean separateThreads,
                 boolean shutdownHook)

C'tor.

Parameters:

lifeCycle - the managed LifeCycle object

separateThreads - if true, the life cycle methods AbstractLifeCycle.startLifeCycle() and AbstractLifeCycle.stopLifeCycle() will be executed in separate thread each.

shutdownHook - if true, a shutdown hook is installed through Runtime.addShutdownHook(Thread) to stop the managed life cycle object.

Method Detail

getState

public State getState()

Specified by:

getState in interface Stateful

Overrides:

getState in class AbstractLifeCycle

Returns:

the current state

doInitLifeCycle

protected void doInitLifeCycle()
                        throws Exception

Description copied from class: AbstractLifeCycle

Similar to AbstractLifeCycle.initLifeCycle() for inherited classes.

Specified by:

doInitLifeCycle in class AbstractLifeCycle

Throws:

Exception - See AbstractLifeCycle.initLifeCycle()

See Also:

LifeCycle.initLifeCycle()

doStartLifeCycle

protected void doStartLifeCycle()
                         throws Exception

Description copied from class: AbstractLifeCycle

Similar to AbstractLifeCycle.startLifeCycle() for inherited classes.

Specified by:

doStartLifeCycle in class AbstractLifeCycle

Throws:

Exception - See AbstractLifeCycle.startLifeCycle()

See Also:

LifeCycle.startLifeCycle()

doPause

protected void doPause()
                throws Exception

Description copied from class: AbstractLifeCycle

Similar to AbstractLifeCycle.pause() for inherited classes.

Overrides:

doPause in class AbstractLifeCycle

Throws:

Exception - See AbstractLifeCycle.pause()

See Also:

Resumable.pause()

doResume

protected void doResume()
                 throws Exception

Description copied from class: AbstractLifeCycle

Similar to AbstractLifeCycle.resume() for inherited classes.

Overrides:

doResume in class AbstractLifeCycle

Throws:

Exception - See AbstractLifeCycle.resume()

See Also:

Resumable.resume()

doStopLifeCycle

protected void doStopLifeCycle()
                        throws Exception

Description copied from class: AbstractLifeCycle

Similar to AbstractLifeCycle.stopLifeCycle() for inherited classes.

Specified by:

doStopLifeCycle in class AbstractLifeCycle

Throws:

Exception - See AbstractLifeCycle.stopLifeCycle()

See Also:

LifeCycle.stopLifeCycle()

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle