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