Package com.intellij.psi.util

Class CachedValuesManager

java.lang.Object

com.intellij.psi.util.CachedValuesManager

Direct Known Subclasses:

CachedValuesManagerImpl

public abstract class CachedValuesManager
extends java.lang.Object

A service used to create and store CachedValue objects.

By default cached values are stored in the user data of associated objects implementing UserDataHolder.

See Also:

createCachedValue(CachedValueProvider, boolean), getCachedValue(PsiElement, CachedValueProvider), getCachedValue(UserDataHolder, CachedValueProvider)

Constructor Summary

Constructors

Constructor and Description
CachedValuesManager()

Method Summary

Modifier and Type	Method and Description
<T> CachedValue<T>	createCachedValue(CachedValueProvider<T> provider) Creates a new CachedValue instance with the given provider.
abstract <T> CachedValue<T>	createCachedValue(CachedValueProvider<T> provider, boolean trackValue) Creates new CachedValue instance with given provider.
abstract <T,P> ParameterizedCachedValue<T,P>	createParameterizedCachedValue(ParameterizedCachedValueProvider<T,P> provider, boolean trackValue)
static <T> T	getCachedValue(PsiElement psi, CachedValueProvider<T> provider) Create a cached value with the given provider and non-tracked return value, store it in PSI element's user data.
static <T> T	getCachedValue(PsiElement psi, Key<CachedValue<T>> key, CachedValueProvider<T> provider) Create a cached value with the given provider and non-tracked return value, store it in PSI element's user data.
<T> T	getCachedValue(UserDataHolder dataHolder, CachedValueProvider<T> provider) Create a cached value with the given provider and non-tracked return value, store it in the first argument's user data.
abstract <T> T	getCachedValue(UserDataHolder dataHolder, Key<CachedValue<T>> key, CachedValueProvider<T> provider, boolean trackValue) Utility method storing created cached values in a UserDataHolder.
<T> Key<CachedValue<T>>	getKeyForClass(java.lang.Class<?> providerClass)
static CachedValuesManager	getManager(Project project)
<T,P> T	getParameterizedCachedValue(UserDataHolder dataHolder, Key<ParameterizedCachedValue<T,P>> key, ParameterizedCachedValueProvider<T,P> provider, boolean trackValue, P parameter)
protected abstract void	trackKeyHolder(UserDataHolder dataHolder, Key<?> key)

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedValuesManager

public CachedValuesManager()

Method Detail

getManager

public static CachedValuesManager getManager(Project project)

createCachedValue

public abstract <T> CachedValue<T> createCachedValue(CachedValueProvider<T> provider,
                                                     boolean trackValue)

Creates new CachedValue instance with given provider. If the return value is marked as trackable, it's treated as yet another dependency and must comply its specification. See CachedValueProvider.Result.getDependencyItems() for the details.

Parameters:

provider - computes values.

trackValue - if value tracking is required. T should be trackable in this case.

Returns:

new CachedValue instance.

createParameterizedCachedValue

public abstract <T,P> ParameterizedCachedValue<T,P> createParameterizedCachedValue(ParameterizedCachedValueProvider<T,P> provider,
                                                                                   boolean trackValue)

createCachedValue

public <T> CachedValue<T> createCachedValue(CachedValueProvider<T> provider)

Creates a new CachedValue instance with the given provider.

getParameterizedCachedValue

public <T,P> T getParameterizedCachedValue(UserDataHolder dataHolder,
                                           Key<ParameterizedCachedValue<T,P>> key,
                                           ParameterizedCachedValueProvider<T,P> provider,
                                           boolean trackValue,
                                           P parameter)

trackKeyHolder

protected abstract void trackKeyHolder(UserDataHolder dataHolder,
                                       Key<?> key)

getCachedValue

public abstract <T> T getCachedValue(UserDataHolder dataHolder,
                                     Key<CachedValue<T>> key,
                                     CachedValueProvider<T> provider,
                                     boolean trackValue)

Utility method storing created cached values in a UserDataHolder. The passed cached value provider may only depend on the passed user data holder and longer-living system state (e.g. project/application components/services), see CachedValue documentation for more details.

Parameters:

dataHolder - holder to store the cached value, e.g. a PsiElement.

key - key to store the cached value.

provider - provider creating the cached value.

trackValue - if value tracking is required (T should be trackable in that case). See createCachedValue(CachedValueProvider, boolean) for more details.

Returns:

up-to-date value.

getCachedValue

public <T> T getCachedValue(UserDataHolder dataHolder,
                            CachedValueProvider<T> provider)

Create a cached value with the given provider and non-tracked return value, store it in the first argument's user data. If it's already stored, reuse it. The passed cached value provider may only depend on the passed user data holder and longer-living system state (e.g. project/application components/services), see CachedValue documentation for more details.

Returns:

The cached value

getCachedValue

public static <T> T getCachedValue(PsiElement psi,
                                   CachedValueProvider<T> provider)

Create a cached value with the given provider and non-tracked return value, store it in PSI element's user data. If it's already stored, reuse it. The passed cached value provider may only depend on the passed PSI element and project/application components/services, see CachedValue documentation for more details.

Returns:

The cached value

getCachedValue

public static <T> T getCachedValue(PsiElement psi,
                                   Key<CachedValue<T>> key,
                                   CachedValueProvider<T> provider)

Create a cached value with the given provider and non-tracked return value, store it in PSI element's user data. If it's already stored, reuse it. The passed cached value provider may only depend on the passed PSI element and project/application components/services, see CachedValue documentation for more details.

Returns:

The cached value

getKeyForClass

public <T> Key<CachedValue<T>> getKeyForClass(java.lang.Class<?> providerClass)