Package com.intellij.openapi.vfs.ex.temp

Class TempFileSystem

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

com.intellij.openapi.vfs.LocalFileSystem

com.intellij.openapi.vfs.impl.local.LocalFileSystemBase

com.intellij.openapi.vfs.ex.temp.TempFileSystem

All Implemented Interfaces:

CachingVirtualFileSystem, FileSystemInterface, VirtualFilePointerCapableFileSystem

public class TempFileSystem
extends LocalFileSystemBase
implements VirtualFilePointerCapableFileSystem

Nested Class Summary

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

LocalFileSystem.WatchRequest

Field Summary

Fields inherited from class com.intellij.openapi.vfs.impl.local.LocalFileSystemBase

LOG

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

PROTOCOL, PROTOCOL_PREFIX

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

DEFAULT_LENGTH, DEFAULT_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
TempFileSystem()

Method Summary

Modifier and Type	Method and Description
byte []	contentsToByteArray(VirtualFile file)
VirtualFile	copyFile(java.lang.Object requestor, VirtualFile file, VirtualFile newParent, java.lang.String copyName) Implementation of copying files in this file system
VirtualFile	createChildDirectory(java.lang.Object requestor, VirtualFile parent, java.lang.String dir) Implementation of adding directories in this file system
VirtualFile	createChildFile(java.lang.Object requestor, VirtualFile parent, java.lang.String file) Implementation of adding files in this file system
void	deleteFile(java.lang.Object requestor, VirtualFile file) Implementation of deleting files in this file system
boolean	exists(VirtualFile fileOrDirectory)
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	findModelChild(VirtualFile parent, java.lang.String name)
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)
java.io.InputStream	getInputStream(VirtualFile file) Does NOT strip the BOM from the beginning of the stream, unlike the VirtualFile.getInputStream()
static TempFileSystem	getInstance()
long	getLength(VirtualFile file)
java.io.OutputStream	getOutputStream(VirtualFile file, java.lang.Object requestor, long modStamp, long timeStamp) Does NOT add the BOM to the beginning of the stream, unlike the VirtualFile.getOutputStream(Object)
java.lang.String	getProtocol() Gets the protocol for this file system.
long	getTimeStamp(VirtualFile file)
boolean	isDirectory(VirtualFile file)
boolean	isWritable(VirtualFile file)
java.lang.String []	list(VirtualFile file)
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 NewVirtualFileSystem.extractRootPath(java.lang.String)).
void	renameFile(java.lang.Object requestor, VirtualFile file, java.lang.String newName) Implementation of renaming files in this file system
java.util.Set<LocalFileSystem.WatchRequest>	replaceWatchedRoots(java.util.Collection<LocalFileSystem.WatchRequest> watchRequests, java.util.Collection<java.lang.String> recursiveRoots, java.util.Collection<java.lang.String> flatRoots) Stops watching given watch requests and starts watching new paths.
void	setTimeStamp(VirtualFile file, long timeStamp)
void	setWritable(VirtualFile file, boolean writableFlag)

Methods inherited from class com.intellij.openapi.vfs.impl.local.LocalFileSystemBase

findFileByIoFile, findFileByPath, findFileByPathIfCached, getRank, hasChildren, isCaseSensitive, isReadOnly, isSymLink, isValidName, markNewFilesAsDirty, refresh, refreshAndFindFileByIoFile, refreshAndFindFileByPath, refreshFiles, refreshFiles, refreshIoFiles, refreshIoFiles, registerAuxiliaryFileOperationsHandler, resolveSymLink, unregisterAuxiliaryFileOperationsHandler

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

addRootsToWatch, addRootToWatch, removeWatchedRoot, removeWatchedRoots, replaceWatchedRoot

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

addVirtualFileListener, refreshWithoutFileWatcher, removeVirtualFileListener

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

extractPresentableUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFileSystem

public TempFileSystem()

Method Detail

getInstance

public static TempFileSystem getInstance()

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.

Overrides:

extractRootPath in class LocalFileSystemBase

createChildDirectory

public 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

Overrides:

createChildDirectory in class LocalFileSystemBase

Throws:

java.io.IOException

See Also:

VirtualFile.createChildDirectory(Object,String)

createChildFile

public VirtualFile createChildFile(java.lang.Object requestor,
                                   VirtualFile parent,
                                   java.lang.String file)

Description copied from class: VirtualFileSystem

Implementation of adding files in this file system

Specified by:

createChildFile in interface FileSystemInterface

Overrides:

createChildFile in class LocalFileSystemBase

See Also:

VirtualFile.createChildData(Object,String)

