Package com.intellij.openapi.vfs.impl.http

Class HttpFileSystemBase

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.DeprecatedVirtualFileSystem

com.intellij.openapi.vfs.ex.http.HttpFileSystem

com.intellij.openapi.vfs.impl.http.HttpFileSystemBase

Direct Known Subclasses:

HttpFileSystemImpl, HttpsFileSystem

public abstract class HttpFileSystemBase
extends HttpFileSystem

Constructor Summary

Constructors

Constructor and Description
HttpFileSystemBase(java.lang.String protocol)

Method Summary

Modifier and Type	Method and Description
void	addFileListener(HttpVirtualFileListener listener)
void	addFileListener(HttpVirtualFileListener listener, Disposable parentDisposable)
VirtualFile	createChild(VirtualFile parent, java.lang.String name, boolean isDirectory)
VirtualFile	createChildDirectory(java.lang.Object requestor, VirtualFile vDir, java.lang.String dirName) Implementation of adding directories in this file system
VirtualFile	createChildFile(java.lang.Object requestor, VirtualFile vDir, java.lang.String fileName) Implementation of adding files in this file system
java.lang.String	extractPresentableUrl(java.lang.String path) Fetches presentable URL of file with the given path in this file system.
VirtualFile	findFileByPath(java.lang.String path) Searches for the file specified by given path.
VirtualFile	findFileByPath(java.lang.String path, boolean isDirectory)
java.lang.String	getProtocol() Gets the protocol for this file system.
boolean	isFileDownloaded(VirtualFile file)
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.
void	removeFileListener(HttpVirtualFileListener listener)

Methods inherited from class com.intellij.openapi.vfs.ex.http.HttpFileSystem

getInstance

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

addVirtualFileListener, assertWriteAccessAllowed, copyFile, deleteFile, fireBeforeContentsChange, fireBeforeFileDeletion, fireBeforeFileMovement, fireBeforePropertyChange, fireContentsChanged, fireFileCopied, fireFileCreated, fireFileDeleted, fireFileMoved, firePropertyChanged, isReadOnly, moveFile, removeVirtualFileListener, renameFile, startEventPropagation

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

isCaseSensitive, isValidName

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpFileSystemBase

public HttpFileSystemBase(java.lang.String protocol)

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

findFileByPath

public VirtualFile findFileByPath(java.lang.String path,
                                  boolean isDirectory)

addFileListener

public void addFileListener(HttpVirtualFileListener listener)

Specified by:

addFileListener in class HttpFileSystem

addFileListener

public void addFileListener(HttpVirtualFileListener listener,
                            Disposable parentDisposable)

Specified by:

addFileListener in class HttpFileSystem

removeFileListener

public void removeFileListener(HttpVirtualFileListener listener)

Specified by:

removeFileListener in class HttpFileSystem

isFileDownloaded

public boolean isFileDownloaded(VirtualFile file)

Specified by:

isFileDownloaded in class HttpFileSystem

createChild

public VirtualFile createChild(VirtualFile parent,
                               java.lang.String name,
                               boolean isDirectory)

Specified by:

createChild in class HttpFileSystem

createChildDirectory

public VirtualFile createChildDirectory(java.lang.Object requestor,
                                        VirtualFile vDir,
                                        java.lang.String dirName)
                                 throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of adding directories in this file system

Overrides:

createChildDirectory in class DeprecatedVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildDirectory(Object,String)

createChildFile

public VirtualFile createChildFile(java.lang.Object requestor,
                                   VirtualFile vDir,
                                   java.lang.String fileName)
                            throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of adding files in this file system

Overrides:

createChildFile in class DeprecatedVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildData(Object,String)

extractPresentableUrl

public java.lang.String extractPresentableUrl(java.lang.String path)

Description copied from class: VirtualFileSystem

Fetches presentable URL of file with the given path in this file system.

Overrides:

extractPresentableUrl in class VirtualFileSystem

Parameters:

path - the path to get presentable URL for

Returns:

presentable URL

See Also:

VirtualFile.getPresentableUrl()

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)

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)