Package com.intellij.openapi.vfs

Class VfsUtilCore

java.lang.Object

com.intellij.openapi.vfs.VfsUtilCore

Direct Known Subclasses:

VfsUtil

public class VfsUtilCore
extends java.lang.Object

Various utility methods for working with VirtualFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VfsUtilCore.DistinctVFilesRootsCollection this collection will keep only distinct files/folders, e.g.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCALHOST_URI_PATH_PREFIX
static java.lang.String	VFS_SEPARATOR
static char	VFS_SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
VfsUtilCore()

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	byteStreamSkippingBOM(byte [] buf, VirtualFile file)
static java.lang.String	convertFromUrl(java.net.URL url)
static java.net.URL	convertToURL(java.lang.String vfsUrl) Converts VsfUrl info URL.
static VirtualFile	copyFile(java.lang.Object requestor, VirtualFile file, VirtualFile toDir) Makes a copy of the file in the toDir folder and returns it.
static VirtualFile	copyFile(java.lang.Object requestor, VirtualFile file, VirtualFile toDir, java.lang.String newName) Makes a copy of the file in the toDir folder with the newName and returns it.
static java.lang.String	fileToUrl(java.io.File file)
static VirtualFile	findContainingDirectory(VirtualFile file, java.lang.CharSequence name)
static VirtualFile	findRelativeFile(java.lang.String uri, VirtualFile base)
static java.lang.String	findRelativePath(VirtualFile src, VirtualFile dst, char separatorChar) Returns the relative path from one virtual file to another.
static java.lang.String	fixIDEAUrl(java.lang.String ideaUrl)
static java.lang.String	fixURLforIDEA(java.lang.String url)
static VirtualFile	getCommonAncestor(VirtualFile file1, VirtualFile file2) Returns a common ancestor for the given files, or null if the files do not have one.
static java.lang.String	getRelativeLocation(VirtualFile file, VirtualFile root) Gets a relative path of file to root when it's possible This method is designed to be used for file descriptions (in trees, lists etc.)
static java.lang.String	getRelativePath(VirtualFile file, VirtualFile ancestor)
static java.lang.String	getRelativePath(VirtualFile file, VirtualFile ancestor, char separator) Gets the relative path of file to its ancestor.
static VirtualFile	getRootFile(VirtualFile file)
static VirtualFile	getVirtualFileForJar(VirtualFile entryVFile)
static boolean	hasInvalidFiles(java.lang.Iterable<? extends VirtualFile> files)
static java.io.InputStream	inputStreamSkippingBOM(java.io.InputStream stream, VirtualFile file)
static boolean	isAncestor(java.io.File ancestor, java.io.File file, boolean strict)
static boolean	isAncestor(VirtualFile ancestor, VirtualFile file, boolean strict)
static boolean	isBrokenLink(VirtualFile file) Returns true if given virtual file represents broken symbolic link (which points to non-existent file).
static boolean	isEqualOrAncestor(java.lang.String ancestorUrl, java.lang.String fileUrl)
static boolean	isInvalidLink(VirtualFile link) Returns true if given virtual file represents broken or recursive symbolic link.
static boolean	isUnder(java.lang.String url, java.util.Collection<java.lang.String> rootUrls)
static boolean	isUnder(VirtualFile file, java.util.Set<? extends VirtualFile> roots)
static boolean	iterateChildrenRecursively(VirtualFile root, VirtualFileFilter filter, ContentIterator iterator)
static boolean	iterateChildrenRecursively(VirtualFile root, VirtualFileFilter filter, ContentIterator iterator, VirtualFileVisitor.Option... options)
static byte []	loadBytes(VirtualFile file)
static java.lang.String	loadText(VirtualFile file)
static java.lang.String	loadText(VirtualFile file, int length)
static java.io.OutputStream	outputStreamAddingBOM(java.io.OutputStream stream, VirtualFile file)
static java.lang.String	pathToUrl(java.lang.String path)
static boolean	processFilesRecursively(VirtualFile root, Processor<? super VirtualFile> processor)
static java.lang.String	toIdeaUrl(java.lang.String url)
static java.lang.String	toIdeaUrl(java.lang.String url, boolean removeLocalhostPrefix)
static VirtualFile []	toVirtualFileArray(java.util.Collection<? extends VirtualFile> files)
static java.lang.String	urlToPath(java.lang.String url)
static java.io.File	virtualToIoFile(VirtualFile file)
static java.util.List<java.io.File>	virtualToIoFiles(java.util.Collection<? extends VirtualFile> files)
static VirtualFileVisitor.Result	visitChildrenRecursively(VirtualFile file, VirtualFileVisitor<?> visitor)
static <E extends java.lang.Exception> VirtualFileVisitor.Result	visitChildrenRecursively(VirtualFile file, VirtualFileVisitor<?> visitor, java.lang.Class<E> eClass)

