Package com.intellij.openapi.vfs.impl.local

Class LocalFileSystemBase

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

com.intellij.openapi.vfs.LocalFileSystem

com.intellij.openapi.vfs.impl.local.LocalFileSystemBase

All Implemented Interfaces:

CachingVirtualFileSystem, FileSystemInterface

Direct Known Subclasses:

LocalFileSystemImpl, TempFileSystem, Win32LocalFileSystem

public abstract class LocalFileSystemBase
extends LocalFileSystem

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.vfs.LocalFileSystem

LocalFileSystem.WatchRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Fields inherited from class com.intellij.openapi.vfs.LocalFileSystem

PROTOCOL, PROTOCOL_PREFIX

Fields inherited from interface com.intellij.openapi.vfs.newvfs.FileSystemInterface

DEFAULT_LENGTH, DEFAULT_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
LocalFileSystemBase()

Method Summary

Modifier and Type	Method and Description
byte []	contentsToByteArray(VirtualFile file)
VirtualFile	copyFile(java.lang.Object requestor, VirtualFile file, VirtualFile newParent, java.lang.String copyName) Implementation of copying files in this file system
VirtualFile	createChildDirectory(java.lang.Object requestor, VirtualFile parent, java.lang.String dir) Implementation of adding directories in this file system
VirtualFile	createChildFile(java.lang.Object requestor, VirtualFile parent, java.lang.String file) Implementation of adding files in this file system
void	deleteFile(java.lang.Object requestor, VirtualFile file) Implementation of deleting files in this file system
boolean	exists(VirtualFile file)
protected java.lang.String	extractRootPath(java.lang.String normalizedPath) IntelliJ platform calls this method with non-null value returned by NewVirtualFileSystem.normalize(java.lang.String), but if something went wrong and an implementation can't extract a valid root path nevertheless, it should return an empty string.
VirtualFile	findFileByIoFile(java.io.File file)
VirtualFile	findFileByPath(java.lang.String path) Searches for the file specified by given path.
VirtualFile	findFileByPathIfCached(java.lang.String path)
FileAttributes	getAttributes(VirtualFile file) Reads various file attributes in one shot (to reduce the number of native I/O calls).
java.lang.String	getCanonicallyCasedName(VirtualFile file)
java.io.InputStream	getInputStream(VirtualFile file) Does NOT strip the BOM from the beginning of the stream, unlike the VirtualFile.getInputStream()
long	getLength(VirtualFile file)
java.io.OutputStream	getOutputStream(VirtualFile file, java.lang.Object requestor, long modStamp, long timeStamp) Does NOT add the BOM to the beginning of the stream, unlike the VirtualFile.getOutputStream(Object)
java.lang.String	getProtocol() Gets the protocol for this file system.
int	getRank()
long	getTimeStamp(VirtualFile file)
boolean	hasChildren(VirtualFile file) Returns true if path represents a directory with at least one child.
boolean	isCaseSensitive()
boolean	isDirectory(VirtualFile file)
boolean	isReadOnly()
boolean	isSymLink(VirtualFile file)
boolean	isValidName(java.lang.String name)
boolean	isWritable(VirtualFile file)
java.lang.String []	list(VirtualFile file)
boolean	markNewFilesAsDirty()
void	moveFile(java.lang.Object requestor, VirtualFile file, VirtualFile newParent) Implementation of moving files in this file system
protected java.lang.String	normalize(java.lang.String path) Implementations should convert separator chars to forward slashes and remove duplicates ones, and convert paths to "absolute" form (so that they start from a root that is valid for this FS and could be later extracted with NewVirtualFileSystem.extractRootPath(java.lang.String)).
void	refresh(boolean asynchronous) Refreshes the cached information for all files in this file system from the physical file system.
VirtualFile	refreshAndFindFileByIoFile(java.io.File file)
VirtualFile	refreshAndFindFileByPath(java.lang.String path) Refreshes only the part of the file system needed for searching the file by the given path and finds file by the given path. This method is useful when the file was created externally and you need to find VirtualFile corresponding to it.
void	refreshFiles(java.lang.Iterable<? extends VirtualFile> files) Performs a non-recursive synchronous refresh of specified files.
void	refreshFiles(java.lang.Iterable<? extends VirtualFile> files, boolean async, boolean recursive, java.lang.Runnable onFinish)
void	refreshIoFiles(java.lang.Iterable<? extends java.io.File> files) Performs a non-recursive synchronous refresh of specified files.
void	refreshIoFiles(java.lang.Iterable<? extends java.io.File> files, boolean async, boolean recursive, java.lang.Runnable onFinish) Performs the refresh of the specified files based on filesystem events that have already been received.
void	registerAuxiliaryFileOperationsHandler(LocalFileOperationsHandler handler) Registers a handler that allows a version control system plugin to intercept file operations in the local file system and to perform them through the VCS tool.
void	renameFile(java.lang.Object requestor, VirtualFile file, java.lang.String newName) Implementation of renaming files in this file system
java.lang.String	resolveSymLink(VirtualFile file)
void	setTimeStamp(VirtualFile file, long timeStamp)
void	setWritable(VirtualFile file, boolean writableFlag)
void	unregisterAuxiliaryFileOperationsHandler(LocalFileOperationsHandler handler) Unregisters a handler that allows a version control system plugin to intercept file operations in the local file system and to perform them through the VCS tool.

Methods inherited from class com.intellij.openapi.vfs.LocalFileSystem

addRootsToWatch, addRootToWatch, getInstance, removeWatchedRoot, removeWatchedRoots, replaceWatchedRoot, replaceWatchedRoots

Methods inherited from class com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

addVirtualFileListener, refreshWithoutFileWatcher, removeVirtualFileListener

Methods inherited from class com.intellij.openapi.vfs.VirtualFileSystem

extractPresentableUrl

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

LocalFileSystemBase

public LocalFileSystemBase()

Method Detail

findFileByPath

public VirtualFile findFileByPath(java.lang.String path)

Description copied from class: VirtualFileSystem

Searches for the file specified by given path. Path is a string which uniquely identifies file within given VirtualFileSystem. Format of the path depends on the concrete file system. For LocalFileSystem it is an absolute path (both Unix- and Windows-style separator chars are allowed).

Specified by:

findFileByPath in class VirtualFileSystem

Parameters:

path - the path to find file by

Returns:

a virtual file if found, null otherwise

findFileByPathIfCached

public VirtualFile findFileByPathIfCached(java.lang.String path)

Specified by:

findFileByPathIfCached in class NewVirtualFileSystem

refreshAndFindFileByPath

public VirtualFile refreshAndFindFileByPath(java.lang.String path)

Description copied from class: VirtualFileSystem

Refreshes only the part of the file system needed for searching the file by the given path and finds file by the given path.

This method is useful when the file was created externally and you need to find VirtualFile corresponding to it.

If this method is invoked not from Swing event dispatch thread, then it must not happen inside a read action. The reason is that then the method call won't return until proper VFS events are fired, which happens on Swing thread and in write action. So invoking this method in a read action would result in a deadlock.

Specified by:

refreshAndFindFileByPath in class VirtualFileSystem

Parameters:

path - the path

Returns:

VirtualFile if the file was found, null otherwise

findFileByIoFile

public VirtualFile findFileByIoFile(java.io.File file)

Specified by:

findFileByIoFile in class LocalFileSystem

exists

public boolean exists(VirtualFile file)

getLength

public long getLength(VirtualFile file)

getTimeStamp

public long getTimeStamp(VirtualFile file)

isDirectory

public boolean isDirectory(VirtualFile file)

isWritable

public boolean isWritable(VirtualFile file)

isSymLink

public boolean isSymLink(VirtualFile file)

Specified by:

isSymLink in interface FileSystemInterface

Overrides:

isSymLink in class NewVirtualFileSystem

resolveSymLink

public java.lang.String resolveSymLink(VirtualFile file)

Specified by:

resolveSymLink in interface FileSystemInterface

Overrides:

resolveSymLink in class NewVirtualFileSystem

list

public java.lang.String [] list(VirtualFile file)

getProtocol

public java.lang.String getProtocol()

Description copied from class: VirtualFileSystem

Gets the protocol for this file system. Protocols should differ for all file systems. Should be the same as corresponding KeyedLazyInstanceEP.key.

