net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/ElementChangedEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.core;
  12
  13 import java.util.EventObject;
  14
  15 /**
  16  * An element changed event describes a change to the structure or contents
  17  * of a tree of Java elements. The changes to the elements are described by
  18  * the associated delta object carried by this event.
  19  * <p>
  20  * This class is not intended to be instantiated or subclassed by clients.
  21  * Instances of this class are automatically created by the Java model.
  22  * </p>
  23  *
  24  * @see IElementChangedListener
  25  * @see IJavaElementDelta
  26  */
  27 public class ElementChangedEvent extends EventObject {
  28
  29         /**
  30          * Event type constant (bit mask) indicating an after-the-fact
  31          * report of creations, deletions, and modifications
  32          * to one or more Java element(s) expressed as a hierarchical
  33          * java element delta as returned by <code>getDelta()</code>.
  34          *
  35          * Note: this notification occurs during the corresponding POST_CHANGE
  36          * resource change notification, and contains a full delta accounting for
  37          * any JavaModel operation  and/or resource change.
  38          *
  39          * @see IJavaElementDelta
  40          * @see org.eclipse.core.resources.IResourceChangeEvent
  41          * @see #getDelta()
  42          * @since 2.0
  43          */
  44         public static final int POST_CHANGE = 1;
  45
  46         /**
  47          * Event type constant (bit mask) indicating an after-the-fact
  48          * report of creations, deletions, and modifications
  49          * to one or more Java element(s) expressed as a hierarchical
  50          * java element delta as returned by <code>getDelta</code>.
  51          *
  52          * Note: this notification occurs during the corresponding PRE_AUTO_BUILD
  53          * resource change notification. The delta, which is notified here, only contains
  54          * information relative to the previous JavaModel operations (in other words,
  55          * it ignores the possible resources which have changed outside Java operations).
  56          * In particular, it is possible that the JavaModel be inconsistent with respect to
  57          * resources, which got modified outside JavaModel operations (it will only be
  58          * fully consistent once the POST_CHANGE notification has occurred).
  59          *
  60          * @see IJavaElementDelta
  61          * @see org.eclipse.core.resources.IResourceChangeEvent
  62          * @see #getDelta()
  63          * @since 2.0
  64          */
  65         public static final int PRE_AUTO_BUILD = 2;
  66
  67         /**
  68          * Event type constant (bit mask) indicating an after-the-fact
  69          * report of creations, deletions, and modifications
  70          * to one or more Java element(s) expressed as a hierarchical
  71          * java element delta as returned by <code>getDelta</code>.
  72          *
  73          * Note: this notification occurs as a result of a working copy reconcile
  74          * operation.
  75          *
  76          * @see IJavaElementDelta
  77          * @see org.eclipse.core.resources.IResourceChangeEvent
  78          * @see #getDelta()
  79          * @since 2.0
  80          */
  81         public static final int         POST_RECONCILE = 4;
  82         /*
  83          * Event type indicating the nature of this event.
  84          * It can be a combination either:
  85          *  - POST_CHANGE
  86          *  - PRE_AUTO_BUILD
  87          *  - POST_RECONCILE
  88          */
  89         private int type;
  90
  91         /**
  92          * Creates an new element changed event (based on a <code>IJavaElementDelta</code>).
  93          *
  94          * @param delta the Java element delta.
  95          */
  96         public ElementChangedEvent(IJavaElementDelta delta, int type) {
  97                 super(delta);
  98                 this.type = type;
  99         }
 100         /**
 101          * Returns the delta describing the change.
 102          *
 103          * @return the delta describing the change
 104          */
 105         public IJavaElementDelta getDelta() {
 106                 return (IJavaElementDelta) source;
 107         }
 108
 109         /**
 110          * Returns the type of event being reported.
 111          *
 112          * @return one of the event type constants
 113          * @see #POST_CHANGE
 114          * @see #PRE_AUTO_BUILD
 115          * @see #POST_RECONCILE
 116          * @since 2.0
 117          */
 118         public int getType() {
 119                 return this.type;
 120         }
 121 }