Package com.intellij.psi.util

Interface PsiModificationTracker

All Superinterfaces:

ModificationTracker

All Known Implementing Classes:

PsiModificationTrackerImpl

public interface PsiModificationTracker
extends ModificationTracker

An interface used to support tracking of common PSI modifications. It has three main usage patterns:

1. Get a stamp of current PSI state. This stamp is increased when PSI is modified, allowing other subsystems to check if PSI has changed since they accessed it last time. This can be used to flush and rebuild various internal caches. See getModificationCount(), getJavaStructureModificationCount(), getOutOfCodeBlockModificationCount()
2. Make a CachedValue instance dependent on a specific PSI modification tracker. To achieve that, one should can one of the constants in this interface as CachedValueProvider.Result dependencies.
3. Subscribe to any PSI change (for example, to drop caches in the listener manually). See PsiModificationTracker.Listener

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PsiModificationTracker.Listener A listener to be notified on any PSI modification count change (which happens on any physical PSI change).
static class	PsiModificationTracker.SERVICE Provides a way to get the instance of PsiModificationTracker corresponding to a given project.

Field Summary

Fields

Modifier and Type	Field and Description
static Key	JAVA_STRUCTURE_MODIFICATION_COUNT Deprecated. rarely supported by JVM language plugins; also a wrong way for optimisations
static Key	MODIFICATION_COUNT This key can be passed as a dependency in a CachedValueProvider.
static Key	OUT_OF_CODE_BLOCK_MODIFICATION_COUNT Deprecated. rarely supported by language plugins; also a wrong way for optimisations
static Topic<PsiModificationTracker.Listener>	TOPIC A topic to subscribe for all PSI modification count changes.

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Method Summary

Modifier and Type	Method and Description
long	getJavaStructureModificationCount() Deprecated. rarely supported by JVM language plugins; also a wrong way for optimisations
ModificationTracker	getJavaStructureModificationTracker() Deprecated. rarely supported by JVM language plugins; also a wrong way for optimisations
long	getModificationCount() Tracks any PSI modification.
long	getOutOfCodeBlockModificationCount() Deprecated. rarely supported by language plugins; also a wrong way for optimisations
ModificationTracker	getOutOfCodeBlockModificationTracker() Deprecated. rarely supported by language plugins; also a wrong way for optimisations

Field Detail

MODIFICATION_COUNT

static final Key MODIFICATION_COUNT

This key can be passed as a dependency in a CachedValueProvider. The corresponding CachedValue will then be flushed on every physical PSI change.

See Also:

getModificationCount()

OUT_OF_CODE_BLOCK_MODIFICATION_COUNT

@Deprecated
static final Key OUT_OF_CODE_BLOCK_MODIFICATION_COUNT

Deprecated. rarely supported by language plugins; also a wrong way for optimisations

This key can be passed as a dependency in a CachedValueProvider. The corresponding CachedValue will then be flushed on every physical PSI change that doesn't happen inside a Java code block. This can include changes on Java class or file level, or changes in non-Java files, e.g. XML. Rarely needed.

See Also:

getOutOfCodeBlockModificationCount()

JAVA_STRUCTURE_MODIFICATION_COUNT

@Deprecated
static final Key JAVA_STRUCTURE_MODIFICATION_COUNT

Deprecated. rarely supported by JVM language plugins; also a wrong way for optimisations

This key can be passed as a dependency in a CachedValueProvider. The corresponding CachedValue will then be flushed on every physical PSI change that can affect Java structure and resolve.

See Also:

getJavaStructureModificationCount()

TOPIC

static final Topic<PsiModificationTracker.Listener> TOPIC

A topic to subscribe for all PSI modification count changes.

See Also:

MessageBus

Method Detail

getModificationCount

long getModificationCount()

Tracks any PSI modification.

Specified by:

getModificationCount in interface ModificationTracker

Returns:

current counter value. Increased whenever any physical PSI is changed.

getOutOfCodeBlockModificationCount

@Deprecated
long getOutOfCodeBlockModificationCount()

Deprecated. rarely supported by language plugins; also a wrong way for optimisations

Returns:

Same as getJavaStructureModificationCount(), but also includes changes in non-Java files, e.g. XML. Rarely needed.

getOutOfCodeBlockModificationTracker

@Deprecated
ModificationTracker getOutOfCodeBlockModificationTracker()

Deprecated. rarely supported by language plugins; also a wrong way for optimisations

Returns:

an object returning getOutOfCodeBlockModificationCount()

getJavaStructureModificationCount

@Deprecated
long getJavaStructureModificationCount()

Deprecated. rarely supported by JVM language plugins; also a wrong way for optimisations

Tracks structural Java modifications, i.e. the ones on class/method/field/file level. Modifications inside method bodies are not tracked. Useful to work with resolve caches that only depend on Java structure, and not the method code.

Returns:

current counter value. Increased whenever any physical PSI in Java structure is changed.

getJavaStructureModificationTracker

@Deprecated
ModificationTracker getJavaStructureModificationTracker()

Deprecated. rarely supported by JVM language plugins; also a wrong way for optimisations

Returns:

an object returning getJavaStructureModificationCount()