FileDocumentManager (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.fileEditor.FileDocumentManager

All Implemented Interfaces:

SavingRequestor

Direct Known Subclasses:

FileDocumentManagerImpl, MockFileDocumentManagerImpl
```
public abstract class FileDocumentManager
extends java.lang.Object
implements SavingRequestor
```
Tracks the correspondence between VirtualFile instances and corresponding Document instances. Manages the saving of changes to disk.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileDocumentManager.WriteAccessStatus` Stores the write access status (true if the document has the write access; false otherwise) and a message about the reason for the read-only status.

Constructor Summary

Constructors
Constructor and Description

FileDocumentManager()

Constructors
Constructor and Description
`FileDocumentManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`fileForDocumentCheckedOutSuccessfully(Document document, Project project)`
`abstract 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.
`abstract 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.
`abstract VirtualFile`	`getFile(Document document)` Returns the virtual file corresponding to the specified document.
`static FileDocumentManager`	`getInstance()`
`abstract java.lang.String`	`getLineSeparator(VirtualFile file, Project project)`
`abstract Document []`	`getUnsavedDocuments()` Returns all documents that have unsaved changes.
`abstract boolean`	`isDocumentUnsaved(Document document)` Checks if the document has unsaved changes.
`abstract boolean`	`isFileModified(VirtualFile file)` Checks if the document corresponding to the specified file has unsaved changes.
`abstract boolean`	`isPartialPreviewOfALargeFile(Document document)` Check if only beginning of the file was loaded for Document.
`abstract void`	`reloadFiles(VirtualFile... files)` Discards unsaved changes for the specified files.
`abstract void`	`reloadFromDisk(Document document)` Discards unsaved changes for the specified document and reloads it from disk.
`abstract 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.
`abstract void`	`saveAllDocuments()` Saves all unsaved documents to disk.
`abstract void`	`saveDocument(Document document)` Saves the specified document to disk.
`abstract 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileDocumentManager
```
public FileDocumentManager()
```
- Method Detail
  - getInstance
```
public static FileDocumentManager getInstance()
```
  - getDocument
```
public abstract 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. 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.
    
    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)
  - getCachedDocument
```
public abstract 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.
    
    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.
  - getFile
```
public abstract VirtualFile getFile(Document document)
```
    Returns the virtual file corresponding to the specified document.
    
    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.
  - saveAllDocuments
```
public abstract void saveAllDocuments()
```
    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.
  - saveDocument
```
public abstract void saveDocument(Document document)
```
    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.
    
    Parameters:
    
    document - the document to save.
  - saveDocumentAsIs
```
public abstract 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.
    
    Parameters:
    
    document - the document to save.
  - getUnsavedDocuments
```
public abstract Document [] getUnsavedDocuments()
```
    Returns all documents that have unsaved changes.
    
    Returns:
    
    the documents that have unsaved changes.
  - isDocumentUnsaved
```
public abstract boolean isDocumentUnsaved(Document document)
```
    Checks if the document has unsaved changes.
    
    Parameters:
    
    document - the document to check.
    
    Returns:
    
    true if the document has unsaved changes, false otherwise.
  - isFileModified
```
public abstract boolean isFileModified(VirtualFile file)
```
    Checks if the document corresponding to the specified file has unsaved changes.
    
    Parameters:
    
    file - the file to check.
    
    Returns:
    
    true if the file has unsaved changes, false otherwise.
  - isPartialPreviewOfALargeFile
```
public abstract boolean isPartialPreviewOfALargeFile(Document document)
```
    Check if only beginning of the file was loaded for Document.
    
    See Also:
    
    FileUtilRt.isTooLarge(long)
  - reloadFromDisk
```
public abstract void reloadFromDisk(Document document)
```
    Discards unsaved changes for the specified document and reloads it from disk.
    
    Parameters:
    
    document - the document to reload.
  - getLineSeparator
```
public abstract java.lang.String getLineSeparator(VirtualFile file,
                                                  Project project)
```
  - requestWriting
```
public abstract boolean requestWriting(Document document,
                                       Project project)
```
    Requests writing access on the given document, possibly involving interaction with user.
    
    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)
```
    Requests writing access info on the given document. Can involve interaction with user.
  - fileForDocumentCheckedOutSuccessfully
```
public static boolean fileForDocumentCheckedOutSuccessfully(Document document,
                                                            Project project)
```
  - reloadFiles
```
public abstract void reloadFiles(VirtualFile... files)
```
    Discards unsaved changes for the specified files.
    
    Parameters:
    
    files - the files to discard the changes for.

Class FileDocumentManager

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileDocumentManager

Method Detail

getInstance

getDocument

getCachedDocument

getFile

saveAllDocuments

saveDocument

saveDocumentAsIs

getUnsavedDocuments

isDocumentUnsaved

isFileModified

isPartialPreviewOfALargeFile

reloadFromDisk

getLineSeparator

requestWriting

requestWritingStatus

fileForDocumentCheckedOutSuccessfully

reloadFiles