Package com.intellij.openapi.vfs.impl.jrt

Class JrtFileSystemImpl

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

com.intellij.openapi.vfs.newvfs.ArchiveFileSystem

com.intellij.openapi.vfs.jrt.JrtFileSystem

com.intellij.openapi.vfs.impl.jrt.JrtFileSystemImpl

All Implemented Interfaces:

CachingVirtualFileSystem, FileSystemInterface, VirtualFilePointerCapableFileSystem

public class JrtFileSystemImpl
extends JrtFileSystem

Field Summary

Fields inherited from class com.intellij.openapi.vfs.jrt.JrtFileSystem

PROTOCOL, PROTOCOL_PREFIX, SEPARATOR

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

DEFAULT_LENGTH, DEFAULT_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
JrtFileSystemImpl()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	composeRootPath(java.lang.String localPath) A reverse to ArchiveFileSystem.extractLocalPath(String) - i.e.
protected java.lang.String	extractLocalPath(java.lang.String rootPath) Strips any separator chars from a root (obtained via VfsUtilCore.getRootFile(com.intellij.openapi.vfs.VirtualFile) path to obtain a path to a local 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	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).
protected ArchiveHandler	getHandler(VirtualFile entryFile)
java.lang.String	getProtocol() Gets the protocol for this file system.
protected boolean	isCorrectFileType(VirtualFile local) Implementations should return false if the given file may not host this file system.
java.lang.String []	list(VirtualFile file)
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	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.

Methods inherited from class com.intellij.openapi.vfs.jrt.JrtFileSystem

isModuleRoot, isRoot

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

contentsToByteArray, copyFile, createChildDirectory, createChildFile, deleteFile, exists, findLocalByRootPath, getInputStream, getLength, getLocalByEntry, getOutputStream, getRank, getRelativePath, getRootByEntry, getRootByLocal, getRootPathByLocal, getTimeStamp, isDirectory, isWritable, moveFile, renameFile, setTimeStamp, setWritable

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

addVirtualFileListener, getCanonicallyCasedName, hasChildren, isReadOnly, isSymLink, markNewFilesAsDirty, refreshWithoutFileWatcher, removeVirtualFileListener, resolveSymLink

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

extractPresentableUrl, isCaseSensitive, isValidName

Methods inherited from class java.lang.Object

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

Constructor Detail

JrtFileSystemImpl

public JrtFileSystemImpl()

Method Detail

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).

Overrides:

getAttributes in class ArchiveFileSystem

Parameters:

file - file to get attributes of.

Returns:

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

list

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

Specified by:

list in interface FileSystemInterface

Overrides:

list in class ArchiveFileSystem

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)

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.

extractLocalPath

protected java.lang.String extractLocalPath(java.lang.String rootPath)

Description copied from class: ArchiveFileSystem

Strips any separator chars from a root (obtained via VfsUtilCore.getRootFile(com.intellij.openapi.vfs.VirtualFile) path to obtain a path to a local file.

Specified by:

extractLocalPath in class ArchiveFileSystem

composeRootPath

protected java.lang.String composeRootPath(java.lang.String localPath)

Description copied from class: ArchiveFileSystem

A reverse to ArchiveFileSystem.extractLocalPath(String) - i.e. dresses a local file path to make it a suitable root path for this filesystem. E.g. "/x/y.jar" -> "/x/y.jar!/"

Specified by:

composeRootPath in class ArchiveFileSystem

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

getHandler

protected ArchiveHandler getHandler(VirtualFile entryFile)

Specified by:

getHandler in class ArchiveFileSystem

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

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)

isCorrectFileType

protected boolean isCorrectFileType(VirtualFile local)

Description copied from class: ArchiveFileSystem

Implementations should return false if the given file may not host this file system.

Overrides:

isCorrectFileType in class ArchiveFileSystem