Package com.intellij.openapi.vfs.newvfs.impl

Class VirtualFileSystemEntry

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.vfs.VirtualFile

com.intellij.openapi.vfs.newvfs.NewVirtualFile

com.intellij.openapi.vfs.newvfs.impl.VirtualFileSystemEntry

All Implemented Interfaces:

ModificationTracker, UserDataHolder, UserDataHolderEx, VirtualFileWithId

Direct Known Subclasses:

VirtualDirectoryImpl, VirtualFileImpl

public abstract class VirtualFileSystemEntry
extends NewVirtualFile

Nested Class Summary

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

VirtualFile.PropName

Field Summary

Fields

Modifier and Type	Field and Description
static VirtualFileSystemEntry[]	EMPTY_ARRAY

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

PROP_ENCODING, PROP_HIDDEN, PROP_NAME, PROP_SYMLINK_TARGET, PROP_WRITABLE

Fields inherited from interface com.intellij.openapi.util.ModificationTracker

EVER_CHANGED, NEVER_CHANGED

Method Summary

Modifier and Type	Method and Description
protected char []	appendPathOnFileSystem(int accumulatedPathLength, int[] positionRef)
VirtualFile	copy(java.lang.Object requestor, VirtualFile newParent, java.lang.String copyName)
VirtualFile	createChildData(java.lang.Object requestor, java.lang.String name) Creates a new file in this directory.
VirtualFile	createChildDirectory(java.lang.Object requestor, java.lang.String name) Creates a subdirectory in this directory.
void	delete(java.lang.Object requestor) Deletes this file.
boolean	equals(java.lang.Object o)
boolean	exists()
NewVirtualFile	getCanonicalFile() Resolves all symbolic links containing in a path to this file and returns a link target.
java.lang.String	getCanonicalPath() Resolves all symbolic links containing in a path to this file and returns a path to a link target (in platform-independent format).
java.nio.charset.Charset	getCharset()
FileType	getFileType() Returns the FileType of this file, or FileTypes.UNKNOWN if a type cannot be determined (i.e.
int	getId()
long	getLength() File length in bytes.
long	getModificationStamp() Gets modification stamp value.
java.lang.String	getName() Gets the name of this file.
int	getNameId()
java.lang.CharSequence	getNameSequence()
VirtualDirectoryImpl	getParent() Gets the parent VirtualFile.
java.lang.String	getPath() Gets the path of this file.
java.lang.String	getPresentableName()
long	getTimeStamp() Gets the timestamp for this file.
java.lang.String	getUrl() Returns the URL of this file.
int	hashCode()
void	invalidate()
boolean	is(VFileProperty property) Checks whether this file has a specific property.
boolean	isDirty()
boolean	isFileIndexed()
boolean	isInLocalFileSystem()
boolean	isRecursiveOrCircularSymLink() Returns true if this file is a symlink that is either recursive (i.e.
boolean	isValid() Checks whether this VirtualFile is valid.
boolean	isWritable() Checks whether this file could be modified.
void	markClean()
void	markDirty()
void	markDirtyRecursively()
void	move(java.lang.Object requestor, VirtualFile newParent) Moves this file to another directory.
void	rename(java.lang.Object requestor, java.lang.String newName) Renames this file to the newName.
void	setFileIndexed(boolean indexed)
void	setModificationStamp(long modificationStamp)
void	setNewName(java.lang.String newName)
void	setParent(VirtualFile newParent)
void	setTimeStamp(long time)
void	setWritable(boolean writable)
java.lang.String	toString()
void	updateProperty(java.lang.String property, boolean value)

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

contentsToByteArray, findChild, findChildIfCached, getCachedChildren, getFileSystem, iterInDbChildren, iterInDbChildrenWithoutLoadingVfsFromOtherProjects, refresh, refreshAndFindChild

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

contentsToByteArray, findFileByRelativePath, findOrCreateChildData, getBOM, getChildren, getDetectedLineSeparator, getExtension, getInputStream, getModificationCount, getNameWithoutExtension, getOutputStream, getOutputStream, getPresentableUrl, isCharsetSet, isDirectory, isValidName, nameEquals, refresh, setBinaryContent, setBinaryContent, setBinaryContent, setBOM, setCharset, setCharset, setCharset, setDetectedLineSeparator, setPreloadedContentHint, storeCharset

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final VirtualFileSystemEntry[] EMPTY_ARRAY

Method Detail

getName

public java.lang.String getName()

Description copied from class: VirtualFile

Gets the name of this file.

Specified by:

getName in class VirtualFile

See Also:

VirtualFile.getNameSequence()

getNameSequence

public java.lang.CharSequence getNameSequence()

Specified by:

getNameSequence in class NewVirtualFile

getNameId

public final int getNameId()

getParent

public VirtualDirectoryImpl getParent()

Description copied from class: VirtualFile

Gets the parent VirtualFile.

Specified by:

getParent in class NewVirtualFile

Returns:

the parent file or null if this file is a root directory

isDirty

public boolean isDirty()

Specified by:

isDirty in class NewVirtualFile

getModificationStamp

public long getModificationStamp()

Description copied from class: VirtualFile

Gets modification stamp value. Modification stamp is a value changed by any modification of the content of the file. Note that it is not related to the file modification time.

Overrides:

getModificationStamp in class VirtualFile

Returns:

modification stamp

See Also:

VirtualFile.getTimeStamp()

setModificationStamp

public void setModificationStamp(long modificationStamp)

isFileIndexed

public boolean isFileIndexed()

setFileIndexed

public void setFileIndexed(boolean indexed)

markClean

public void markClean()

Specified by:

markClean in class NewVirtualFile

markDirty

public void markDirty()

Specified by:

markDirty in class NewVirtualFile

markDirtyRecursively

public void markDirtyRecursively()

Specified by:

markDirtyRecursively in class NewVirtualFile

appendPathOnFileSystem

protected char [] appendPathOnFileSystem(int accumulatedPathLength,
                                         int[] positionRef)

getUrl

public java.lang.String getUrl()

Description copied from class: VirtualFile

Returns the URL of this file. The URL is a string that uniquely identifies a file in all file systems. It has the following format: <protocol>://<path>.

File can be found by its URL using VirtualFileManager.findFileByUrl(java.lang.String) method.

Please note these URLs are intended for use withing VFS - meaning they are not necessarily RFC-compliant.

Overrides:

getUrl in class VirtualFile

Returns:

the URL consisting of protocol and path

See Also:

VirtualFileManager.findFileByUrl(java.lang.String), VirtualFile.getPath(), VirtualFileSystem.getProtocol()

getPath

public java.lang.String getPath()

Description copied from class: VirtualFile

Gets the path of this file. Path is a string that uniquely identifies a file within a given VirtualFileSystem. Format of the path depends on the concrete file system. For LocalFileSystem it is an absolute file path with file separator characters (File.separatorChar) replaced to the forward slash ('/').

Specified by:

getPath in class VirtualFile

Returns:

the path

delete

public void delete(java.lang.Object requestor)
            throws java.io.IOException

Description copied from class: VirtualFile

Deletes this file. This method should be only called within write-action. See Application.runWriteAction(java.lang.Runnable).

Overrides:

delete in class VirtualFile

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

Throws:

java.io.IOException - if file failed to be deleted

rename

public void rename(java.lang.Object requestor,
                   java.lang.String newName)
            throws java.io.IOException

Description copied from class: VirtualFile

Renames this file to the newName.

This method should only be called within write action.

Overrides:

rename in class VirtualFile

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

newName - the new file name

Throws:

java.io.IOException - if file failed to be renamed

createChildData

public VirtualFile createChildData(java.lang.Object requestor,
                                   java.lang.String name)
                            throws java.io.IOException

Description copied from class: VirtualFile

Creates a new file in this directory. This method should be only called within write-action. See Application.runWriteAction(java.lang.Runnable).

Overrides:

createChildData in class VirtualFile

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

Returns:

VirtualFile representing the created file

Throws:

java.io.IOException - if file failed to be created

isWritable

public boolean isWritable()

Description copied from class: VirtualFile

Checks whether this file could be modified. Note that this value may be cached and may differ from write permission of the physical file.

Specified by:

isWritable in class VirtualFile

Returns:

true if this file is writable, false otherwise

setWritable

public void setWritable(boolean writable)
                 throws java.io.IOException

Specified by:

setWritable in class NewVirtualFile

Throws:

java.io.IOException

getTimeStamp

public long getTimeStamp()

Description copied from class: VirtualFile

Gets the timestamp for this file. Note that this value may be cached and may differ from the timestamp of the physical file.

Specified by:

getTimeStamp in class VirtualFile

Returns:

timestamp

See Also:

File.lastModified()

setTimeStamp

public void setTimeStamp(long time)
                  throws java.io.IOException

Specified by:

setTimeStamp in class NewVirtualFile

Throws:

java.io.IOException

getLength

public long getLength()

Description copied from class: VirtualFile

File length in bytes.

Specified by:

getLength in class VirtualFile

Returns:

the length of this file.

copy

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

Overrides:

copy in class VirtualFile

Throws:

java.io.IOException

move

public void move(java.lang.Object requestor,
                 VirtualFile newParent)
          throws java.io.IOException

Description copied from class: VirtualFile

Moves this file to another directory. This method should be only called within write-action. See Application.runWriteAction(java.lang.Runnable).

Overrides:

move in class NewVirtualFile

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

newParent - the directory to move this file to

Throws:

java.io.IOException - if file failed to be moved

getId

public int getId()

Specified by:

getId in interface VirtualFileWithId

Specified by:

getId in class NewVirtualFile

Returns:

a unique number identifying the file in VFS. This id shouldn't change during the lifetime of the file. For "real" files (stored in and managed by VFS) it's a positive number.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

createChildDirectory

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

Description copied from class: VirtualFile

Creates a subdirectory in this directory. This method should be only called within write-action. See Application.runWriteAction(java.lang.Runnable).

Overrides:

createChildDirectory in class VirtualFile

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

name - directory name

Returns:

VirtualFile representing the created directory

Throws:

java.io.IOException - if directory failed to be created

exists

public boolean exists()

Overrides:

exists in class VirtualFile

isValid

public boolean isValid()

Description copied from class: VirtualFile

Checks whether this VirtualFile is valid. File can be invalidated either by deleting it or one of its parents with VirtualFile.delete(java.lang.Object) method or by an external change. If file is not valid only Object.equals(java.lang.Object), Object.hashCode(), VirtualFile.getName(), VirtualFile.getPath(), VirtualFile.getUrl(), VirtualFile.getPresentableUrl() and methods from UserDataHolder can be called for it. Using any other methods for an invalid VirtualFile instance produce unpredictable results.

Overrides:

isValid in class NewVirtualFile

Returns:

true if this is a valid file, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class VirtualFile

setNewName

public void setNewName(java.lang.String newName)

setParent

public void setParent(VirtualFile newParent)

isInLocalFileSystem

public boolean isInLocalFileSystem()

Overrides:

isInLocalFileSystem in class VirtualFile

invalidate

public void invalidate()

getCharset

public java.nio.charset.Charset getCharset()

Overrides:

getCharset in class VirtualFile

Returns:

Retrieve the charset file has been loaded with (if loaded) and would be saved with (if would).

getPresentableName

public java.lang.String getPresentableName()

Overrides:

getPresentableName in class VirtualFile

is

public boolean is(VFileProperty property)

Description copied from class: VirtualFile

Checks whether this file has a specific property.

Overrides:

is in class VirtualFile

Returns:

true if the file has a specific property, false otherwise

updateProperty

public void updateProperty(java.lang.String property,
                           boolean value)

getCanonicalPath

public java.lang.String getCanonicalPath()

Description copied from class: VirtualFile

Resolves all symbolic links containing in a path to this file and returns a path to a link target (in platform-independent format).

Note: please use this method judiciously. In most cases VFS clients don't need to resolve links in paths and should work with those provided by a user.

Overrides:

getCanonicalPath in class VirtualFile

Returns:

getPath() if there are no symbolic links in a file's path; getCanonicalFile().getPath() if the link was successfully resolved; null otherwise

getCanonicalFile

public NewVirtualFile getCanonicalFile()

Description copied from class: VirtualFile

Resolves all symbolic links containing in a path to this file and returns a link target.

Note: please use this method judiciously. In most cases VFS clients don't need to resolve links in paths and should work with those provided by a user.

Specified by:

getCanonicalFile in class NewVirtualFile

Returns:

this if there are no symbolic links in a file's path; instance of VirtualFile if the link was successfully resolved; null otherwise

isRecursiveOrCircularSymLink

public boolean isRecursiveOrCircularSymLink()

Description copied from class: VirtualFile

Returns true if this file is a symlink that is either recursive (i.e. points to this file' parent) or circular (i.e. its path has a form of "/.../linkX/.../linkX").

Overrides:

isRecursiveOrCircularSymLink in class VirtualFile

getFileType

public FileType getFileType()

Description copied from class: VirtualFile

Returns the FileType of this file, or FileTypes.UNKNOWN if a type cannot be determined (i.e. file type is not registered via FileTypeRegistry).

Performance notice: consider using FileTypeRegistry.isFileOfType(com.intellij.openapi.vfs.VirtualFile, com.intellij.openapi.fileTypes.FileType) or FileTypeRegistry.getFileTypeByFileName(java.lang.CharSequence) if this method is to be called for massive file collections, e.g. in BulkFileListener. See FileTypeRegistry javadoc for the details.

Overrides:

getFileType in class VirtualFile

See Also:

FileTypeRegistry