Package com.intellij.psi

Class DummyHolderViewProvider

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.AbstractFileViewProvider

com.intellij.psi.DummyHolderViewProvider

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, FileViewProvider, java.lang.Cloneable

public class DummyHolderViewProvider
extends AbstractFileViewProvider

Field Summary

Fields inherited from class com.intellij.psi.AbstractFileViewProvider

FREE_THREADED

Constructor Summary

Constructors

Constructor and Description
DummyHolderViewProvider(PsiManager manager)

Method Summary

Modifier and Type	Method and Description
FileViewProvider	createCopy(VirtualFile copy) Creates a copy of this view provider linked with the given (typically light) file.
PsiElement	findElementAt(int offset)
PsiElement	findElementAt(int offset, java.lang.Class<? extends Language> lang)
PsiReference	findReferenceAt(int offset)
java.util.List<PsiFile>	getAllFiles()
Language	getBaseLanguage()
PsiFile	getCachedPsi(Language target)
java.util.List<PsiFile>	getCachedPsiFiles()
java.lang.CharSequence	getContents()
java.util.List<FileElement>	getKnownTreeRoots()
java.util.Set<Language>	getLanguages()
long	getModificationStamp()
protected PsiFile	getPsiInner(Language target)
void	setDummyHolder(DummyHolder dummyHolder)

Methods inherited from class com.intellij.psi.AbstractFileViewProvider

beforeContentsSynchronized, clone, contentsSynchronized, createFile, createFile, createFile, findElementAt, findElementAt, findReferenceAt, findReferenceAt, getDocument, getFilePsiLock, getFileType, getManager, getPsi, getStubBindingRoot, getVirtualFile, isEventSystemEnabled, isFreeThreaded, isIgnored, isPhysical, markInvalidated, markPossiblyInvalidated, onContentReload, registerAsCopy, rootChanged, shouldCreatePsi, supportsIncrementalReparse, toString

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.psi.FileViewProvider

hasLanguage

Methods inherited from interface com.intellij.openapi.util.UserDataHolderEx

putUserDataIfAbsent, replace

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Constructor Detail

DummyHolderViewProvider

public DummyHolderViewProvider(PsiManager manager)

Method Detail

getContents

public java.lang.CharSequence getContents()

Specified by:

getContents in interface FileViewProvider

Overrides:

getContents in class AbstractFileViewProvider

Returns:

the contents of this file view provider, which are parsed into PSI trees. May or may not be equal to the contents of the corresponding document. The latter happens for non-committed documents. If the document is modified but not yet committed, the result is equivalent to PsiDocumentManager.getLastCommittedText(Document).

See Also:

FileViewProvider.getDocument(), PsiDocumentManager.isUncommited(Document)

getBaseLanguage

public Language getBaseLanguage()

Returns:

the language of the main PSI tree (or the only one in a single-tree view providers). Used when returning a PsiFile from PsiManager.findFile(VirtualFile), PsiDocumentManager.getPsiFile(Document) etc.

getLanguages

public java.util.Set<Language> getLanguages()

Returns:

all languages this file supports, in no particular order.

See Also:

FileViewProvider.getPsi(Language)

getPsiInner

protected PsiFile getPsiInner(Language target)

Specified by:

getPsiInner in class AbstractFileViewProvider

getCachedPsi

public PsiFile getCachedPsi(Language target)

Specified by:

getCachedPsi in class AbstractFileViewProvider

getCachedPsiFiles

public java.util.List<PsiFile> getCachedPsiFiles()

Specified by:

getCachedPsiFiles in class AbstractFileViewProvider

getKnownTreeRoots

public java.util.List<FileElement> getKnownTreeRoots()

Specified by:

getKnownTreeRoots in class AbstractFileViewProvider

getAllFiles

public java.util.List<PsiFile> getAllFiles()

Returns:

all PSI files for this view provider. In most cases, just one main file. For multi-root languages, several files. The files' languages should be the same as FileViewProvider.getLanguages(). The main file which corresponds to FileViewProvider.getBaseLanguage(), should be the first one. Otherwise the order is non-deterministic and should not be relied upon.

getModificationStamp

public long getModificationStamp()

Specified by:

getModificationStamp in interface FileViewProvider

Overrides:

getModificationStamp in class AbstractFileViewProvider

Returns:

a number to quickly check if contents of this view provider have diverged from the corresponding VirtualFile or Document. If a document is modified but not yet committed, the result is the same as PsiDocumentManager.getLastCommittedStamp(Document)

See Also:

VirtualFile.getModificationStamp(), Document.getModificationStamp()

setDummyHolder

public void setDummyHolder(DummyHolder dummyHolder)

findReferenceAt

public PsiReference findReferenceAt(int offset)

Returns:

a reference in the main PSI tree at the specified offset.

See Also:

FileViewProvider.getBaseLanguage(), PsiElement.findReferenceAt(int), FileViewProvider.findReferenceAt(int, Language)

findElementAt

public PsiElement findElementAt(int offset,
                                java.lang.Class<? extends Language> lang)

Returns:

the deepest (leaf) PSI element in the PSI tree with the specified root language class at the specified offset.

See Also:

FileViewProvider.getBaseLanguage(), FileViewProvider.findElementAt(int)

createCopy

public FileViewProvider createCopy(VirtualFile copy)

Description copied from interface: FileViewProvider

Creates a copy of this view provider linked with the given (typically light) file. The result provider is required to be NOT event-system-enabled.

See Also:

LightVirtualFile, FileViewProvider.isEventSystemEnabled()

findElementAt

public PsiElement findElementAt(int offset)

Returns:

the deepest (leaf) PSI element in the main PSI tree at the specified offset.

See Also:

FileViewProvider.getBaseLanguage(), FileViewProvider.findElementAt(int, Class), FileViewProvider.findElementAt(int, Language), PsiElement.findElementAt(int)