com.github.akurilov.commons.concurrent

Class AsyncRunnableBase

java.lang.Object

com.github.akurilov.commons.concurrent.AsyncRunnableBase

All Implemented Interfaces:

AsyncRunnable, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

DaemonBase

public abstract class AsyncRunnableBase
extends java.lang.Object
implements AsyncRunnable

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.akurilov.commons.concurrent.AsyncRunnable

AsyncRunnable.State

Constructor Summary

Constructors

Constructor and Description
AsyncRunnableBase()

Method Summary

Modifier and Type	Method and Description
AsyncRunnableBase	await() Wait while the state is STARTED
boolean	await(long timeout, java.util.concurrent.TimeUnit timeUnit)
void	close()
protected void	doClose()
protected void	doShutdown()
protected void	doStart()
protected void	doStop()
boolean	isClosed()
boolean	isFinished()
boolean	isInitial()
boolean	isShutdown()
boolean	isStarted()
boolean	isStopped()
AsyncRunnableBase	shutdown() Notify to stop to enqueue incoming requests.
AsyncRunnableBase	start() Start/resume the execution
AsyncRunnable.State	state()
AsyncRunnableBase	stop() Stop (with further resumption capability)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncRunnableBase

public AsyncRunnableBase()

Method Detail

state

public final AsyncRunnable.State state()

Specified by:

state in interface AsyncRunnable

Returns:

the current state, null if closed

isInitial

public boolean isInitial()

Specified by:

isInitial in interface AsyncRunnable

Returns:

true if the state is "initial", false otherwise

isStarted

public boolean isStarted()

Specified by:

isStarted in interface AsyncRunnable

Returns:

true if the state is "started", false otherwise

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface AsyncRunnable

Returns:

true if the state is "shutdown", false otherwise

isStopped

public boolean isStopped()

Specified by:

isStopped in interface AsyncRunnable

Returns:

true if the state is "stopped", false otherwise

isFinished

public boolean isFinished()

Specified by:

isFinished in interface AsyncRunnable

Returns:

true if the state is "finished", false otherwise

isClosed

public boolean isClosed()

Specified by:

isClosed in interface AsyncRunnable

Returns:

true if there's no state, false otherwise

start

public final AsyncRunnableBase start()
                              throws java.lang.IllegalStateException

Description copied from interface: AsyncRunnable

Start/resume the execution

Specified by:

start in interface AsyncRunnable

Returns:

the same instance with state changed to STARTED if call was successful.

Throws:

java.lang.IllegalStateException - if the previous state is not INITIAL neither STOPPED

shutdown

public final AsyncRunnableBase shutdown()
                                 throws java.lang.IllegalStateException

Description copied from interface: AsyncRunnable

Notify to stop to enqueue incoming requests. The await method should be used after this to make sure that everything accepted before the shutdown is done.

Specified by:

shutdown in interface AsyncRunnable

Throws:

java.lang.IllegalStateException

stop

public final AsyncRunnableBase stop()
                             throws java.lang.IllegalStateException

Description copied from interface: AsyncRunnable

Stop (with further resumption capability)

Specified by:

stop in interface AsyncRunnable

Returns:

the same instance with state changed to STOPPED if call was successful

Throws:

java.lang.IllegalStateException - if the previous state is not STARTED

await

public final AsyncRunnableBase await()
                              throws java.lang.IllegalStateException,
                                     java.lang.InterruptedException

Description copied from interface: AsyncRunnable

Wait while the state is STARTED

Specified by:

await in interface AsyncRunnable

Returns:

the same instance

Throws:

java.lang.InterruptedException

java.lang.IllegalStateException

await

public boolean await(long timeout,
                     java.util.concurrent.TimeUnit timeUnit)
              throws java.lang.IllegalStateException,
                     java.lang.InterruptedException

Specified by:

await in interface AsyncRunnable

Throws:

java.lang.IllegalStateException

java.lang.InterruptedException

close

public void close()
           throws java.lang.IllegalStateException,
                  java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.IllegalStateException

java.io.IOException

doStart

protected void doStart()

doShutdown

protected void doShutdown()

doStop

protected void doStop()

doClose

protected void doClose()
                throws java.io.IOException

Throws:

java.io.IOException