KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > core > resources > IPathVariableChangeEvent


1 /*******************************************************************************
2  * Copyright (c) 2000, 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
12 package org.eclipse.core.resources;
13
14 import org.eclipse.core.runtime.IPath;
15
16 /**
17  * Describes a change in a path variable. The change may denote that a
18  * variable has been created, deleted or had its value changed.
19  *
20  * <p>This interface is not intended to be implemented by clients.</p>
21  *
22  * @since 2.1
23  * @see IPathVariableChangeListener
24  */
25 public interface IPathVariableChangeEvent {
26
27     /** Event type constant (value = 1) that denotes a value change . */
28     public final static int VARIABLE_CHANGED = 1;
29
30     /** Event type constant (value = 2) that denotes a variable creation. */
31     public final static int VARIABLE_CREATED = 2;
32
33     /** Event type constant (value = 3) that denotes a variable deletion. */
34     public final static int VARIABLE_DELETED = 3;
35
36     /**
37      * Returns the variable's current value. If the event type is
38      * <code>VARIABLE_CHANGED</code> then it is the new value, if the event
39      * type is <code>VARIABLE_CREATED</code> then it is the new value, or
40      * if the event type is <code>VARIABLE_DELETED</code> then it will
41      * be <code>null</code>.
42      *
43      * @return the variable's current value, or <code>null</code>
44      */
45     public IPath getValue();
46
47     /**
48      * Returns the affected variable's name.
49      *
50      * @return the affected variable's name
51      */
52     public String JavaDoc getVariableName();
53
54     /**
55      * Returns an object identifying the source of this event.
56      *
57      * @return an object identifying the source of this event
58      * @see java.util.EventObject
59      */
60     public Object JavaDoc getSource();
61
62     /**
63      * Returns the type of event being reported.
64      *
65      * @return one of the event type constants
66      * @see #VARIABLE_CHANGED
67      * @see #VARIABLE_CREATED
68      * @see #VARIABLE_DELETED
69      */
70     public int getType();
71
72 }
73
Popular Tags