findModelChild

public VirtualFile findModelChild(VirtualFile parent,
                                  java.lang.String name)

copyFile

public 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

Overrides:

copyFile in class LocalFileSystemBase

Throws:

java.io.IOException

See Also:

VirtualFile.copy(Object,VirtualFile,String)

deleteFile

public void deleteFile(java.lang.Object requestor,
                       VirtualFile file)

Description copied from class: VirtualFileSystem

Implementation of deleting files in this file system

Specified by:

deleteFile in interface FileSystemInterface

Overrides:

deleteFile in class LocalFileSystemBase

See Also:

VirtualFile.delete(Object)

moveFile

public 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

Overrides:

moveFile in class LocalFileSystemBase

Throws:

java.io.IOException

See Also:

VirtualFile.move(Object,VirtualFile)

renameFile

public void renameFile(java.lang.Object requestor,
                       VirtualFile file,
                       java.lang.String newName)

Description copied from class: VirtualFileSystem

Implementation of renaming files in this file system

Specified by:

renameFile in interface FileSystemInterface

Overrides:

renameFile in class LocalFileSystemBase

See Also:

VirtualFile.rename(Object,String)

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.

Overrides:

getProtocol in class LocalFileSystemBase

Returns:

String representing the protocol

See Also:

VirtualFile.getUrl(), VirtualFileManager.getFileSystem(java.lang.String)

exists

public boolean exists(VirtualFile fileOrDirectory)

Specified by:

exists in interface FileSystemInterface

Overrides:

exists in class LocalFileSystemBase

list

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

Specified by:

list in interface FileSystemInterface

Overrides:

list in class LocalFileSystemBase

getCanonicallyCasedName

public java.lang.String getCanonicallyCasedName(VirtualFile file)

Overrides:

getCanonicallyCasedName in class LocalFileSystemBase

isDirectory

public boolean isDirectory(VirtualFile file)

Specified by:

isDirectory in interface FileSystemInterface

Overrides:

isDirectory in class LocalFileSystemBase

getTimeStamp

public long getTimeStamp(VirtualFile file)

Specified by:

getTimeStamp in interface FileSystemInterface

Overrides:

getTimeStamp in class LocalFileSystemBase

setTimeStamp

public void setTimeStamp(VirtualFile file,
                         long timeStamp)

Specified by:

setTimeStamp in interface FileSystemInterface

Overrides:

setTimeStamp in class LocalFileSystemBase

isWritable

public boolean isWritable(VirtualFile file)

Specified by:

isWritable in interface FileSystemInterface

Overrides:

isWritable in class LocalFileSystemBase

setWritable

public void setWritable(VirtualFile file,
                        boolean writableFlag)

Specified by:

setWritable in interface FileSystemInterface

Overrides:

setWritable in class LocalFileSystemBase

contentsToByteArray

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

Specified by:

contentsToByteArray in interface FileSystemInterface

Overrides:

contentsToByteArray in class LocalFileSystemBase

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream(VirtualFile file)
                                   throws java.io.IOException

Description copied from interface: FileSystemInterface

Does NOT strip the BOM from the beginning of the stream, unlike the VirtualFile.getInputStream()

Specified by:

getInputStream in interface FileSystemInterface

Overrides:

getInputStream in class LocalFileSystemBase

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream(VirtualFile file,
                                            java.lang.Object requestor,
                                            long modStamp,
                                            long timeStamp)
                                     throws java.io.IOException

Description copied from interface: FileSystemInterface

Does NOT add the BOM to the beginning of the stream, unlike the VirtualFile.getOutputStream(Object)

Specified by:

getOutputStream in interface FileSystemInterface

Overrides:

getOutputStream in class LocalFileSystemBase

Throws:

java.io.IOException

getLength

public long getLength(VirtualFile file)

Specified by:

getLength in interface FileSystemInterface

Overrides:

getLength in class LocalFileSystemBase

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 LocalFileSystemBase

Parameters:

file - file to get attributes of.

Returns:

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

replaceWatchedRoots

public java.util.Set<LocalFileSystem.WatchRequest> replaceWatchedRoots(java.util.Collection<LocalFileSystem.WatchRequest> watchRequests,
                                                                       java.util.Collection<java.lang.String> recursiveRoots,
                                                                       java.util.Collection<java.lang.String> flatRoots)

Description copied from class: LocalFileSystem

Stops watching given watch requests and starts watching new paths. May do nothing and return the same set of requests when it contains exactly the same paths.

Specified by:

replaceWatchedRoots in class LocalFileSystem

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 LocalFileSystemBase

Returns:

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