adressevedligehold/tasks/Task.java

package dk.daoas.adressevedligehold.tasks;

import dk.daoas.adressevedligehold.util.TimingHelper;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

public abstract class Task implements Runnable {
        
        public enum TaskState {
                STATE_QUEUED, STATE_RUNNING, STATE_DONE, STATE_ABORTED;
        }
        
        @SuppressFBWarnings("URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")//bliver læst via gson - og det forvirrer findbugs
        public static class TaskBean {
                public String description;
                public String detail;
                public String errorMessage;
                public double percentCompleted;
                public String state;
        }
        
        protected boolean abort = false;
        protected TaskState state = TaskState.STATE_QUEUED;
        protected TaskManager manager;
        private String errorMsg;
        
        public void setManager(TaskManager manager) {
                this.manager = manager;
        }
        
        @Override
        public final void run() {
                TimingHelper timing = new TimingHelper();
                System.out.println("Starting " + this.getDescription() );
                
                this.state = TaskState.STATE_RUNNING;
                manager.setCurrentTask(this);
                
                try {
                        taskRun();
                        this.state = TaskState.STATE_DONE;
                } catch (Exception e) {
                        this.errorMsg = e.getMessage();
                        e.printStackTrace();
                        this.state = TaskState.STATE_ABORTED;
                }
                
                manager.setCurrentTask(null);
                
                System.out.println("Done " + this.getDescription() + "   " + timing.getElapsed() + "ms");
        }
        
        
        public TaskState getState() {
                return this.state;
        }
        
        public boolean isAborted() {
                return this.abort;
        }
        
        public void doAbort() {
                this.abort = true;
        }
        
        public TaskBean getTaskBean() {
                TaskBean bean = new TaskBean();
                
                bean.description = this.getDescription();
                bean.detail = this.getDetail();
                bean.percentCompleted = this.getPercentCompleted();
                bean.state = this.state.toString();
                bean.errorMessage = this.getErrorMessage();
                
                return bean;
        }
        
        public String getErrorMessage() {
                return this.errorMsg;
        }
        
        /**
         * @throws Exception
         * 
         * Implementing classes should not catch terminating exceptions but let it propagate to Task the Task::run()
         * method.
         */
        protected abstract void taskRun() throws Exception;
        
        public abstract String getDescription();
        public abstract String getDetail();
        public abstract double getPercentCompleted();
        
}
1	torben	2838	package dk.daoas.adressevedligehold.tasks;
2
3			import dk.daoas.adressevedligehold.util.TimingHelper;
4
5	torben	2864	import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
6
7	torben	2838	public abstract class Task implements Runnable {
8
9			public enum TaskState {
10			STATE_QUEUED, STATE_RUNNING, STATE_DONE, STATE_ABORTED;
11			}
12
13	torben	2864	@SuppressFBWarnings("URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")//bliver læst via gson - og det forvirrer findbugs
14	torben	2838	public static class TaskBean {
15			public String description;
16			public String detail;
17	torben	2844	public String errorMessage;
18	torben	2838	public double percentCompleted;
19			public String state;
20			}
21
22			protected boolean abort = false;
23			protected TaskState state = TaskState.STATE_QUEUED;
24			protected TaskManager manager;
25	torben	2844	private String errorMsg;
26	torben	2838
27			public void setManager(TaskManager manager) {
28			this.manager = manager;
29			}
30
31			@Override
32			public final void run() {
33			TimingHelper timing = new TimingHelper();
34			System.out.println("Starting " + this.getDescription() );
35
36			this.state = TaskState.STATE_RUNNING;
37			manager.setCurrentTask(this);
38
39			try {
40			taskRun();
41			this.state = TaskState.STATE_DONE;
42			} catch (Exception e) {
43	torben	2844	this.errorMsg = e.getMessage();
44			e.printStackTrace();
45	torben	2838	this.state = TaskState.STATE_ABORTED;
46			}
47
48			manager.setCurrentTask(null);
49
50			System.out.println("Done " + this.getDescription() + " " + timing.getElapsed() + "ms");
51			}
52
53
54			public TaskState getState() {
55			return this.state;
56			}
57
58	torben	2878	public boolean isAborted() {
59			return this.abort;
60			}
61
62	torben	2838	public void doAbort() {
63			this.abort = true;
64			}
65
66			public TaskBean getTaskBean() {
67			TaskBean bean = new TaskBean();
68
69			bean.description = this.getDescription();
70			bean.detail = this.getDetail();
71			bean.percentCompleted = this.getPercentCompleted();
72			bean.state = this.state.toString();
73	torben	2844	bean.errorMessage = this.getErrorMessage();
74	torben	2838
75			return bean;
76			}
77
78	torben	2844	public String getErrorMessage() {
79			return this.errorMsg;
80			}
81	torben	2838
82	torben	2844	/**
83			* @throws Exception
84			*
85			* Implementing classes should not catch terminating exceptions but let it propagate to Task the Task::run()
86			* method.
87			*/
88			protected abstract void taskRun() throws Exception;
89
90	torben	2838	public abstract String getDescription();
91			public abstract String getDetail();
92	torben	2891	public abstract double getPercentCompleted();
93	torben	2838
94			}