ITriggerPointManager


1   /*******************************************************************************
2    * Copyright (c) 2004, 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.activities;
12  
13  import java.util.Set  ;
14  
15  /**
16   * Contains a collection of known trigger points. An instance of this class may
17   * be obtained from
18   * {@link org.eclipse.ui.activities.IWorkbenchActivitySupport#getTriggerPointManager()}.
19   * <p>
20   * This interface is not intended to be extended or implemented by clients.
21   * </p>
22   * 
23   * @see org.eclipse.ui.activities.ITriggerPoint
24   * @since 3.1
25   */
26  public interface ITriggerPointManager {
27      
28      /**
29       * Constant representing the id of an unknown trigger point. Used by clients
30       * of {@link WorkbenchActivityHelper#allowUseOf(Object)} for trigger point
31       * determination logic.
32       */
33      public static final String   UNKNOWN_TRIGGER_POINT_ID = "org.eclipse.ui.internal.UnknownTriggerPoint"; //$NON-NLS-1$
34      
35      /**
36       * Return the trigger point with the given id.
37       * 
38       * @param id the trigger point id
39       * @return the trigger point or <code>null</code>
40       */
41      ITriggerPoint getTriggerPoint(String   id);
42      
43      /**
44       * Return the set of defined trigger point ids.
45       * 
46       * @return the defined ids.  Never <code>null</code> but may be empty.
47       */
48      Set   getDefinedTriggerPointIds();
49  }
50
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags