Package com.intellij.openapi.vfs.newvfs

Class NewVirtualFileSystem

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

All Implemented Interfaces:

CachingVirtualFileSystem, FileSystemInterface

Direct Known Subclasses:

ArchiveFileSystem, LocalFileSystem

public abstract class NewVirtualFileSystem
extends VirtualFileSystem
implements FileSystemInterface, CachingVirtualFileSystem

Field Summary

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

DEFAULT_LENGTH, DEFAULT_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
NewVirtualFileSystem()

Method Summary

Modifier and Type	Method and Description
void	addVirtualFileListener(VirtualFileListener listener) Adds listener to the file system.
abstract VirtualFile	copyFile(java.lang.Object requestor, VirtualFile file, VirtualFile newParent, java.lang.String copyName) Implementation of copying files in this file system
abstract VirtualFile	createChildDirectory(java.lang.Object requestor, VirtualFile parent, java.lang.String dir) Implementation of adding directories in this file system
abstract VirtualFile	createChildFile(java.lang.Object requestor, VirtualFile parent, java.lang.String file) Implementation of adding files in this file system
abstract void	deleteFile(java.lang.Object requestor, VirtualFile file) Implementation of deleting files in this file system
protected abstract java.lang.String	extractRootPath(java.lang.String normalizedPath) IntelliJ platform calls this method with non-null value returned by 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.
abstract VirtualFile	findFileByPathIfCached(java.lang.String path)
abstract FileAttributes	getAttributes(VirtualFile file) Reads various file attributes in one shot (to reduce the number of native I/O calls).
java.lang.String	getCanonicallyCasedName(VirtualFile file)
abstract int	getRank()
boolean	hasChildren(VirtualFile file) Returns true if path represents a directory with at least one child.
boolean	isReadOnly()
boolean	isSymLink(VirtualFile file)
boolean	markNewFilesAsDirty()
abstract void	moveFile(java.lang.Object requestor, VirtualFile file, VirtualFile newParent) Implementation of moving files in this file system
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 extractRootPath(java.lang.String)).
void	refreshWithoutFileWatcher(boolean asynchronous)
void	removeVirtualFileListener(VirtualFileListener listener) Removes listener form the file system.
abstract void	renameFile(java.lang.Object requestor, VirtualFile file, java.lang.String newName) Implementation of renaming files in this file system
java.lang.String	resolveSymLink(VirtualFile file)

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

Constructor Detail

NewVirtualFileSystem

public NewVirtualFileSystem()

Method Detail

normalize

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 extractRootPath(java.lang.String)).

Implementations should not normalize paths by eliminating directory traversals or other indirections.

Returns:

a normalized path, or null when a path is invalid for this FS.

extractRootPath

protected abstract java.lang.String extractRootPath(java.lang.String normalizedPath)

IntelliJ platform calls this method with non-null value returned by 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.

findFileByPathIfCached

public abstract VirtualFile findFileByPathIfCached(java.lang.String path)

refreshWithoutFileWatcher

public void refreshWithoutFileWatcher(boolean asynchronous)

Specified by:

refreshWithoutFileWatcher in interface CachingVirtualFileSystem

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class VirtualFileSystem

isSymLink

public boolean isSymLink(VirtualFile file)

Specified by:

isSymLink in interface FileSystemInterface

resolveSymLink

public java.lang.String resolveSymLink(VirtualFile file)

Specified by:

resolveSymLink in interface FileSystemInterface

addVirtualFileListener

public void addVirtualFileListener(VirtualFileListener listener)

Description copied from class: VirtualFileSystem

Adds listener to the file system. Normally one should use VirtualFileManager.VFS_CHANGES message bus topic.

Specified by:

addVirtualFileListener in class VirtualFileSystem

Parameters:

listener - the listener

See Also:

VirtualFileListener, VirtualFileManager.VFS_CHANGES

removeVirtualFileListener

public void removeVirtualFileListener(VirtualFileListener listener)

Description copied from class: VirtualFileSystem

Removes listener form the file system.

Specified by:

removeVirtualFileListener in class VirtualFileSystem

Parameters:

listener - the listener

getRank

public abstract int getRank()

copyFile

public abstract VirtualFile copyFile(java.lang.Object requestor,
                                     VirtualFile file,
                                     VirtualFile newParent,
                                     java.lang.String copyName)
                              throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of copying files in this file system

Specified by:

copyFile in interface FileSystemInterface

Specified by:

copyFile in class VirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.copy(Object,VirtualFile,String)

createChildDirectory

public abstract VirtualFile createChildDirectory(java.lang.Object requestor,
                                                 VirtualFile parent,
                                                 java.lang.String dir)
                                          throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of adding directories in this file system

Specified by:

createChildDirectory in interface FileSystemInterface

Specified by:

createChildDirectory in class VirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildDirectory(Object,String)

createChildFile

public abstract VirtualFile createChildFile(java.lang.Object requestor,
                                            VirtualFile parent,
                                            java.lang.String file)
                                     throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of adding files in this file system

Specified by:

createChildFile in interface FileSystemInterface

Specified by:

createChildFile in class VirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildData(Object,String)

deleteFile

public abstract void deleteFile(java.lang.Object requestor,
                                VirtualFile file)
                         throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of deleting files in this file system

Specified by:

deleteFile in interface FileSystemInterface

Specified by:

deleteFile in class VirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.delete(Object)

moveFile

public abstract void moveFile(java.lang.Object requestor,
                              VirtualFile file,
                              VirtualFile newParent)
                       throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of moving files in this file system

Specified by:

moveFile in interface FileSystemInterface

Specified by:

moveFile in class VirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.move(Object,VirtualFile)

renameFile

public abstract void renameFile(java.lang.Object requestor,
                                VirtualFile file,
                                java.lang.String newName)
                         throws java.io.IOException

Description copied from class: VirtualFileSystem

Implementation of renaming files in this file system

Specified by:

renameFile in interface FileSystemInterface

Specified by:

renameFile in class VirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.rename(Object,String)

markNewFilesAsDirty

public boolean markNewFilesAsDirty()

getCanonicallyCasedName

public java.lang.String getCanonicallyCasedName(VirtualFile file)

getAttributes

public abstract FileAttributes getAttributes(VirtualFile file)

Reads various file attributes in one shot (to reduce the number of native I/O calls).

Parameters:

file - file to get attributes of.

Returns:

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

hasChildren

public boolean hasChildren(VirtualFile file)

Returns true if path represents a directory with at least one child. Override if your file system can answer this question more efficiently (e.g. without enumerating all children).