Methods inherited from class java.lang.Object

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

Field Detail

LOCALHOST_URI_PATH_PREFIX

public static final java.lang.String LOCALHOST_URI_PATH_PREFIX

See Also:

Constant Field Values

VFS_SEPARATOR_CHAR

public static final char VFS_SEPARATOR_CHAR

See Also:

Constant Field Values

VFS_SEPARATOR

public static final java.lang.String VFS_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

VfsUtilCore

public VfsUtilCore()

Method Detail

isAncestor

public static boolean isAncestor(VirtualFile ancestor,
                                 VirtualFile file,
                                 boolean strict)

Parameters:

strict - if false then this method returns true if ancestor and file are equal

isUnder

public static boolean isUnder(VirtualFile file,
                              java.util.Set<? extends VirtualFile> roots)

Returns:

true if file is located under one of roots or equal to one of them

isUnder

public static boolean isUnder(java.lang.String url,
                              java.util.Collection<java.lang.String> rootUrls)

Returns:

true if url is located under one of rootUrls or equal to one of them

isEqualOrAncestor

public static boolean isEqualOrAncestor(java.lang.String ancestorUrl,
                                        java.lang.String fileUrl)

isAncestor

public static boolean isAncestor(java.io.File ancestor,
                                 java.io.File file,
                                 boolean strict)

getRelativeLocation

public static java.lang.String getRelativeLocation(VirtualFile file,
                                                   VirtualFile root)

Gets a relative path of file to root when it's possible This method is designed to be used for file descriptions (in trees, lists etc.)

Parameters:

file - the file

root - candidate to be parent file (Project base dir, any content roots etc.)

Returns:

relative path of file or full path if root is not actual ancestor of file

getRelativePath

public static java.lang.String getRelativePath(VirtualFile file,
                                               VirtualFile ancestor)

getRelativePath

public static java.lang.String getRelativePath(VirtualFile file,
                                               VirtualFile ancestor,
                                               char separator)

Gets the relative path of file to its ancestor. Uses separator for separating files.

Parameters:

file - the file

ancestor - parent file

separator - character to use as files separator

Returns:

the relative path or null if ancestor is not ancestor for file

findRelativePath

public static java.lang.String findRelativePath(VirtualFile src,
                                                VirtualFile dst,
                                                char separatorChar)

Returns the relative path from one virtual file to another. If src is a file, the path is calculated from its parent directory.

Parameters:

src - the file or directory, from which the path is built

dst - the file or directory, to which the path is built

separatorChar - the separator for the path components

Returns:

the relative path, or null if the files have no common ancestor

getVirtualFileForJar

public static VirtualFile getVirtualFileForJar(VirtualFile entryVFile)

copyFile

