jerklib.tasks
Interface Task

All Superinterfaces:
IRCEventListener
All Known Implementing Classes:
NickServAuthPlugin, TaskImpl

public interface Task
extends IRCEventListener

Task is a job that can be ran by the Session when certain types of events are received. This class is very much like IRCEventListener , but it can be associated with Types of events. See Session's onEvent methods for details. Task Tutorial

Author:
mohadib
See Also:
Session.onEvent(Task), Session.onEvent(jerklib.tasks.Task, jerklib.events.IRCEvent.Type...), IRCEvent.Type

Method Summary
 void cancel()
          Cancel a task.
 String getName()
          Gets the name of a task
 boolean isCanceled()
           
 
Methods inherited from interface jerklib.listeners.IRCEventListener
receiveEvent
 

Method Detail

getName

String getName()
Gets the name of a task

Returns:
name of task

cancel

void cancel()
Cancel a task. This task will not run again. If the task is currently running it will finish then not run again.


isCanceled

boolean isCanceled()
Returns:
true if task is canceled , else false