IRegistryChangeEvent


1   /*******************************************************************************
2    * Copyright (c) 2003, 2006 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.core.runtime;
12  
13  /**
14   * Registry change events describe changes to the extension registry. 
15   * <p>
16   * This interface can be used without OSGi running.
17   * </p><p>
18   * This interface is not intended to be implemented by clients.
19   * </p>
20   * @since 3.0
21   * @see IExtensionRegistry
22   * @see IRegistryChangeListener
23   */
24  public interface IRegistryChangeEvent {
25      /** 
26       * Returns all extension deltas for all hosts. Returns an empty array if there are 
27       * no deltas in this event.
28       * 
29       * @return  all extension deltas 
30       */
31      public IExtensionDelta[] getExtensionDeltas();
32  
33      /** 
34       * Returns all extension deltas for the given namespace. Returns an empty array if there are
35       * no deltas in this event for any extension points provided in the given namespace. 
36       * 
37       * @param namespace the namespace for the extension deltas 
38       * @return all extension deltas for the given namespace 
39       */
40      public IExtensionDelta[] getExtensionDeltas(String   namespace);
41  
42      /** 
43       * Returns all the extension deltas for the given namespace and extension point. Returns an 
44       * empty array if there are no deltas in this event for the given extension point.
45       *  
46       * @param namespace the namespace for the extension point
47       * @param extensionPoint the simple identifier of the 
48       *  extension point (e.g. <code>"builders"</code>)
49       * @return all extension deltas for the given extension point
50       */
51      public IExtensionDelta[] getExtensionDeltas(String   namespace, String   extensionPoint);
52  
53      /** 
54       * Returns the delta for the given namespace, extension point and extension. 
55       * Returns <code>null</code> if none exists in this event.
56       * 
57       * @param namespace the namespace for the extension point
58       * @param extensionPoint the simple identifier of the 
59       *  extension point (e.g. <code>"builders"</code>)
60       * @param extension the unique identifier of the extension
61       * @return the extension delta, or <code>null</code>
62       */
63      public IExtensionDelta getExtensionDelta(String   namespace, String   extensionPoint, String   extension);
64  }
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags