Package com.intellij.openapi.fileEditor.impl

Class FileDocumentManagerImpl

java.lang.Object

com.intellij.openapi.fileEditor.FileDocumentManager

com.intellij.openapi.fileEditor.impl.FileDocumentManagerImpl

All Implemented Interfaces:

SafeWriteRequestor, SavingRequestor

public class FileDocumentManagerImpl
extends FileDocumentManager
implements SafeWriteRequestor

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.fileEditor.FileDocumentManager

FileDocumentManager.WriteAccessStatus

Field Summary

Fields

Modifier and Type	Field and Description
static Key<Document>	HARD_REF_TO_DOCUMENT_KEY
static Key<java.lang.Object>	NOT_RELOADABLE_DOCUMENT_KEY
static boolean	ourConflictsSolverEnabled

Constructor Summary

Constructors

Constructor and Description
FileDocumentManagerImpl()

Method Summary

Modifier and Type	Method and Description
static boolean	areTooManyDocumentsInTheQueue(java.util.Collection<? extends Document> documents)
protected void	cacheDocument(VirtualFile file, Document document)
void	contentsChanged(VFileContentChangeEvent event)
void	dropAllUnsavedDocuments()
Document	getCachedDocument(VirtualFile file) Returns the document for the specified file which has already been loaded into memory. Client code shouldn't normally use this method, because it's unpredictable and any garbage collection can result in it returning null.
Document	getDocument(VirtualFile file) Returns the document for the specified virtual file. Documents are cached on weak or strong references, depending on the nature of the virtual file.
protected Document	getDocumentFromCache(VirtualFile file)
VirtualFile	getFile(Document document) Returns the virtual file corresponding to the specified document.
static java.lang.String	getLineSeparator(Document document, VirtualFile file)
java.lang.String	getLineSeparator(VirtualFile file, Project project)
Document []	getUnsavedDocuments() Returns all documents that have unsaved changes.
boolean	isDocumentUnsaved(Document document) Checks if the document has unsaved changes.
boolean	isFileModified(VirtualFile file) Checks if the document corresponding to the specified file has unsaved changes.
boolean	isPartialPreviewOfALargeFile(Document document) Check if only beginning of the file was loaded for Document.
static boolean	recomputeFileTypeIfNecessary(VirtualFile virtualFile)
static void	registerDocument(Document document, VirtualFile virtualFile)
void	reloadFiles(VirtualFile... files) Discards unsaved changes for the specified files.
void	reloadFromDisk(Document document) Discards unsaved changes for the specified document and reloads it from disk.
protected void	removeDocumentFromCache(VirtualFile file)
boolean	requestWriting(Document document, Project project) Requests writing access on the given document, possibly involving interaction with user.
FileDocumentManager.WriteAccessStatus	requestWritingStatus(Document document, Project project) Requests writing access info on the given document.
void	saveAllDocuments() Saves all unsaved documents to disk.
void	saveAllDocuments(boolean isExplicit)
void	saveDocument(Document document) Saves the specified document to disk.
void	saveDocument(Document document, boolean explicit)
void	saveDocumentAsIs(Document document) Saves the document without stripping the trailing spaces or adding a blank line in the end of the file. Should be invoked on the event dispatch thread.

Methods inherited from class com.intellij.openapi.fileEditor.FileDocumentManager

fileForDocumentCheckedOutSuccessfully, getInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.vfs.SafeWriteRequestor

shouldUseSafeWrite

Field Detail

HARD_REF_TO_DOCUMENT_KEY

public static final Key<Document> HARD_REF_TO_DOCUMENT_KEY

NOT_RELOADABLE_DOCUMENT_KEY

public static final Key<java.lang.Object> NOT_RELOADABLE_DOCUMENT_KEY

ourConflictsSolverEnabled

public static boolean ourConflictsSolverEnabled

Constructor Detail

FileDocumentManagerImpl

public FileDocumentManagerImpl()

Method Detail

getDocument

public Document getDocument(VirtualFile file)

Description copied from class: FileDocumentManager

Returns the document for the specified virtual file.

Documents are cached on weak or strong references, depending on the nature of the virtual file. If the document for the given virtual file is not yet cached, the file's contents are read from VFS and loaded into heap memory. An appropriate encoding is used. All line separators are converted to \n.

Should be invoked in a read action.

Specified by:

getDocument in class FileDocumentManager

Parameters:

file - the file for which the document is requested.

Returns:

the document, or null if the file represents a directory, or is binary without an associated decompiler, or is too large.

See Also:

VirtualFile.contentsToByteArray(), Application.runReadAction(Computable)

areTooManyDocumentsInTheQueue

public static boolean areTooManyDocumentsInTheQueue(java.util.Collection<? extends Document> documents)

getCachedDocument

public Document getCachedDocument(VirtualFile file)

Description copied from class: FileDocumentManager

Returns the document for the specified file which has already been loaded into memory.

Client code shouldn't normally use this method, because it's unpredictable and any garbage collection can result in it returning null.

Specified by:

getCachedDocument in class FileDocumentManager

Parameters:

file - the file for which the document is requested.

Returns:

the document, or null if the specified virtual file hasn't been loaded into memory.

registerDocument

public static void registerDocument(Document document,
                                    VirtualFile virtualFile)

getFile

public VirtualFile getFile(Document document)

Description copied from class: FileDocumentManager

Returns the virtual file corresponding to the specified document.

Specified by:

getFile in class FileDocumentManager

Parameters:

document - the document for which the virtual file is requested.

Returns:

the file, or null if the document wasn't created from a virtual file.

dropAllUnsavedDocuments

public void dropAllUnsavedDocuments()

saveAllDocuments

public void saveAllDocuments()

Description copied from class: FileDocumentManager

Saves all unsaved documents to disk. This operation can modify documents that will be saved (due to 'Strip trailing spaces on Save' functionality). When saving, \n line separators are converted into the ones used normally on the system, or the ones explicitly specified by the user. Encoding settings are honored.

Should be invoked on the event dispatch thread.

Specified by:

saveAllDocuments in class FileDocumentManager

saveAllDocuments

public void saveAllDocuments(boolean isExplicit)

Parameters:

isExplicit - caused by user directly (Save action) or indirectly (e.g. Compile)

saveDocument

public void saveDocument(Document document)

Description copied from class: FileDocumentManager

Saves the specified document to disk. This operation can modify the document (due to 'Strip trailing spaces on Save' functionality). When saving, \n line separators are converted into the ones used normally on the system, or the ones explicitly specified by the user. Encoding settings are honored.

Should be invoked on the event dispatch thread.

Specified by:

saveDocument in class FileDocumentManager

Parameters:

document - the document to save.

saveDocument

public void saveDocument(Document document,
                         boolean explicit)

saveDocumentAsIs

public void saveDocumentAsIs(Document document)

Description copied from class: FileDocumentManager

Saves the document without stripping the trailing spaces or adding a blank line in the end of the file.

Should be invoked on the event dispatch thread.

Specified by:

saveDocumentAsIs in class FileDocumentManager

Parameters:

document - the document to save.

getLineSeparator

public static java.lang.String getLineSeparator(Document document,
                                                VirtualFile file)

getLineSeparator

public java.lang.String getLineSeparator(VirtualFile file,
                                         Project project)

Specified by:

getLineSeparator in class FileDocumentManager

requestWriting

public boolean requestWriting(Document document,
                              Project project)

Description copied from class: FileDocumentManager

Requests writing access on the given document, possibly involving interaction with user.

Specified by:

requestWriting in class FileDocumentManager

Parameters:

document - document

project - project

Returns:

true if writing access allowed

See Also:

ReadonlyStatusHandler.ensureFilesWritable(Project, VirtualFile...)

requestWritingStatus

public FileDocumentManager.WriteAccessStatus requestWritingStatus(Document document,
                                                                  Project project)

Description copied from class: FileDocumentManager

Requests writing access info on the given document. Can involve interaction with user.

Overrides:

requestWritingStatus in class FileDocumentManager

reloadFiles

public void reloadFiles(VirtualFile... files)

Description copied from class: FileDocumentManager

Discards unsaved changes for the specified files.

Specified by:

reloadFiles in class FileDocumentManager

Parameters:

files - the files to discard the changes for.

getUnsavedDocuments

public Document [] getUnsavedDocuments()

Description copied from class: FileDocumentManager

Returns all documents that have unsaved changes.

Specified by:

getUnsavedDocuments in class FileDocumentManager

Returns:

the documents that have unsaved changes.

isDocumentUnsaved

public boolean isDocumentUnsaved(Document document)

Description copied from class: FileDocumentManager

Checks if the document has unsaved changes.

Specified by:

isDocumentUnsaved in class FileDocumentManager

Parameters:

document - the document to check.

Returns:

true if the document has unsaved changes, false otherwise.

isFileModified

public boolean isFileModified(VirtualFile file)

Description copied from class: FileDocumentManager

Checks if the document corresponding to the specified file has unsaved changes.

Specified by:

isFileModified in class FileDocumentManager

Parameters:

file - the file to check.

Returns:

true if the file has unsaved changes, false otherwise.

isPartialPreviewOfALargeFile

public boolean isPartialPreviewOfALargeFile(Document document)

Description copied from class: FileDocumentManager

Check if only beginning of the file was loaded for Document.

Specified by:

isPartialPreviewOfALargeFile in class FileDocumentManager

See Also:

FileUtilRt.isTooLarge(long)

contentsChanged

public void contentsChanged(VFileContentChangeEvent event)

reloadFromDisk

public void reloadFromDisk(Document document)

Description copied from class: FileDocumentManager

Discards unsaved changes for the specified document and reloads it from disk.

Specified by:

reloadFromDisk in class FileDocumentManager

Parameters:

document - the document to reload.

recomputeFileTypeIfNecessary

public static boolean recomputeFileTypeIfNecessary(VirtualFile virtualFile)

cacheDocument

protected void cacheDocument(VirtualFile file,
                             Document document)

removeDocumentFromCache

protected void removeDocumentFromCache(VirtualFile file)

getDocumentFromCache

protected Document getDocumentFromCache(VirtualFile file)