Package com.intellij.openapi.vfs

Class LocalFileSystem

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

com.intellij.openapi.vfs.LocalFileSystem

All Implemented Interfaces:

CachingVirtualFileSystem, FileSystemInterface

Direct Known Subclasses:

LocalFileSystemBase

public abstract class LocalFileSystem
extends NewVirtualFileSystem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LocalFileSystem.WatchRequest

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROTOCOL
static java.lang.String	PROTOCOL_PREFIX

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

DEFAULT_LENGTH, DEFAULT_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
LocalFileSystem()

Method Summary

Modifier and Type	Method and Description
java.util.Set<LocalFileSystem.WatchRequest>	addRootsToWatch(java.util.Collection<java.lang.String> rootPaths, boolean watchRecursively)
LocalFileSystem.WatchRequest	addRootToWatch(java.lang.String rootPath, boolean watchRecursively)
abstract VirtualFile	findFileByIoFile(java.io.File file)
static LocalFileSystem	getInstance()
abstract VirtualFile	refreshAndFindFileByIoFile(java.io.File file)
abstract void	refreshFiles(java.lang.Iterable<? extends VirtualFile> files) Performs a non-recursive synchronous refresh of specified files.
abstract void	refreshFiles(java.lang.Iterable<? extends VirtualFile> files, boolean async, boolean recursive, java.lang.Runnable onFinish)
abstract void	refreshIoFiles(java.lang.Iterable<? extends java.io.File> files) Performs a non-recursive synchronous refresh of specified files.
abstract 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.
abstract 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	removeWatchedRoot(LocalFileSystem.WatchRequest watchRequest)
void	removeWatchedRoots(java.util.Collection<LocalFileSystem.WatchRequest> watchRequests)
LocalFileSystem.WatchRequest	replaceWatchedRoot(LocalFileSystem.WatchRequest watchRequest, java.lang.String rootPath, boolean watchRecursively)
abstract java.util.Set<LocalFileSystem.WatchRequest>	replaceWatchedRoots(java.util.Collection<LocalFileSystem.WatchRequest> watchRequests, java.util.Collection<java.lang.String> recursiveRoots, java.util.Collection<java.lang.String> flatRoots) Stops watching given watch requests and starts watching new paths.
abstract 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.newvfs.NewVirtualFileSystem

addVirtualFileListener, copyFile, createChildDirectory, createChildFile, deleteFile, extractRootPath, findFileByPathIfCached, getAttributes, getCanonicallyCasedName, getRank, hasChildren, isReadOnly, isSymLink, markNewFilesAsDirty, moveFile, normalize, refreshWithoutFileWatcher, removeVirtualFileListener, renameFile, resolveSymLink

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

extractPresentableUrl, findFileByPath, getProtocol, isCaseSensitive, isValidName, refresh, refreshAndFindFileByPath

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.newvfs.FileSystemInterface

contentsToByteArray, exists, getInputStream, getLength, getOutputStream, getTimeStamp, isDirectory, isWritable, list, setTimeStamp, setWritable

Field Detail

PROTOCOL

public static final java.lang.String PROTOCOL

See Also:

Constant Field Values

PROTOCOL_PREFIX

public static final java.lang.String PROTOCOL_PREFIX

See Also:

Constant Field Values

Constructor Detail

LocalFileSystem

public LocalFileSystem()

Method Detail

getInstance

public static LocalFileSystem getInstance()

findFileByIoFile

public abstract VirtualFile findFileByIoFile(java.io.File file)

refreshAndFindFileByIoFile

public abstract VirtualFile refreshAndFindFileByIoFile(java.io.File file)

refreshIoFiles

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

Performs a non-recursive synchronous refresh of specified files.

Parameters:

files - files to refresh.

See Also:

refreshIoFiles(Iterable, boolean, boolean, Runnable)

refreshIoFiles

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

refreshFiles

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

Performs a non-recursive synchronous refresh of specified files.

Parameters:

files - files to refresh.

refreshFiles

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

addRootToWatch

public LocalFileSystem.WatchRequest addRootToWatch(java.lang.String rootPath,
                                                   boolean watchRecursively)

addRootsToWatch

public java.util.Set<LocalFileSystem.WatchRequest> addRootsToWatch(java.util.Collection<java.lang.String> rootPaths,
                                                                   boolean watchRecursively)

removeWatchedRoot

public void removeWatchedRoot(LocalFileSystem.WatchRequest watchRequest)

removeWatchedRoots

public void removeWatchedRoots(java.util.Collection<LocalFileSystem.WatchRequest> watchRequests)

replaceWatchedRoot

public LocalFileSystem.WatchRequest replaceWatchedRoot(LocalFileSystem.WatchRequest watchRequest,
                                                       java.lang.String rootPath,
                                                       boolean watchRecursively)

replaceWatchedRoots

public abstract java.util.Set<LocalFileSystem.WatchRequest> replaceWatchedRoots(java.util.Collection<LocalFileSystem.WatchRequest> watchRequests,
                                                                                java.util.Collection<java.lang.String> recursiveRoots,
                                                                                java.util.Collection<java.lang.String> flatRoots)

Stops watching given watch requests and starts watching new paths. May do nothing and return the same set of requests when it contains exactly the same paths.

registerAuxiliaryFileOperationsHandler

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

Parameters:

handler - the handler instance.

unregisterAuxiliaryFileOperationsHandler

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

Parameters:

handler - the handler instance.