Package com.linkedin.alpini.base.registry

Class AbstractShutdownableResource<R>

java.lang.Object

com.linkedin.alpini.base.registry.AbstractShutdownableResource<R>

All Implemented Interfaces:

Shutdownable, ShutdownableResource

Direct Known Subclasses:

SyncShutdownableAdapter

public abstract class AbstractShutdownableResource<R>
extends Object
implements ShutdownableResource

A simplified implementation of a ShutdownableResource.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractShutdownableResource(R object)

Method Summary

Modifier and Type	Method	Description
protected abstract Runnable	constructShutdown(R object)	The constructed runnable must call signalShutdownInitiated() method to indicate that shutdown has started.
final boolean	isShutdown()	Returns true if this resource has been shut down.
final boolean	isTerminated()	Returns true if the resource has completed shutting down.
final void	shutdown()	Starts the shutdown process.
protected final void	signalShutdownInitiated()	Called by the Runnable to indicate that shutdown has started.
final String	toString()
final void	waitForShutdown()	Waits for shutdown to complete
final void	waitForShutdown(long timeoutInMs)	Waits for shutdown to complete with a timeout

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractShutdownableResource

protected AbstractShutdownableResource(R object)

Method Details

signalShutdownInitiated

protected final void signalShutdownInitiated()

Called by the Runnable to indicate that shutdown has started.

constructShutdown

protected abstract Runnable constructShutdown(R object)

The constructed runnable must call signalShutdownInitiated() method to indicate that shutdown has started.

Parameters:

object - Object to be shutdown

Returns:

Runnable instance

isShutdown

public final boolean isShutdown()

Returns true if this resource has been shut down.

Specified by:

isShutdown in interface ShutdownableResource

Returns:

true if this resource has been shut down

isTerminated

public final boolean isTerminated()

Returns true if the resource has completed shutting down. Note that isTerminated is never true unless shutdown was called first.

Specified by:

isTerminated in interface ShutdownableResource

Returns:

true if the resource has completed shutting down.

shutdown

public final void shutdown()

Starts the shutdown process. The Runnable returned by constructShutdown() must call signalShutdownInitiated().

Specified by:

shutdown in interface Shutdownable

waitForShutdown

public final void waitForShutdown()
                           throws InterruptedException,
IllegalStateException

Waits for shutdown to complete

Specified by:

waitForShutdown in interface Shutdownable

Throws:

InterruptedException - when the wait is interrupted

IllegalStateException - when the method is invoked when the shutdown has yet to start

waitForShutdown

public final void waitForShutdown(long timeoutInMs)
                           throws InterruptedException,
IllegalStateException,
TimeoutException

Waits for shutdown to complete with a timeout

Specified by:

waitForShutdown in interface Shutdownable

Parameters:

timeoutInMs - number of milliseconds to wait before throwing TimeoutException

Throws:

InterruptedException - when the wait is interrupted

IllegalStateException - when the method is invoked when the shutdown has yet to start

TimeoutException - when the operation times out

toString

public final String toString()

Overrides:

toString in class Object