Package com.intellij.psi

Class PsiTreeChangeEvent

java.lang.Object

java.util.EventObject

com.intellij.psi.PsiTreeChangeEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PsiTreeChangeEventImpl

public abstract class PsiTreeChangeEvent
extends java.util.EventObject

Provides information about a change in the PSI tree of a project.

Try to avoid processing PSI events at all cost! It's very hard to do this correctly and handle all edge cases. Please use CachedValue with PsiModificationTracker.MODIFICATION_COUNT or VFS events where possible. Here are just some of the complications with PSI events:

• Don't hope that if you replaced just one letter in an identifier, you'll get a "replaced" event about that identifier. You might as well get anything, e.g. a "replaced" event for the whole FileElement.
• Or not even that: you might get "propertyChanged" with PROP_UNLOADED_PSI, not mentioning your file at all.
• Before-/after-events aren't necessarily paired: you could get several "beforeChildDeletion" and then only "childrenChanged".
• In event handler, you should be very careful to avoid traversing invalid PSI or expanding lazy-parseable elements.
• There's no specification, and the precise events you get can be changed in future as the infrastructure algorithms are improved or bugs are fixed.
• To say nothing of the fact that the precise events already depend on file size and the unpredictable activity of garbage collector, so events in production might differ from the ones you've seen in test environment.

See Also:

PsiTreeChangeListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiElement	myChild
protected PsiElement	myElement
protected PsiFile	myFile
protected PsiElement	myNewChild
protected PsiElement	myNewParent
protected java.lang.Object	myNewValue
protected int	myOffset
protected PsiElement	myOldChild
protected int	myOldLength
protected PsiElement	myOldParent
protected java.lang.Object	myOldValue
protected PsiElement	myParent
protected java.lang.String	myPropertyName
static java.lang.String	PROP_DIRECTORY_NAME
static java.lang.String	PROP_FILE_NAME
static java.lang.String	PROP_FILE_TYPES
static java.lang.String	PROP_ROOTS
static java.lang.String	PROP_UNLOADED_PSI A property change event with this property is fired when some change (e.g.
static java.lang.String	PROP_WRITABLE

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PsiTreeChangeEvent(PsiManager manager)

Method Summary

Modifier and Type	Method and Description
PsiElement	getChild()
PsiElement	getElement()
PsiFile	getFile()
PsiElement	getNewChild()
PsiElement	getNewParent()
java.lang.Object	getNewValue()
PsiElement	getOldChild()
PsiElement	getOldParent()
java.lang.Object	getOldValue()
PsiElement	getParent()
java.lang.String	getPropertyName()

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROP_FILE_NAME

public static final java.lang.String PROP_FILE_NAME

See Also:

Constant Field Values

PROP_DIRECTORY_NAME

public static final java.lang.String PROP_DIRECTORY_NAME

See Also:

Constant Field Values

PROP_WRITABLE

public static final java.lang.String PROP_WRITABLE

See Also:

Constant Field Values

PROP_ROOTS

public static final java.lang.String PROP_ROOTS

See Also:

Constant Field Values

PROP_FILE_TYPES

public static final java.lang.String PROP_FILE_TYPES

See Also:

Constant Field Values

PROP_UNLOADED_PSI

public static final java.lang.String PROP_UNLOADED_PSI

A property change event with this property is fired when some change (e.g. VFS) somewhere in the project has occurred, and there was no PSI loaded for that area, so no more specific events about that PSI can be generated. Given the absence of specific information, the most likely strategy for listeners is to clear all their cache.

See Also:

Constant Field Values

myParent

protected PsiElement myParent

myOldParent

protected PsiElement myOldParent

myNewParent

protected PsiElement myNewParent

myChild

protected PsiElement myChild

myOldChild

protected PsiElement myOldChild

myNewChild

protected PsiElement myNewChild

myFile

protected PsiFile myFile

myOffset

protected int myOffset

myOldLength

protected int myOldLength

myElement

protected PsiElement myElement

myPropertyName

protected java.lang.String myPropertyName

myOldValue

protected java.lang.Object myOldValue

myNewValue

protected java.lang.Object myNewValue

Constructor Detail

PsiTreeChangeEvent

protected PsiTreeChangeEvent(PsiManager manager)

Method Detail

getParent

public PsiElement getParent()

getOldParent

public PsiElement getOldParent()

getNewParent

public PsiElement getNewParent()

getChild

public PsiElement getChild()

getOldChild

public PsiElement getOldChild()

getNewChild

public PsiElement getNewChild()

getElement

public PsiElement getElement()

getPropertyName

public java.lang.String getPropertyName()

getOldValue

public java.lang.Object getOldValue()

getNewValue

public java.lang.Object getNewValue()

getFile

public PsiFile getFile()