public static VirtualFile copyFile(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.

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 to make a copy of

toDir - directory to make a copy in

Throws:

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

copyFile

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

Makes a copy of the file in the toDir folder with the newName and returns it.

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 to make a copy of

toDir - directory to make a copy in

newName - a new name of the file

Returns:

a copy of the file

Throws:

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

byteStreamSkippingBOM

public static java.io.InputStream byteStreamSkippingBOM(byte [] buf,
                                                        VirtualFile file)
                                                 throws java.io.IOException

Throws:

java.io.IOException

inputStreamSkippingBOM

public static java.io.InputStream inputStreamSkippingBOM(java.io.InputStream stream,
                                                         VirtualFile file)
                                                  throws java.io.IOException

Throws:

java.io.IOException

outputStreamAddingBOM

public static java.io.OutputStream outputStreamAddingBOM(java.io.OutputStream stream,
                                                         VirtualFile file)
                                                  throws java.io.IOException

Throws:

java.io.IOException

iterateChildrenRecursively

public static boolean iterateChildrenRecursively(VirtualFile root,
                                                 VirtualFileFilter filter,
                                                 ContentIterator iterator)

iterateChildrenRecursively

public static boolean iterateChildrenRecursively(VirtualFile root,
                                                 VirtualFileFilter filter,
                                                 ContentIterator iterator,
                                                 VirtualFileVisitor.Option... options)

visitChildrenRecursively

public static VirtualFileVisitor.Result visitChildrenRecursively(VirtualFile file,
                                                                 VirtualFileVisitor<?> visitor)
                                                          throws VirtualFileVisitor.VisitorException

Throws:

VirtualFileVisitor.VisitorException

visitChildrenRecursively

public static <E extends java.lang.Exception> VirtualFileVisitor.Result visitChildrenRecursively(VirtualFile file,
                                                                                                 VirtualFileVisitor<?> visitor,
                                                                                                 java.lang.Class<E> eClass)
                                                                                          throws E extends java.lang.Exception

Throws:

E extends java.lang.Exception

isBrokenLink

public static boolean isBrokenLink(VirtualFile file)

Returns true if given virtual file represents broken symbolic link (which points to non-existent file).

isInvalidLink

public static boolean isInvalidLink(VirtualFile link)

Returns true if given virtual file represents broken or recursive symbolic link.

loadText

public static java.lang.String loadText(VirtualFile file)
                                 throws java.io.IOException

Throws:

java.io.IOException

loadText

public static java.lang.String loadText(VirtualFile file,
                                        int length)
                                 throws java.io.IOException

Throws:

java.io.IOException

loadBytes

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

Throws:

java.io.IOException

toVirtualFileArray

public static VirtualFile [] toVirtualFileArray(java.util.Collection<? extends VirtualFile> files)

urlToPath

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

virtualToIoFile

public static java.io.File virtualToIoFile(VirtualFile file)

pathToUrl

public static java.lang.String pathToUrl(java.lang.String path)

fileToUrl

public static java.lang.String fileToUrl(java.io.File file)

virtualToIoFiles

public static java.util.List<java.io.File> virtualToIoFiles(java.util.Collection<? extends VirtualFile> files)

toIdeaUrl

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

toIdeaUrl

public static java.lang.String toIdeaUrl(java.lang.String url,
                                         boolean removeLocalhostPrefix)

fixURLforIDEA

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

convertFromUrl

public static java.lang.String convertFromUrl(java.net.URL url)

convertToURL

public static java.net.URL convertToURL(java.lang.String vfsUrl)

Converts VsfUrl info URL.

Parameters:

vfsUrl - VFS url (as constructed by VirtualFile.getUrl()

Returns:

converted URL or null if error has occurred.

fixIDEAUrl

public static java.lang.String fixIDEAUrl(java.lang.String ideaUrl)

findRelativeFile

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

processFilesRecursively

public static boolean processFilesRecursively(VirtualFile root,
                                              Processor<? super VirtualFile> processor)

getCommonAncestor

public static VirtualFile getCommonAncestor(VirtualFile file1,
                                            VirtualFile file2)

Returns a common ancestor for the given files, or null if the files do not have one.

hasInvalidFiles

public static boolean hasInvalidFiles(java.lang.Iterable<? extends VirtualFile> files)

findContainingDirectory

public static VirtualFile findContainingDirectory(VirtualFile file,
                                                  java.lang.CharSequence name)

getRootFile

public static VirtualFile getRootFile(VirtualFile file)