org.pircbotx.hooks

Class WaitForQueue

java.lang.Object

org.pircbotx.hooks.WaitForQueue

All Implemented Interfaces:

Closeable, AutoCloseable

public class WaitForQueue
extends Object
implements Closeable

Stores all events in a queue for processing. This is useful for sequential processing of many similar events.

Example:

 WaitForQueue queue = new WaitForQueue();
 while(true) {
 MessageEvent mevent = queue.waitFor(MessageEvent.class);
 //Process event
 }
 queue.done();
 

Author:

Leon Blakey

Constructor Summary

Constructors

Constructor and Description
WaitForQueue(PircBotX bot) Create and store a queue listener in the specified bot's ListenerManager.

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the queue; VERY important to call when finished.
<E extends GenericEvent> Event	waitFor(Class<? extends E>... eventClasses) Wait indefinitely for the one of the specified events to be dispatched
<E extends GenericEvent> E	waitFor(Class<E> eventClass) Wait indefinitely for the specified event to be dispatched
<E extends GenericEvent> E	waitFor(Class<E> eventClass, long timeout, TimeUnit unit)
<E extends GenericEvent> Event	waitFor(List<Class<? extends E>> eventClasses) Wait indefinitely for the one of the specified events to be dispatched
<E extends GenericEvent> Event	waitFor(List<Class<? extends E>> eventClasses, long timeout, TimeUnit unit) Wait for events of the specified event class to appear in the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitForQueue

public WaitForQueue(@NonNull
                    PircBotX bot)

Create and store a queue listener in the specified bot's ListenerManager. It will be removed when close() is called

Parameters:

bot -

Method Detail

waitFor

public <E extends GenericEvent> E waitFor(@NonNull
                                          Class<E> eventClass)
                                   throws InterruptedException

Wait indefinitely for the specified event to be dispatched

Type Parameters:

E - Event class

Parameters:

eventClass - The event class to wait for

Returns:

The event

Throws:

InterruptedException

See Also:

waitFor(java.util.List, long, java.util.concurrent.TimeUnit)

waitFor

public <E extends GenericEvent> Event waitFor(@NonNull
                                              Class<? extends E>... eventClasses)
                                       throws InterruptedException

Wait indefinitely for the one of the specified events to be dispatched

Parameters:

eventClasses - List of events to wait for

Returns:

One of the possible events

Throws:

InterruptedException

See Also:

waitFor(java.util.List, long, java.util.concurrent.TimeUnit)

waitFor

public <E extends GenericEvent> Event waitFor(@NonNull
                                              List<Class<? extends E>> eventClasses)
                                       throws InterruptedException

Wait indefinitely for the one of the specified events to be dispatched

Parameters:

eventClasses - List of events to wait for

Returns:

One of the possible events

Throws:

InterruptedException

See Also:

waitFor(java.util.List, long, java.util.concurrent.TimeUnit)

waitFor

public <E extends GenericEvent> E waitFor(@NonNull
                                          Class<E> eventClass,
                                          long timeout,
                                          @NonNull
                                          TimeUnit unit)
                                   throws InterruptedException

Throws:

InterruptedException

waitFor

public <E extends GenericEvent> Event waitFor(@NonNull
                                              List<Class<? extends E>> eventClasses,
                                              long timeout,
                                              @NonNull
                                              TimeUnit unit)
                                       throws InterruptedException

Wait for events of the specified event class to appear in the queue. If the event was dispatched before this is called, it will return immediately. Events that do not match the specified event class are discarded

Parameters:

eventClasses - Events to wait for

timeout - Timeout value

unit - Unit of timeout value

Returns:

One of the possible events or null if timed out

Throws:

InterruptedException

close

public void close()

Shuts down the queue; VERY important to call when finished. Since this class stores every dispatched event, failure to close will eventually cause you to run out of memory

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable