1 package jalview.ws2.actions.api;
5 import jalview.bin.Console;
6 import jalview.ws2.api.JobStatus;
7 import jalview.ws2.api.WebServiceJobHandle;
10 * The listener interface for receiving relevant job progress and state change
11 * events on the task. The listener object is registered with the task on its
12 * creation in {@link ActionI#perform} method. An event is generated when the
13 * task is started, restarted, completed, fails with an exception or its global
14 * status changes. Additional, sub-job related, events are emitted when the
15 * sub-job status, log or error log changes.
21 public interface TaskEventListener<T>
24 * Invoked when the task has been started. The {@code subJobs} parameter
25 * contains a complete list of sub-jobs for that run. Note that restartable
26 * tasks may invoke this method multiple times with different set of sub-jobs.
29 * task this event originates from
31 * list of sub-jobs for this run
33 void taskStarted(TaskI<T> source, List<? extends JobI> subJobs);
36 * Invoked when the global task status has changed.
39 * task this event originates from
43 void taskStatusChanged(TaskI<T> source, JobStatus status);
46 * Invoked when the task has completed. If the task completed with a result,
47 * that result is passed in the call argument, otherwise, a {@code null} value
51 * task this event originates from
53 * computation result or null if result not present
55 void taskCompleted(TaskI<T> source, T result);
58 * Invoked when an unhandled exception has occurred during task execution.
61 * task this event originates from
65 void taskException(TaskI<T> source, Exception e);
68 * Invoked when the task had been restarted. This event is only applicable to
69 * restartable tasks and will precede each {@link #taskStarted} after the
73 * task this event originates from
75 void taskRestarted(TaskI<T> source);
78 * Invoked when the status of a sub-job has changed.
81 * task this event originates form
83 * sub-job that has been updated
87 void subJobStatusChanged(TaskI<T> source, JobI job, JobStatus status);
90 * Invoked when a log string of the sub-job has changed.
93 * task this event originates form
95 * sub-job that has been updated
99 void subJobLogChanged(TaskI<T> source, JobI job, String log);
102 * Invoked when an error log string of the sub-job has changed.
105 * task this event originates form
107 * sub-job that has been updated
111 void subJobErrorLogChanged(TaskI<T> source, JobI job, String log);
113 @SuppressWarnings("rawtypes")
114 static final TaskEventListener NULL_LISTENER = new TaskEventListener()
117 public void taskStarted(TaskI source, List subJobs)
119 Console.info("task started with " + subJobs.size() + " jobs");
123 public void taskStatusChanged(TaskI source, JobStatus status)
125 Console.info("task status " + status);
129 public void taskCompleted(TaskI source, Object result)
131 Console.info("task completed");
135 public void taskException(TaskI source, Exception e)
137 Console.info("task failed", e);
141 public void taskRestarted(TaskI source)
143 Console.info("task restarted");
147 public void subJobStatusChanged(TaskI source, JobI job,
150 Console.info("sub-job " + job.getInternalId() + " status " + status);
154 public void subJobLogChanged(TaskI source, JobI job, String log)
159 public void subJobErrorLogChanged(TaskI source, JobI job, String log)
164 @SuppressWarnings("unchecked")
165 static <T> TaskEventListener<T> nullListener()
167 return (TaskEventListener<T>) NULL_LISTENER;