MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

[core-api] CachedValueProvider: update Javadoc to mention Document as a valid dependency + minor cleanup

Browse Source 
GitOrigin-RevId: d34d64a24a07b1335167836e05585fc1946cc6cc
This commit is contained in:
Bartek Pacia
2025-09-30 09:20:52 +00:00
committed by intellij-monorepo-bot
parent eacc96f4bb
commit d37674ac5b
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/core-api/src/com/intellij/psi/util/CachedValueProvider.java
+4 -3
View File
@@ -62,15 +62,16 @@ public interface CachedValueProvider<T> {
* and to compare that to the state of the world when querying {@link CachedValue#getValue()}.
* <p>
* The state is remembered as a collection of {@code long} values representing some time stamps.
* Whenever changes occur, these stamps are incremented.
* Whenever changes to the dependencies occur, these stamps are incremented.
* <p>
* Dependencies can be the following:
* <ul>
* <li/>Instances of {@link com.intellij.openapi.util.ModificationTracker ModificationTracker} returning stamps explicitly
* <li/>Constant fields of {@link PsiModificationTracker} class, e.g. {@link PsiModificationTracker#MODIFICATION_COUNT}
* <li/>Instances of {@link com.intellij.openapi.editor.Document Document} or {@link com.intellij.openapi.vfs.VirtualFile VirtualFile}.
* Invalidated on any change in the corresponding file.
* <li/>Instances of {@link PsiElement}. Invalidated on any change in the {@link PsiElement#getContainingFile() element's containing file}.
* Such a cache is invalidated any change in the corresponding file.
* <li/>Instances of {@link PsiElement}.
* Such a cache is invalidated on any change in the {@link PsiElement#getContainingFile() element's containing file}.
* </ul>
* <p>
* If your cached value uses a document instance as an input, you should use that document as a dependency.