Specified by:

getProtocol in class VirtualFileSystem

Returns:

String representing the protocol

See Also:

VirtualFile.getUrl(), VirtualFileManager.getFileSystem(java.lang.String)

isReadOnly

public boolean isReadOnly()

Overrides:

isReadOnly in class NewVirtualFileSystem

normalize

protected java.lang.String normalize(java.lang.String path)

Description copied from class: NewVirtualFileSystem

Implementations should convert separator chars to forward slashes and remove duplicates ones, and convert paths to "absolute" form (so that they start from a root that is valid for this FS and could be later extracted with NewVirtualFileSystem.extractRootPath(java.lang.String)).

Implementations should not normalize paths by eliminating directory traversals or other indirections.

Overrides:

normalize in class NewVirtualFileSystem

Returns:

a normalized path, or null when a path is invalid for this FS.

refreshAndFindFileByIoFile

public VirtualFile refreshAndFindFileByIoFile(java.io.File file)

Specified by:

refreshAndFindFileByIoFile in class LocalFileSystem

refreshIoFiles

public void refreshIoFiles(java.lang.Iterable<? extends java.io.File> files)

Description copied from class: LocalFileSystem

Performs a non-recursive synchronous refresh of specified files.

Specified by:

refreshIoFiles in class LocalFileSystem

Parameters:

files - files to refresh.

See Also:

LocalFileSystem.refreshIoFiles(Iterable, boolean, boolean, Runnable)

refreshIoFiles

public void refreshIoFiles(java.lang.Iterable<? extends java.io.File> files,
                           boolean async,
                           boolean recursive,
                           java.lang.Runnable onFinish)

Description copied from class: LocalFileSystem

Performs the refresh of the specified files based on filesystem events that have already been received. To perform refresh reliably for file operations that have just finished (so that related events might not have been generated), use VfsUtil.markDirtyAndRefresh(boolean, boolean, boolean, File...) instead.

Specified by:

refreshIoFiles in class LocalFileSystem

refreshFiles

public void refreshFiles(java.lang.Iterable<? extends VirtualFile> files)

Description copied from class: LocalFileSystem

Performs a non-recursive synchronous refresh of specified files.

Specified by:

refreshFiles in class LocalFileSystem

Parameters:

files - files to refresh.

refreshFiles

public void refreshFiles(java.lang.Iterable<? extends VirtualFile> files,
                         boolean async,
                         boolean recursive,
                         java.lang.Runnable onFinish)

Specified by:

refreshFiles in class LocalFileSystem

registerAuxiliaryFileOperationsHandler

public void registerAuxiliaryFileOperationsHandler(LocalFileOperationsHandler handler)

Description copied from class: LocalFileSystem

Registers a handler that allows a version control system plugin to intercept file operations in the local file system and to perform them through the VCS tool.

Specified by:

registerAuxiliaryFileOperationsHandler in class LocalFileSystem

Parameters:

handler - the handler instance.

unregisterAuxiliaryFileOperationsHandler

public void unregisterAuxiliaryFileOperationsHandler(LocalFileOperationsHandler handler)

Description copied from class: LocalFileSystem

Unregisters a handler that allows a version control system plugin to intercept file operations in the local file system and to perform them through the VCS tool.

Specified by:

unregisterAuxiliaryFileOperationsHandler in class LocalFileSystem

Parameters:

handler - the handler instance.

createChildDirectory

public VirtualFile createChildDirectory(java.lang.Object requestor,
                                        VirtualFile parent,
                                        java.lang.String dir)
                                 throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of adding directories in this file system

Specified by:

createChildDirectory in interface FileSystemInterface

Specified by:

createChildDirectory in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildDirectory(Object,String)

createChildFile

public VirtualFile createChildFile(java.lang.Object requestor,
                                   VirtualFile parent,
                                   java.lang.String file)
                            throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of adding files in this file system

Specified by:

createChildFile in interface FileSystemInterface

Specified by:

createChildFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildData(Object,String)

deleteFile

public void deleteFile(java.lang.Object requestor,
                       VirtualFile file)
                throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of deleting files in this file system

Specified by:

deleteFile in interface FileSystemInterface

