Package com.intellij.psi.util

Class CachedValueProvider.Result<T>

java.lang.Object

com.intellij.psi.util.CachedValueProvider.Result<T>

Type Parameters:

T - the type of the cached value

Enclosing interface:

CachedValueProvider<T>

public static class CachedValueProvider.Result<T>
extends java.lang.Object

The object holding the value to cache and the dependencies indicating when that value will be outdated

Constructor Summary

Constructors

Constructor and Description
Result(T value, java.lang.Object... dependencyItems) Constructor

Method Summary

Modifier and Type	Method and Description
static <T> CachedValueProvider.Result<T>	create(T value, java.util.Collection<?> dependencies) Creates a result
static <T> CachedValueProvider.Result<T>	create(T value, java.lang.Object... dependencies) Creates a result
static <T> CachedValueProvider.Result<T>	createSingleDependency(T value, java.lang.Object dependency) Creates a result
java.lang.Object []	getDependencyItems() Dependency items are used in cached values to remember the state of the environment as it was when the value was computed and to compare that to the state of the world when querying CachedValue.getValue().
T	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result(T value,
              java.lang.Object... dependencyItems)

Constructor

See Also:

getDependencyItems()

Method Detail

getValue

public T getValue()

getDependencyItems

public java.lang.Object [] getDependencyItems()

Dependency items are used in cached values to remember the state of the environment as it was when the value was computed and to compare that to the state of the world when querying CachedValue.getValue(). The state is remembered as a collection of long values representing some time stamps. When changes occur, these stamps are incremented.

Dependencies can be following:

• Instances of ModificationTracker returning stamps explicitly
• Constant fields of PsiModificationTracker class, e.g. PsiModificationTracker.MODIFICATION_COUNT
• PsiElement or VirtualFile objects. Such cache would be dropped on any change in the corresponding file

Returns:

the dependency items

See Also:

ModificationTracker, PsiModificationTracker, ProjectRootModificationTracker

createSingleDependency

public static <T> CachedValueProvider.Result<T> createSingleDependency(T value,
                                                                       java.lang.Object dependency)

Creates a result

See Also:

getDependencyItems()

create

public static <T> CachedValueProvider.Result<T> create(T value,
                                                       java.lang.Object... dependencies)

Creates a result

See Also:

getDependencyItems()

create

public static <T> CachedValueProvider.Result<T> create(T value,
                                                       java.util.Collection<?> dependencies)

Creates a result

See Also:

getDependencyItems()