Package com.intellij.util.gist

Class GistManager

java.lang.Object

com.intellij.util.gist.GistManager

Direct Known Subclasses:

GistManagerImpl

public abstract class GistManager
extends java.lang.Object

A helper class for working with file gists: associating persistent data with current VFS or PSI file contents.

Constructor Summary

Constructors

Constructor and Description
GistManager()

Method Summary

Modifier and Type	Method and Description
static GistManager	getInstance()
abstract void	invalidateData() Force all gists to be recalculated on the next request.
abstract <Data> PsiFileGist<Data>	newPsiFileGist(java.lang.String id, int version, DataExternalizer<Data> externalizer, NullableFunction<PsiFile,Data> calcData) Create a new PsiFileGist.
abstract <Data> VirtualFileGist<Data>	newVirtualFileGist(java.lang.String id, int version, DataExternalizer<Data> externalizer, VirtualFileGist.GistCalculator<Data> calcData) Create a new VirtualFileGist.

Methods inherited from class java.lang.Object

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

Constructor Detail

GistManager

public GistManager()

Method Detail

getInstance

public static GistManager getInstance()

newVirtualFileGist

public abstract <Data> VirtualFileGist<Data> newVirtualFileGist(java.lang.String id,
                                                                int version,
                                                                DataExternalizer<Data> externalizer,
                                                                VirtualFileGist.GistCalculator<Data> calcData)

Create a new VirtualFileGist.

Type Parameters:

Data - the type of the data to cache

Parameters:

id - a unique identifier of this data

version - should be incremented each time the externalizer or calcData logic changes.

externalizer - used to store the data to the disk and retrieve it

calcData - calculates the data by the file content when needed

Returns:

the gist object, where VirtualFileGist.getFileData(com.intellij.openapi.project.Project, com.intellij.openapi.vfs.VirtualFile) can later be used to retrieve the cached data

newPsiFileGist

public abstract <Data> PsiFileGist<Data> newPsiFileGist(java.lang.String id,
                                                        int version,
                                                        DataExternalizer<Data> externalizer,
                                                        NullableFunction<PsiFile,Data> calcData)

Create a new PsiFileGist.

Type Parameters:

Data - the type of the data to cache

Parameters:

id - a unique identifier of this data

version - should be incremented each time the externalizer or calcData logic changes.

externalizer - used to store the data to the disk and retrieve it

calcData - calculates the data by the file content when needed

Returns:

the gist object, where PsiFileGist.getFileData(com.intellij.psi.PsiFile) can later be used to retrieve the cached data

invalidateData

public abstract void invalidateData()

Force all gists to be recalculated on the next request.