Specified by:

deleteFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.delete(Object)

isCaseSensitive

public boolean isCaseSensitive()

Overrides:

isCaseSensitive in class VirtualFileSystem

isValidName

public boolean isValidName(java.lang.String name)

Overrides:

isValidName in class VirtualFileSystem

getInputStream

public java.io.InputStream getInputStream(VirtualFile file)
                                   throws java.io.IOException

Description copied from interface: FileSystemInterface

Does NOT strip the BOM from the beginning of the stream, unlike the VirtualFile.getInputStream()

Throws:

java.io.IOException

contentsToByteArray

public byte [] contentsToByteArray(VirtualFile file)
                            throws java.io.IOException

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream(VirtualFile file,
                                            java.lang.Object requestor,
                                            long modStamp,
                                            long timeStamp)
                                     throws java.io.IOException

Description copied from interface: FileSystemInterface

Does NOT add the BOM to the beginning of the stream, unlike the VirtualFile.getOutputStream(Object)

Throws:

java.io.IOException

moveFile

public void moveFile(java.lang.Object requestor,
                     VirtualFile file,
                     VirtualFile newParent)
              throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of moving files in this file system

Specified by:

moveFile in interface FileSystemInterface

Specified by:

moveFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.move(Object,VirtualFile)

renameFile

public void renameFile(java.lang.Object requestor,
                       VirtualFile file,
                       java.lang.String newName)
                throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of renaming files in this file system

Specified by:

renameFile in interface FileSystemInterface

Specified by:

renameFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.rename(Object,String)

copyFile

public VirtualFile copyFile(java.lang.Object requestor,
                            VirtualFile file,
                            VirtualFile newParent,
                            java.lang.String copyName)
                     throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of copying files in this file system

Specified by:

copyFile in interface FileSystemInterface

Specified by:

copyFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.copy(Object,VirtualFile,String)

setTimeStamp

public void setTimeStamp(VirtualFile file,
                         long timeStamp)

setWritable

public void setWritable(VirtualFile file,
                        boolean writableFlag)
                 throws java.io.IOException

Throws:

java.io.IOException

extractRootPath

protected java.lang.String extractRootPath(java.lang.String normalizedPath)

Description copied from class: NewVirtualFileSystem

IntelliJ platform calls this method with non-null value returned by NewVirtualFileSystem.normalize(java.lang.String), but if something went wrong and an implementation can't extract a valid root path nevertheless, it should return an empty string.

Specified by:

extractRootPath in class NewVirtualFileSystem

getRank

public int getRank()

Specified by:

getRank in class NewVirtualFileSystem

markNewFilesAsDirty

public boolean markNewFilesAsDirty()

Overrides:

markNewFilesAsDirty in class NewVirtualFileSystem

getCanonicallyCasedName

public java.lang.String getCanonicallyCasedName(VirtualFile file)

Overrides:

getCanonicallyCasedName in class NewVirtualFileSystem

getAttributes

public FileAttributes getAttributes(VirtualFile file)

Description copied from class: NewVirtualFileSystem

Reads various file attributes in one shot (to reduce the number of native I/O calls).

Specified by:

getAttributes in class NewVirtualFileSystem

Parameters:

file - file to get attributes of.

Returns:

attributes of a given file, or null if the file doesn't exist.

refresh

public void refresh(boolean asynchronous)

Description copied from class: VirtualFileSystem

Refreshes the cached information for all files in this file system from the physical file system.

If asynchronous is false this method should be only called within write-action. See Application.runWriteAction(java.lang.Runnable).

Specified by:

refresh in class VirtualFileSystem

Parameters:

asynchronous - if true then the operation will be performed in a separate thread, otherwise will be performed immediately

See Also:

VirtualFile.refresh(boolean, boolean), VirtualFileManager.syncRefresh(), VirtualFileManager.asyncRefresh(java.lang.Runnable)

hasChildren

public boolean hasChildren(VirtualFile file)

Description copied from class: NewVirtualFileSystem

Returns true if path represents a directory with at least one child. Override if your file system can answer this question more efficiently (e.g. without enumerating all children).

Overrides:

hasChildren in class NewVirtualFileSystem