← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to core/tasklist/api/src/org/netbeans/spi/tasklist/PushTaskScanner.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
core/tasklist/api/src/org/netbeans/spi/tasklist/PushTaskScanner.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.spi.tasklist;
 
43
 
 
44
import java.util.List;
 
45
import org.netbeans.modules.tasklist.trampoline.TaskManager;
 
46
import org.openide.filesystems.FileObject;
 
47
 
 
48
 
 
49
/**
 
50
 * <p>Task Scanner that can push new Tasks into Task List window.</p>
 
51
 * 
 
52
 * <p>You should use this scanner type if it takes too long to compute your tasks
 
53
 * or if your tasks are calculated asynchronously. <br/>
 
54
 * In most cases it is easier to use {@link FileTaskScanner} instead.</p>
 
55
 * 
 
56
 * @author S. Aubrecht
 
57
 */
 
58
public abstract class PushTaskScanner {
 
59
    
 
60
    private String displayName;
 
61
    private String description;
 
62
    private String optionsPath;
 
63
    
 
64
    /**
 
65
     * Creates a new instance of PushTaskScanner
 
66
     * 
 
67
     * @param displayName Scanner's display name, will appear in Task List's filter window.
 
68
     * @param description Scanner's description, will be used for tooltips.
 
69
     * @param optionsPath Path that identifies panel in the global Options dialog window, 
 
70
     * or null if the scanner has no user settings. When scanner's settings changed the 
 
71
     * scanner must refresh its tasks the Task List window 
 
72
     * ({@link PushTaskScanner.Callback#clearAllTasks}, {@link PushTaskScanner.Callback#setTasks}).
 
73
     */
 
74
    public PushTaskScanner( String displayName, String description, String optionsPath ) {
 
75
        assert null != displayName;
 
76
        this.displayName = displayName;
 
77
        this.description = description;
 
78
        this.optionsPath = optionsPath;
 
79
    }
 
80
    
 
81
    /**
 
82
     * Scanner's display name.
 
83
     * @return Scanner's display name.
 
84
     */
 
85
    final String getDisplayName() {
 
86
        return displayName;
 
87
    }
 
88
    
 
89
    /**
 
90
     * Scanner's description (e.g. for tooltips).
 
91
     * @return Scanner's description (e.g. for tooltips).
 
92
     */
 
93
    final String getDescription() {
 
94
        return description;
 
95
    }
 
96
    
 
97
    /**
 
98
     * Path to the global options panel.
 
99
     * @return Path that identifies panel in the global Options dialog window, 
 
100
     * or null if the scanner has no user settings.
 
101
     */
 
102
    final String getOptionsPath() {
 
103
        return optionsPath;
 
104
    }
 
105
    
 
106
    /**
 
107
     * Called by the framework when the user switches to a different scanning scope
 
108
     * or when the currently used scope needs to be refreshed.
 
109
     *
 
110
     * @param scope New scanning scope, null value indicates that task scanning is to be cancelled.
 
111
     * @param callback Callback into Task List framework.
 
112
     */
 
113
    public abstract void setScope( TaskScanningScope scope, Callback callback );
 
114
 
 
115
    
 
116
    /**
 
117
     * Callback into Task List framework
 
118
     */
 
119
    public static final class Callback {
 
120
        
 
121
        private PushTaskScanner scanner;
 
122
        private TaskManager tm;
 
123
        
 
124
        /** Creates a new instance of SimpleTaskScannerCallback */
 
125
        Callback( TaskManager tm, PushTaskScanner scanner ) {
 
126
            this.tm = tm;
 
127
            this.scanner = scanner;
 
128
        }
 
129
 
 
130
        /**
 
131
         * Notify the framework that the scanner started looking for available Tasks.
 
132
         */
 
133
        public void started() {
 
134
            tm.started( scanner );
 
135
        }
 
136
 
 
137
        /**
 
138
         * Add/remove Tasks for the given file/folder.
 
139
         * @param file Resource (file or folder) the tasks are associated with.
 
140
         * @param tasks Tasks associated with the given resource or an empty list to remove previously provided Tasks.
 
141
         */
 
142
        public void setTasks( FileObject file, List<? extends Task> tasks ) {
 
143
            tm.setTasks( scanner, file, tasks );
 
144
        }
 
145
        
 
146
        /**
 
147
         * Remove from the Task List window all Tasks that were provided by this scanner.
 
148
         */
 
149
        public void clearAllTasks() {
 
150
            tm.clearAllTasks( scanner );
 
151
        }
 
152
 
 
153
        /**
 
154
         * Notify the framework that the scanner has finished.
 
155
         */
 
156
        public void finished() {
 
157
            tm.finished( scanner );
 
158
        }
 
159
    }
 
160
}