Package com.intellij.openapi.vfs.newvfs

Class NewVirtualFile

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.vfs.VirtualFile

com.intellij.openapi.vfs.newvfs.NewVirtualFile

All Implemented Interfaces:

ModificationTracker, UserDataHolder, UserDataHolderEx, VirtualFileWithId

Direct Known Subclasses:

VirtualFileSystemEntry

public abstract class NewVirtualFile
extends VirtualFile
implements VirtualFileWithId

Nested Class Summary

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

VirtualFile.PropName

Field Summary

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

EMPTY_ARRAY, PROP_ENCODING, PROP_HIDDEN, PROP_NAME, PROP_SYMLINK_TARGET, PROP_WRITABLE

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

EVER_CHANGED, NEVER_CHANGED

Constructor Summary

Constructors

Constructor and Description
NewVirtualFile()

Method Summary

Modifier and Type	Method and Description
byte []	contentsToByteArray() Returns file content as an array of bytes.
abstract NewVirtualFile	findChild(java.lang.String name) Finds child of this file with the given name.
abstract NewVirtualFile	findChildIfCached(java.lang.String name)
abstract java.util.Collection<VirtualFile>	getCachedChildren()
abstract NewVirtualFile	getCanonicalFile() Resolves all symbolic links containing in a path to this file and returns a link target.
abstract NewVirtualFileSystem	getFileSystem() Gets the VirtualFileSystem this file belongs to.
abstract int	getId()
abstract java.lang.CharSequence	getNameSequence()
abstract NewVirtualFile	getParent() Gets the parent VirtualFile.
abstract boolean	isDirty()
boolean	isValid() Checks whether this VirtualFile is valid.
abstract java.lang.Iterable<VirtualFile>	iterInDbChildren() iterated children will NOT contain NullVirtualFile.INSTANCE
java.lang.Iterable<VirtualFile>	iterInDbChildrenWithoutLoadingVfsFromOtherProjects()
abstract void	markClean()
abstract void	markDirty()
abstract void	markDirtyRecursively()
void	move(java.lang.Object requestor, VirtualFile newParent) Moves this file to another directory.
void	refresh(boolean asynchronous, boolean recursive, java.lang.Runnable postRunnable) The same as VirtualFile.refresh(boolean, boolean) but also runs postRunnable after the operation is completed.
abstract NewVirtualFile	refreshAndFindChild(java.lang.String name)
abstract void	setTimeStamp(long time)
abstract void	setWritable(boolean writable)

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

contentsToByteArray, copy, createChildData, createChildDirectory, delete, exists, findFileByRelativePath, findOrCreateChildData, getBOM, getCanonicalPath, getCharset, getChildren, getDetectedLineSeparator, getExtension, getFileType, getInputStream, getLength, getModificationCount, getModificationStamp, getName, getNameWithoutExtension, getOutputStream, getOutputStream, getPath, getPresentableName, getPresentableUrl, getTimeStamp, getUrl, is, isCharsetSet, isDirectory, isInLocalFileSystem, isRecursiveOrCircularSymLink, isValidName, isWritable, nameEquals, refresh, rename, setBinaryContent, setBinaryContent, setBinaryContent, setBOM, setCharset, setCharset, setCharset, setDetectedLineSeparator, setPreloadedContentHint, storeCharset, toString

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

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

Constructor Detail

NewVirtualFile

public NewVirtualFile()

Method Detail

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.

Specified by:

isValid in class VirtualFile

Returns:

true if this is a valid file, false otherwise

contentsToByteArray

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

Description copied from class: VirtualFile

Returns file content as an array of bytes. Has the same effect as contentsToByteArray(true).

Specified by:

contentsToByteArray in class VirtualFile

Returns:

file content

Throws:

java.io.IOException - if an I/O error occurs

See Also:

VirtualFile.contentsToByteArray(boolean), VirtualFile.getInputStream()

getFileSystem

public abstract NewVirtualFileSystem getFileSystem()

Description copied from class: VirtualFile

Gets the VirtualFileSystem this file belongs to.

Specified by:

getFileSystem in class VirtualFile

Returns:

the VirtualFileSystem

getParent

public abstract NewVirtualFile getParent()

Description copied from class: VirtualFile

Gets the parent VirtualFile.

Specified by:

getParent in class VirtualFile

Returns:

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

getCanonicalFile

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

Overrides:

getCanonicalFile in class VirtualFile

Returns:

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

findChild

public abstract NewVirtualFile findChild(java.lang.String name)

Description copied from class: VirtualFile

Finds child of this file with the given name.

Overrides:

findChild in class VirtualFile

Parameters:

name - the file name to search by

Returns:

the file if found any, null otherwise

refreshAndFindChild

public abstract NewVirtualFile refreshAndFindChild(java.lang.String name)

findChildIfCached

public abstract NewVirtualFile findChildIfCached(java.lang.String name)

setTimeStamp

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

Throws:

java.io.IOException

getNameSequence

public abstract java.lang.CharSequence getNameSequence()

Overrides:

getNameSequence in class VirtualFile

getId

public abstract int getId()

Specified by:

getId in interface VirtualFileWithId

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.

refresh

public void refresh(boolean asynchronous,
                    boolean recursive,
                    java.lang.Runnable postRunnable)

Description copied from class: VirtualFile

The same as VirtualFile.refresh(boolean, boolean) but also runs postRunnable after the operation is completed. The runnable is executed on event dispatch thread inside write action.

Specified by:

refresh in class VirtualFile

setWritable

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

Overrides:

setWritable in class VirtualFile

Throws:

java.io.IOException

markDirty

public abstract void markDirty()

markDirtyRecursively

public abstract void markDirtyRecursively()

isDirty

public abstract boolean isDirty()

markClean

public abstract void markClean()

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

newParent - the directory to move this file to

Throws:

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

getCachedChildren

public abstract java.util.Collection<VirtualFile> getCachedChildren()

iterInDbChildren

public abstract java.lang.Iterable<VirtualFile> iterInDbChildren()

iterated children will NOT contain NullVirtualFile.INSTANCE

iterInDbChildrenWithoutLoadingVfsFromOtherProjects

public java.lang.Iterable<VirtualFile> iterInDbChildrenWithoutLoadingVfsFromOtherProjects()