Module com.renomad.minum

Package com.renomad.minum.queue

Class ActionQueue

java.lang.Object

com.renomad.minum.queue.ActionQueue

All Implemented Interfaces:

AbstractActionQueue

public final class ActionQueue
extends Object
implements AbstractActionQueue

This class provides the ability to pop items into a queue thread-safely and know they'll happen later.

For example, this is helpful for minum.logging, or passing functions to a minum.database. It lets us run a bit faster, since the I/O actions are happening on a separate thread and the only time required is passing the function of what we want to run later.

Constructor Summary

Constructors

Constructor	Description
ActionQueue(String name, Context context)	See the ActionQueue description for more detail.

Method Summary

Modifier and Type	Method	Description
void	enqueue(String description, ThrowingRunnable action)	Adds something to the queue to be processed.
LinkedBlockingQueue<RunnableWithDescription>	getQueue()	Get the Queue of data that is supposed to get processed.
ActionQueue	initialize()	Start the queue's processing
boolean	isStopped()	Indicate whether this has had its AbstractActionQueue.stop() method completed.
void	stop()	This will prevent any new actions being queued (by setting the stop flag to true and thus causing an exception to be thrown when a call is made to [enqueue]) and will block until the queue is empty.
void	stop(int count, int sleepTime)	Stops the action queue
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ActionQueue

public ActionQueue(String name,
 Context context)

See the ActionQueue description for more detail. This constructor will build your new action queue and handle registering it with a list of other action queues in the Context object.

Parameters:

name - give this object a unique, explanatory name.

Method Details

initialize

public ActionQueue initialize()

Description copied from interface: AbstractActionQueue

Start the queue's processing

Specified by:

initialize in interface AbstractActionQueue

enqueue

public void enqueue(String description,
 ThrowingRunnable action)

Adds something to the queue to be processed.

Here is an example use of .enqueue:

   actionQueue.enqueue("Write person file to disk at " + filePath, () -> {
             Files.writeString(filePath, pf.serialize());
         });
 

Specified by:

enqueue in interface AbstractActionQueue

stop

public void stop(int count,
 int sleepTime)

Stops the action queue

Specified by:

stop in interface AbstractActionQueue

Parameters:

count - how many loops to wait before we crash it closed

sleepTime - how long to wait in milliseconds between loops

stop

public void stop()

This will prevent any new actions being queued (by setting the stop flag to true and thus causing an exception to be thrown when a call is made to [enqueue]) and will block until the queue is empty.

Specified by:

stop in interface AbstractActionQueue

toString

public String toString()

Overrides:

toString in class Object

getQueue

public LinkedBlockingQueue<RunnableWithDescription> getQueue()

Description copied from interface: AbstractActionQueue

Get the Queue of data that is supposed to get processed.

Specified by:

getQueue in interface AbstractActionQueue

isStopped

public boolean isStopped()

Description copied from interface: AbstractActionQueue

Indicate whether this has had its AbstractActionQueue.stop() method completed.

Specified by:

isStopped in interface AbstractActionQueue