Package org.eclipse.core.resources

Interface IPathVariableChangeEvent

public interface IPathVariableChangeEvent
Describes a change in a path variable. The change may denote that a variable has been created, deleted or had its value changed.
Since:
2.1
See Also:
Restriction:
This interface is not intended to be implemented by clients.
Restriction:
This interface is not intended to be extended by clients.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    VARIABLE_CHANGED
    Event type constant (value = 1) that denotes a value change .
    static final int
    VARIABLE_CREATED
    Event type constant (value = 2) that denotes a variable creation.
    static final int
    VARIABLE_DELETED
    Event type constant (value = 3) that denotes a variable deletion.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    getSource()
    Returns an object identifying the source of this event.
    int
    getType()
    Returns the type of event being reported.
    IPath
    getValue()
    Returns the variable's current value.
    String
    getVariableName()
    Returns the affected variable's name.

  • Field Details

    • VARIABLE_CHANGED

      static final int VARIABLE_CHANGED
      Event type constant (value = 1) that denotes a value change .
      See Also:

    • VARIABLE_CREATED

      static final int VARIABLE_CREATED
      Event type constant (value = 2) that denotes a variable creation.
      See Also:

    • VARIABLE_DELETED

      static final int VARIABLE_DELETED
      Event type constant (value = 3) that denotes a variable deletion.
      See Also:

  • Method Details

    • getValue

      IPath getValue()
      Returns the variable's current value. If the event type is VARIABLE_CHANGED then it is the new value, if the event type is VARIABLE_CREATED then it is the new value, or if the event type is VARIABLE_DELETED then it will be null.
      Returns:
      the variable's current value, or null

    • getVariableName

      String getVariableName()
      Returns the affected variable's name.
      Returns:
      the affected variable's name

    • getSource

      Object getSource()
      Returns an object identifying the source of this event.
      Returns:
      an object identifying the source of this event
      See Also:

    • getType

      int getType()
      Returns the type of event being reported.
      Returns:
      one of the event type constants
      See Also: