KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > IWorkingSetUpdater


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui;
12
13 /**
14  * An <code>IWorkingSetUpdater</code> can be used to dynamically update
15  * the content of a working set.
16  * <p>
17  * A working set updater manages a set of working sets. It is contributed
18  * via the attribute <code>updaterClass</code> of the <code>
19  * org.eclipse.ui.workingSets</code> extension point. Extensions of this
20  * extension point must therefore implement this interface.
21  * </p>
22  * <p>
23  * API under construction and subject to change at any time.
24  * </p>
25  * @since 3.1
26  */
27 public interface IWorkingSetUpdater {
28     /**
29      * Adds a working set to this updater.
30      *
31      * @param workingSet the working set to add to this updater
32      */
33     public void add(IWorkingSet workingSet);
34     
35     /**
36      * Removes a working set from this updater.
37      *
38      * @param workingSet the working set to remove
39      *
40      * @return <code>true</code> if the updater changed (e.g.
41      * the element got removed)
42      */
43     public boolean remove(IWorkingSet workingSet);
44     
45     /**
46      * Returns <code>true</code> if the updater contains the
47      * given working set; otherwise <code>false</code> is
48      * returned.
49      *
50      * @param workingSet the parameter to check
51      *
52      * @return whether the updater contains the given working
53      * set
54      */
55     public boolean contains(IWorkingSet workingSet);
56     
57     /**
58      * Disposes this working set updater. Implementations of this
59      * method typically remove listeners from some delta providers.
60      */
61     public void dispose();
62 }
63
Popular Tags