Package com.intellij.openapi.vfs.newvfs

Class ArchiveFileSystem

java.lang.Object

com.intellij.openapi.vfs.VirtualFileSystem

com.intellij.openapi.vfs.newvfs.NewVirtualFileSystem

com.intellij.openapi.vfs.newvfs.ArchiveFileSystem

All Implemented Interfaces:

CachingVirtualFileSystem, FileSystemInterface

Direct Known Subclasses:

JarFileSystem, JrtFileSystem

public abstract class ArchiveFileSystem
extends NewVirtualFileSystem

Common interface of archive-based file systems (jar://, phar:// etc).

Field Summary

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

DEFAULT_LENGTH, DEFAULT_TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
ArchiveFileSystem()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	composeRootPath(java.lang.String localPath) A reverse to extractLocalPath(String) - i.e.
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 file)
protected abstract 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.
VirtualFile	findLocalByRootPath(java.lang.String rootPath) Returns a local file of an archive which hosts a root with the given path (i.e.: "jar:///path/to/jar.jar!/" => file:///path/to/jar.jar), or null if the local file is of incorrect type.
FileAttributes	getAttributes(VirtualFile file) Reads various file attributes in one shot (to reduce the number of native I/O calls).
protected abstract ArchiveHandler	getHandler(VirtualFile entryFile)
java.io.InputStream	getInputStream(VirtualFile file) Does NOT strip the BOM from the beginning of the stream, unlike the VirtualFile.getInputStream()
long	getLength(VirtualFile file)
VirtualFile	getLocalByEntry(VirtualFile entry) Returns a local file of an archive which hosts a given entry file (i.e.: jar:///path/to/jar.jar!/resource.xml => file:///path/to/jar.jar), or null if the file does not belong to this file system.
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)
int	getRank()
protected java.lang.String	getRelativePath(VirtualFile file)
VirtualFile	getRootByEntry(VirtualFile entry) Returns a root entry of an archive which hosts a given entry file (i.e.: jar:///path/to/jar.jar!/resource.xml => jar:///path/to/jar.jar!/), or null if the file does not belong to this file system.
VirtualFile	getRootByLocal(VirtualFile file) Returns a root entry of an archive hosted by a given local file (i.e.: file:///path/to/jar.jar => jar:///path/to/jar.jar!/), or null if the file does not host this file system.
java.lang.String	getRootPathByLocal(VirtualFile file)
long	getTimeStamp(VirtualFile file)
protected boolean	isCorrectFileType(VirtualFile local) Implementations should return false if the given file may not host this file system.
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
void	renameFile(java.lang.Object requestor, VirtualFile file, java.lang.String newName) Implementation of renaming files in this file system
void	setTimeStamp(VirtualFile file, long timeStamp)
void	setWritable(VirtualFile file, boolean writableFlag)

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

addVirtualFileListener, extractRootPath, findFileByPathIfCached, getCanonicallyCasedName, hasChildren, isReadOnly, isSymLink, markNewFilesAsDirty, normalize, refreshWithoutFileWatcher, removeVirtualFileListener, resolveSymLink

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

Constructor Detail

ArchiveFileSystem

public ArchiveFileSystem()

Method Detail

getRootByLocal

public VirtualFile getRootByLocal(VirtualFile file)

Returns a root entry of an archive hosted by a given local file (i.e.: file:///path/to/jar.jar => jar:///path/to/jar.jar!/), or null if the file does not host this file system.

getRootPathByLocal

public java.lang.String getRootPathByLocal(VirtualFile file)

getRootByEntry

public VirtualFile getRootByEntry(VirtualFile entry)

Returns a root entry of an archive which hosts a given entry file (i.e.: jar:///path/to/jar.jar!/resource.xml => jar:///path/to/jar.jar!/), or null if the file does not belong to this file system.

getLocalByEntry

public VirtualFile getLocalByEntry(VirtualFile entry)

Returns a local file of an archive which hosts a given entry file (i.e.: jar:///path/to/jar.jar!/resource.xml => file:///path/to/jar.jar), or null if the file does not belong to this file system.

extractLocalPath

protected abstract 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.

composeRootPath

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

A reverse to 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!/"

getHandler

protected abstract ArchiveHandler getHandler(VirtualFile entryFile)

getRank

public int getRank()

Specified by:

getRank in class NewVirtualFileSystem

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

Specified by:

copyFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.copy(Object,VirtualFile,String)

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

Specified by:

createChildDirectory in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildDirectory(Object,String)

createChildFile

public 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 NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.createChildData(Object,String)

deleteFile

public 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 NewVirtualFileSystem

Throws:

java.io.IOException

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

Specified by:

moveFile in class NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.move(Object,VirtualFile)

renameFile

public 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 NewVirtualFileSystem

Throws:

java.io.IOException

See Also:

VirtualFile.rename(Object,String)

getRelativePath

protected java.lang.String getRelativePath(VirtualFile file)

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

Specified by:

getAttributes in class NewVirtualFileSystem

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)

exists

public boolean exists(VirtualFile file)

isDirectory

public boolean isDirectory(VirtualFile file)

isWritable

public boolean isWritable(VirtualFile file)

getTimeStamp

public long getTimeStamp(VirtualFile file)

getLength

public long getLength(VirtualFile file)

contentsToByteArray

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

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

Throws:

java.io.IOException

setTimeStamp

public void setTimeStamp(VirtualFile file,
                         long timeStamp)
                  throws java.io.IOException

Throws:

java.io.IOException

setWritable

public void setWritable(VirtualFile file,
                        boolean writableFlag)
                 throws java.io.IOException

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)

Throws:

java.io.IOException

findLocalByRootPath

public VirtualFile findLocalByRootPath(java.lang.String rootPath)

Returns a local file of an archive which hosts a root with the given path (i.e.: "jar:///path/to/jar.jar!/" => file:///path/to/jar.jar), or null if the local file is of incorrect type.

isCorrectFileType

protected boolean isCorrectFileType(VirtualFile local)

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