|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
WorkerTask.java | - | - | 100% | 100% |
|
1 | /* | |
2 | * Copyright (c) 1998, 2005 Gargoyle Software Inc. All rights reserved. | |
3 | * | |
4 | * Redistribution and use in source and binary forms, with or without | |
5 | * modification, are permitted provided that the following conditions are met: | |
6 | * | |
7 | * 1. Redistributions of source code must retain the above copyright notice, | |
8 | * this list of conditions and the following disclaimer. | |
9 | * 2. Redistributions in binary form must reproduce the above copyright notice, | |
10 | * this list of conditions and the following disclaimer in the documentation | |
11 | * and/or other materials provided with the distribution. | |
12 | * 3. The end-user documentation included with the redistribution, if any, must | |
13 | * include the following acknowledgment: | |
14 | * | |
15 | * "This product includes software developed by Gargoyle Software Inc. | |
16 | * (http://www.GargoyleSoftware.com/)." | |
17 | * | |
18 | * Alternately, this acknowledgment may appear in the software itself, if | |
19 | * and wherever such third-party acknowledgments normally appear. | |
20 | * 4. The name "Gargoyle Software" must not be used to endorse or promote | |
21 | * products derived from this software without prior written permission. | |
22 | * For written permission, please contact info@GargoyleSoftware.com. | |
23 | * 5. Products derived from this software may not be called "GSBase", nor may | |
24 | * "GSBase" appear in their name, without prior written permission of | |
25 | * Gargoyle Software Inc. | |
26 | * | |
27 | * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, | |
28 | * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | |
29 | * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE | |
30 | * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, | |
31 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
32 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, | |
33 | * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
34 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
35 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, | |
36 | * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
37 | */ | |
38 | package com.gargoylesoftware.base.gui; | |
39 | ||
40 | /** | |
41 | * A task that partially executes on a non-ui thread and partially on the | |
42 | * ui thread. | |
43 | * <p> | |
44 | * It is common to have tasks that have a non-ui portion followed by a ui | |
45 | * portion. For example, a database query must take place on a non-ui thread | |
46 | * because is it a blocking call. The code that takes the results of that | |
47 | * query must execute on the UI thread if it is to update UI components. | |
48 | * <p> | |
49 | * This task will be called in the following way. First, the method | |
50 | * runOnWorkerThread() will be called from a non-UI thread. At some point | |
51 | * later (usually almost immediately), the method runOnUIThread() will be | |
52 | * called from the UI thread. | |
53 | * | |
54 | * @version $Revision: 1.4 $ | |
55 | * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> | |
56 | */ | |
57 | public abstract class WorkerTask { | |
58 | ||
59 | /** | |
60 | * Create an instance of the worker task. | |
61 | */ | |
62 | 6 | public WorkerTask() { |
63 | } | |
64 | ||
65 | /** | |
66 | * Perform non-ui related work in this method | |
67 | * @throws Exception Whenever needed | |
68 | */ | |
69 | public abstract void runOnWorkerThread() throws Exception; | |
70 | ||
71 | /** | |
72 | * Perform ui related work in this method | |
73 | * @throws Exception Whenever needed | |
74 | */ | |
75 | public abstract void runOnUIThread() throws Exception; | |
76 | } |
|