Package com.intellij.psi

Class SingleRootFileViewProvider

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.AbstractFileViewProvider

com.intellij.psi.SingleRootFileViewProvider

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, FileViewProvider, java.lang.Cloneable

Direct Known Subclasses:

ClassFileViewProvider

public class SingleRootFileViewProvider
extends AbstractFileViewProvider
implements FileViewProvider

Field Summary

Fields inherited from class com.intellij.psi.AbstractFileViewProvider

FREE_THREADED

Constructor Summary

Constructors

Modifier	Constructor and Description
	SingleRootFileViewProvider(PsiManager manager, VirtualFile file)
	SingleRootFileViewProvider(PsiManager manager, VirtualFile virtualFile, boolean eventSystemEnabled)
	SingleRootFileViewProvider(PsiManager manager, VirtualFile virtualFile, boolean eventSystemEnabled, FileType fileType)
protected	SingleRootFileViewProvider(PsiManager manager, VirtualFile virtualFile, boolean eventSystemEnabled, Language language)

Method Summary

Modifier and Type	Method and Description
SingleRootFileViewProvider	createCopy(VirtualFile copy) Creates a copy of this view provider linked with the given (typically light) file.
static void	doNotCheckFileSizeLimit(VirtualFile vFile)
static boolean	fileSizeIsGreaterThan(VirtualFile vFile, long maxBytes)
PsiElement	findElementAt(int offset)
PsiElement	findElementAt(int offset, java.lang.Class<? extends Language> lang)
PsiReference	findReferenceAt(int offset)
void	forceCachedPsi(PsiFile psiFile)
java.util.List<PsiFile>	getAllFiles()
Language	getBaseLanguage()
PsiFile	getCachedPsi(Language target)
java.util.List<PsiFile>	getCachedPsiFiles()
java.util.List<FileElement>	getKnownTreeRoots()
java.util.Set<Language>	getLanguages()
protected PsiFile	getPsiInner(Language target)
static boolean	isTooLargeForContentLoading(VirtualFile vFile)
static boolean	isTooLargeForContentLoading(VirtualFile vFile, long contentSize)
static boolean	isTooLargeForIntelligence(VirtualFile vFile)
static boolean	isTooLargeForIntelligence(VirtualFile file, long contentSize)

Methods inherited from class com.intellij.psi.AbstractFileViewProvider

beforeContentsSynchronized, clone, contentsSynchronized, createFile, createFile, createFile, findElementAt, findElementAt, findReferenceAt, findReferenceAt, getContents, getDocument, getFilePsiLock, getFileType, getManager, getModificationStamp, 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

beforeContentsSynchronized, clone, contentsSynchronized, findElementAt, findReferenceAt, getContents, getDocument, getFileType, getManager, getModificationStamp, getPsi, getStubBindingRoot, getVirtualFile, hasLanguage, isEventSystemEnabled, isPhysical, rootChanged, supportsIncrementalReparse

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

putUserDataIfAbsent, replace

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

getUserData, putUserData

Constructor Detail

SingleRootFileViewProvider

public SingleRootFileViewProvider(PsiManager manager,
                                  VirtualFile file)

SingleRootFileViewProvider

public SingleRootFileViewProvider(PsiManager manager,
                                  VirtualFile virtualFile,
                                  boolean eventSystemEnabled)

SingleRootFileViewProvider

public SingleRootFileViewProvider(PsiManager manager,
                                  VirtualFile virtualFile,
                                  boolean eventSystemEnabled,
                                  FileType fileType)

SingleRootFileViewProvider

protected SingleRootFileViewProvider(PsiManager manager,
                                     VirtualFile virtualFile,
                                     boolean eventSystemEnabled,
                                     Language language)

Method Detail

getBaseLanguage

public Language getBaseLanguage()

Specified by:

getBaseLanguage in interface FileViewProvider

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()

Specified by:

getLanguages in interface FileViewProvider

Returns:

all languages this file supports, in no particular order.

See Also:

FileViewProvider.getPsi(Language)

getAllFiles

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

Specified by:

getAllFiles in interface FileViewProvider

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.

getPsiInner

protected PsiFile getPsiInner(Language target)

Specified by:

getPsiInner in class AbstractFileViewProvider

getCachedPsi

public final PsiFile getCachedPsi(Language target)

Specified by:

getCachedPsi in class AbstractFileViewProvider

getCachedPsiFiles

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

Specified by:

getCachedPsiFiles in class AbstractFileViewProvider

getKnownTreeRoots

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

Specified by:

getKnownTreeRoots in class AbstractFileViewProvider

isTooLargeForIntelligence

public static boolean isTooLargeForIntelligence(VirtualFile vFile)

isTooLargeForContentLoading

public static boolean isTooLargeForContentLoading(VirtualFile vFile)

doNotCheckFileSizeLimit

public static void doNotCheckFileSizeLimit(VirtualFile vFile)

isTooLargeForIntelligence

public static boolean isTooLargeForIntelligence(VirtualFile file,
                                                long contentSize)

isTooLargeForContentLoading

public static boolean isTooLargeForContentLoading(VirtualFile vFile,
                                                  long contentSize)

fileSizeIsGreaterThan

public static boolean fileSizeIsGreaterThan(VirtualFile vFile,
                                            long maxBytes)

createCopy

public SingleRootFileViewProvider 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.

Specified by:

createCopy in interface FileViewProvider

See Also:

LightVirtualFile, FileViewProvider.isEventSystemEnabled()

findReferenceAt

public PsiReference findReferenceAt(int offset)

Specified by:

findReferenceAt in interface FileViewProvider

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)

Specified by:

findElementAt in interface FileViewProvider

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)

findElementAt

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

Specified by:

findElementAt in interface FileViewProvider

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)

forceCachedPsi

public final void forceCachedPsi(PsiFile psiFile)