Package org.opensearch.common.lifecycle

Class AbstractLifecycleComponent

java.lang.Object

org.opensearch.common.lifecycle.AbstractLifecycleComponent

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable, LifecycleComponent

public abstract class AbstractLifecycleComponent
extends Object
implements LifecycleComponent

Base class for a lifecycle component.

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
protected final Lifecycle	lifecycle

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLifecycleComponent()

Method Summary

Modifier and Type	Method	Description
void	addLifecycleListener(LifecycleListener listener)
void	close()
protected abstract void	doClose()
protected abstract void	doStart()
protected abstract void	doStop()
Lifecycle.State	lifecycleState()
void	removeLifecycleListener(LifecycleListener listener)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Details

lifecycle

protected final Lifecycle lifecycle

Constructor Details

AbstractLifecycleComponent

protected AbstractLifecycleComponent()

Method Details

lifecycleState

public Lifecycle.State lifecycleState()

Specified by:

lifecycleState in interface LifecycleComponent

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)

Specified by:

addLifecycleListener in interface LifecycleComponent

removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)

Specified by:

removeLifecycleListener in interface LifecycleComponent

start

public void start()

Specified by:

start in interface LifecycleComponent

doStart

protected abstract void doStart()

stop

public void stop()

Specified by:

stop in interface LifecycleComponent

doStop

protected abstract void doStop()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

doClose

protected abstract void doClose()
                         throws IOException

Throws:

IOException