IModelProviderEvent


1   /*******************************************************************************
2    * Copyright (c) 2000, 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.pde.core;
12  /**
13   * This event will be delivered to all model provider listeners when a model
14   * managed by the model provider changes in some way.
15   * 
16   * @since 2.0
17   */
18  public interface IModelProviderEvent {
19      /**
20       * Event is sent after the models have been added.
21       */
22      int MODELS_ADDED = 0x1;
23      /**
24       * Event is sent before the models will be removed.
25       */
26      int MODELS_REMOVED = 0x2;
27      /**
28       * Event is sent after the models have been changed.
29       */
30      int MODELS_CHANGED = 0x4;
31      
32      /**
33       * Event is sent when the target platform changes
34       * 
35       * @since 3.2
36       */
37      int TARGET_CHANGED = 0x8;
38      /**
39       * Returns the models that are added
40       * 
41       * @return the models that have been added or an empty array
42       */
43      IModel[] getAddedModels();
44      /**
45       * Returns the models that are removed
46       * 
47       * @return the models that have been removed or an empty array
48       */
49      IModel[] getRemovedModels();
50      /**
51       * Returns the models that has changed
52       * 
53       * @return the models that has changed or an empty array
54       */
55      IModel[] getChangedModels();
56      /**
57       * Returns the combination of flags indicating type of event. In case of
58       * multiple changes, flags are ORed together. (a combination of
59       * MODEL_CHANGED, MODEL_ADDED, MODEL_REMOVED)
60       * 
61       * @return the model change type
62       */
63      int getEventTypes();
64      /**
65       * Returns the object that fired this event.
66       */
67      Object   getEventSource();
68  }
69
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags