01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 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.activities;
11:
12: import java.util.Set;
13:
14: /**
15: * An instance of this interface can be obtained from an instance of
16: * <code>IActivityManager</code>for any identifier.
17: * <p>
18: * An <code>IIdentifier</code> is an object that offers an easy means to
19: * determine if a given string matches the pattern bindings of any IActivity
20: * objects. Additionaly, one may query if an identifier is enabled. An
21: * identifier is always considered enabled unless it matches only disabled activities.
22: * </p>
23: * <p>
24: * The handle-based nature of this API allows it to work well with runtime
25: * plugin activation and deactivation, which can cause dynamic changes to the
26: * extension registry.
27: * </p>
28: * <p>
29: * This interface is not intended to be extended or implemented by clients.
30: * </p>
31: *
32: * @since 3.0
33: * @see IActivityManager#getIdentifier(String)
34: */
35: public interface IIdentifier extends Comparable {
36:
37: /**
38: * Registers an instance of <code>IIdentifierListener</code> to listen
39: * for changes to properties of this instance.
40: *
41: * @param identifierListener
42: * the instance to register. Must not be <code>null</code>.
43: * If an attempt is made to register an instance which is
44: * already registered with this instance, no operation is
45: * performed.
46: */
47: void addIdentifierListener(IIdentifierListener identifierListener);
48:
49: /**
50: * Returns the set of activity ids that this instance matches. Each
51: * activity in this set will have at least one pattern binding that matches
52: * the string returned by {@link #getId()}.
53: * <p>
54: * Notification is sent to all registered listeners if this property
55: * changes.
56: * </p>
57: *
58: * @return the set of activity ids that this instance matches. This set may
59: * be empty, but is guaranteed not to be <code>null</code>. If
60: * this set is not empty, it is guaranteed to only contain
61: * instances of <code>String</code>.
62: */
63: Set getActivityIds();
64:
65: /**
66: * Returns the identifier of this instance.
67: *
68: * @return the identifier of this instance. Guaranteed not to be <code>null</code>.
69: */
70: String getId();
71:
72: /**
73: * Returns whether or not this instance is enabled. An identifier is always
74: * considered enabled unless it matches only disabled activities.
75: *
76: * <p>
77: * Notification is sent to all registered listeners if this property
78: * changes.
79: * </p>
80: *
81: * @return <code>true</code>, iff this instance is enabled.
82: */
83: boolean isEnabled();
84:
85: /**
86: * Removes an instance of <code>IIdentifierListener</code> listening
87: * for changes to properties of this instance.
88: *
89: * @param identifierListener
90: * the instance to remove. Must not be <code>null</code>.
91: * If an attempt is made to remove an instance which is not
92: * already registered with this instance, no operation is
93: * performed.
94: */
95: void removeIdentifierListener(IIdentifierListener identifierListener);
96: }
|