Package com.intellij.openapi.vfs

Class VfsUtil

java.lang.Object

com.intellij.openapi.vfs.VfsUtilCore

com.intellij.openapi.vfs.VfsUtil

public class VfsUtil
extends VfsUtilCore

Nested Class Summary

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

VfsUtilCore.DistinctVFilesRootsCollection

Field Summary

Fields

Modifier and Type	Field and Description
static long	NOTIFICATION_DELAY_MILLIS Specifies an average delay between a file system event and a moment the IDE gets pinged about it by fsnotifier.

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

LOCALHOST_URI_PATH_PREFIX, VFS_SEPARATOR, VFS_SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
VfsUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.List<VirtualFile>	collectChildrenRecursively(VirtualFile root)
static VirtualFile	copy(java.lang.Object requestor, VirtualFile file, VirtualFile toDir) Makes a copy of the file in the toDir folder and returns it.
static void	copyDirectory(java.lang.Object requestor, VirtualFile fromDir, VirtualFile toDir, VirtualFileFilter filter) Copies all files matching the filter from fromDir to toDir.
static VirtualFile	copyFileRelative(java.lang.Object requestor, VirtualFile file, VirtualFile toDir, java.lang.String relativePath) Deprecated. obsolete
static VirtualFile	createChildSequent(java.lang.Object requestor, VirtualFile dir, java.lang.String prefix, java.lang.String extension)
static VirtualFile	createDirectories(java.lang.String directoryPath)
static VirtualFile	createDirectoryIfMissing(java.lang.String directoryPath)
static VirtualFile	createDirectoryIfMissing(VirtualFile parent, java.lang.String relativePath)
static java.lang.String	extractFileName(java.lang.String urlOrPath) Returns a name of the given file.
static java.lang.String []	filterNames(java.lang.String [] names)
static VirtualFile	findFile(java.nio.file.Path file, boolean refreshIfNeeded)
static VirtualFile	findFileByIoFile(java.io.File file, boolean refreshIfNeeded)
static VirtualFile	findFileByURL(java.net.URL url) Searches for the file specified by given java,net.URL.
static VirtualFile	findRelativeFile(VirtualFile base, java.lang.String... path)
static VirtualFile []	getChildren(VirtualFile dir)
static java.util.List<VirtualFile>	getChildren(VirtualFile dir, VirtualFileFilter filter)
static VirtualFile	getCommonAncestor(java.util.Collection<? extends VirtualFile> files) Gets the common ancestor for passed files, or null if the files do not have common ancestors.
static VirtualFile []	getCommonAncestors(VirtualFile [] files) Gets the array of common ancestors for passed files.
static VirtualFile	getLocalFile(VirtualFile file)
static java.lang.String	getNextAvailableName(VirtualFile dir, java.lang.String prefix, java.lang.String extension)
static java.lang.String	getParentDir(java.lang.String url) Return a URL of a parent directory of the given file.
static java.lang.String	getPath(VirtualFile src, VirtualFile dst, char separatorChar) Deprecated. incorrect when src is a directory; use VfsUtilCore.findRelativePath(VirtualFile, VirtualFile, char) instead
static java.lang.String	getReadableUrl(VirtualFile file)
static java.lang.String	getUrlForLibraryRoot(java.io.File libraryRoot)
static VirtualFile	getUserHomeDir()
static boolean	isBadName(java.lang.String name)
static java.util.List<VirtualFile>	markDirty(boolean recursive, boolean reloadChildren, VirtualFile... files)
static void	markDirtyAndRefresh(boolean async, boolean recursive, boolean reloadChildren, java.io.File... files)
static void	markDirtyAndRefresh(boolean async, boolean recursive, boolean reloadChildren, VirtualFile... files) Refreshes the VFS information of the given files from the local file system.
static void	processFileRecursivelyWithoutIgnored(VirtualFile root, Processor<? super VirtualFile> processor)
static VirtualFile	refreshAndFindChild(VirtualFile directory, java.lang.String name)
static void	saveText(VirtualFile file, java.lang.String text)
static byte []	toByteArray(VirtualFile file, java.lang.String text)
static java.lang.String	toIdeaUrl(java.lang.String url) Deprecated. use VfsUtilCore.toIdeaUrl(String)
static java.net.URI	toUri(java.io.File file)
static java.net.URI	toUri(java.lang.String uri) uri - may be incorrect (escaping or missed "/" before disk name under windows), may be not fully encoded, may contains query and fragment
static java.net.URI	toUri(VirtualFile file) Deprecated. incorrect, use toUri(String) if needed (to be removed in IDEA 2019

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

byteStreamSkippingBOM, convertFromUrl, convertToURL, copyFile, copyFile, fileToUrl, findContainingDirectory, findRelativeFile, findRelativePath, fixIDEAUrl, fixURLforIDEA, getCommonAncestor, getRelativeLocation, getRelativePath, getRelativePath, getRootFile, getVirtualFileForJar, hasInvalidFiles, inputStreamSkippingBOM, isAncestor, isAncestor, isBrokenLink, isEqualOrAncestor, isInvalidLink, isUnder, isUnder, iterateChildrenRecursively, iterateChildrenRecursively, loadBytes, loadText, loadText, outputStreamAddingBOM, pathToUrl, processFilesRecursively, toIdeaUrl, toVirtualFileArray, urlToPath, virtualToIoFile, virtualToIoFiles, visitChildrenRecursively, visitChildrenRecursively

Methods inherited from class java.lang.Object

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

Field Detail

NOTIFICATION_DELAY_MILLIS

public static final long NOTIFICATION_DELAY_MILLIS

Specifies an average delay between a file system event and a moment the IDE gets pinged about it by fsnotifier.

See Also:

Constant Field Values

Constructor Detail

VfsUtil

public VfsUtil()

Method Detail

saveText

public static void saveText(VirtualFile file,
                            java.lang.String text)
                     throws java.io.IOException

Throws:

java.io.IOException

toByteArray

public static byte [] toByteArray(VirtualFile file,
                                  java.lang.String text)
                           throws java.io.IOException

Throws:

java.io.IOException

copyDirectory

public static void copyDirectory(java.lang.Object requestor,
                                 VirtualFile fromDir,
                                 VirtualFile toDir,
                                 VirtualFileFilter filter)
                          throws java.io.IOException

Copies all files matching the filter from fromDir to toDir. Symlinks end special files are ignored.

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

fromDir - the directory to copy from

toDir - the directory to copy to

filter - VirtualFileFilter

Throws:

java.io.IOException - if files failed to be copied

copy

public static VirtualFile copy(java.lang.Object requestor,
                               VirtualFile file,
                               VirtualFile toDir)
                        throws java.io.IOException

Makes a copy of the file in the toDir folder and returns it. Handles both files and directories.

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

file - file or directory to make a copy of

toDir - directory to make a copy in

Throws:

java.io.IOException - if file failed to be copied

getCommonAncestors

public static VirtualFile [] getCommonAncestors(VirtualFile [] files)

Gets the array of common ancestors for passed files.

Parameters:

files - array of files

Returns:

array of common ancestors for passed files

getCommonAncestor

public static VirtualFile getCommonAncestor(java.util.Collection<? extends VirtualFile> files)

Gets the common ancestor for passed files, or null if the files do not have common ancestors.

findRelativeFile

public static VirtualFile findRelativeFile(VirtualFile base,
                                           java.lang.String... path)

findFileByURL

public static VirtualFile findFileByURL(java.net.URL url)

Searches for the file specified by given java,net.URL. Note that this method currently tested only for "file" and "jar" protocols under Unix and Windows

Parameters:

url - the URL to find file by

Returns:

VirtualFile if the file was found, null otherwise

findFile

public static VirtualFile findFile(java.nio.file.Path file,
                                   boolean refreshIfNeeded)

findFileByIoFile

public static VirtualFile findFileByIoFile(java.io.File file,
                                           boolean refreshIfNeeded)

refreshAndFindChild

public static VirtualFile refreshAndFindChild(VirtualFile directory,
                                              java.lang.String name)

toUri

public static java.net.URI toUri(java.io.File file)

Returns:

correct URL, must be used only for external communication

toUri

public static java.net.URI toUri(java.lang.String uri)

uri - may be incorrect (escaping or missed "/" before disk name under windows), may be not fully encoded, may contains query and fragment

Returns:

correct URI, must be used only for external communication

getUrlForLibraryRoot

public static java.lang.String getUrlForLibraryRoot(java.io.File libraryRoot)

getNextAvailableName

public static java.lang.String getNextAvailableName(VirtualFile dir,
                                                    java.lang.String prefix,
                                                    java.lang.String extension)

createChildSequent

public static VirtualFile createChildSequent(java.lang.Object requestor,
                                             VirtualFile dir,
                                             java.lang.String prefix,
                                             java.lang.String extension)
                                      throws java.io.IOException

Throws:

java.io.IOException

filterNames

public static java.lang.String [] filterNames(java.lang.String [] names)

isBadName

public static boolean isBadName(java.lang.String name)

createDirectories

public static VirtualFile createDirectories(java.lang.String directoryPath)
                                     throws java.io.IOException

Throws:

java.io.IOException

createDirectoryIfMissing

public static VirtualFile createDirectoryIfMissing(VirtualFile parent,
                                                   java.lang.String relativePath)
                                            throws java.io.IOException

Throws:

java.io.IOException

createDirectoryIfMissing

public static VirtualFile createDirectoryIfMissing(java.lang.String directoryPath)
                                            throws java.io.IOException

Throws:

java.io.IOException

collectChildrenRecursively

public static java.util.List<VirtualFile> collectChildrenRecursively(VirtualFile root)

processFileRecursivelyWithoutIgnored

public static void processFileRecursivelyWithoutIgnored(VirtualFile root,
                                                        Processor<? super VirtualFile> processor)

getReadableUrl

public static java.lang.String getReadableUrl(VirtualFile file)

getUserHomeDir

public static VirtualFile getUserHomeDir()

getChildren

public static VirtualFile [] getChildren(VirtualFile dir)

getChildren

public static java.util.List<VirtualFile> getChildren(VirtualFile dir,
                                                      VirtualFileFilter filter)

getParentDir

public static java.lang.String getParentDir(java.lang.String url)

Return a URL of a parent directory of the given file.

extractFileName

public static java.lang.String extractFileName(java.lang.String urlOrPath)

Returns a name of the given file.

markDirty

public static java.util.List<VirtualFile> markDirty(boolean recursive,
                                                    boolean reloadChildren,
                                                    VirtualFile... files)

markDirtyAndRefresh

public static void markDirtyAndRefresh(boolean async,
                                       boolean recursive,
                                       boolean reloadChildren,
                                       VirtualFile... files)

Refreshes the VFS information of the given files from the local file system.

This refresh is performed without help of the FileWatcher, which means that all given files will be refreshed even if the FileWatcher didn't report any changes in them. This method is slower, but more reliable, and should be preferred when it is essential to make sure all the given VirtualFiles are actually refreshed from disk.

NB: when invoking synchronous refresh from a thread other than the event dispatch thread, the current thread must NOT be in a read action.

See Also:

VirtualFile.refresh(boolean, boolean)

markDirtyAndRefresh

public static void markDirtyAndRefresh(boolean async,
                                       boolean recursive,
                                       boolean reloadChildren,
                                       java.io.File... files)

See Also:

markDirtyAndRefresh(boolean, boolean, boolean, VirtualFile...)

getLocalFile

public static VirtualFile getLocalFile(VirtualFile file)

toIdeaUrl

@Deprecated
public static java.lang.String toIdeaUrl(java.lang.String url)

Deprecated. use VfsUtilCore.toIdeaUrl(String)

copyFileRelative

@Deprecated
public static VirtualFile copyFileRelative(java.lang.Object requestor,
                                           VirtualFile file,
                                           VirtualFile toDir,
                                           java.lang.String relativePath)
                                    throws java.io.IOException

Deprecated. obsolete

Throws:

java.io.IOException

getPath

@Deprecated
public static java.lang.String getPath(VirtualFile src,
                                       VirtualFile dst,
                                       char separatorChar)

Deprecated. incorrect when src is a directory; use VfsUtilCore.findRelativePath(VirtualFile, VirtualFile, char) instead

toUri

@Deprecated
public static java.net.URI toUri(VirtualFile file)

Deprecated. incorrect, use toUri(String) if needed (to be removed in IDEA 2019