Package com.intellij.testFramework

Class LightVirtualFileBase

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.vfs.VirtualFile

com.intellij.testFramework.LightVirtualFileBase

All Implemented Interfaces:

ModificationTracker, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

BinaryLightVirtualFile, LightVirtualFile

public abstract class LightVirtualFileBase
extends VirtualFile

In-memory implementation of VirtualFile.

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
LightVirtualFileBase(java.lang.String name, FileType fileType, long modificationStamp)

Method Summary

Modifier and Type	Method and Description
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.
FileType	getAssignedFileType()
VirtualFile[]	getChildren() Gets the child files.
VirtualFileSystem	getFileSystem() Gets the VirtualFileSystem this file belongs to.
long	getLength() File length in bytes.
long	getModificationStamp() Gets modification stamp value.
java.lang.String	getName() Gets the name of this file.
VirtualFile	getOriginalFile()
VirtualFile	getParent() Gets the parent VirtualFile.
java.lang.String	getPath() Gets the path of this file.
long	getTimeStamp() Gets the timestamp for this file.
boolean	isDirectory() Checks whether this file is a directory.
boolean	isValid() Checks whether this VirtualFile is valid.
boolean	isWritable() Checks whether this file could be modified.
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.
void	rename(java.lang.Object requestor, java.lang.String newName) Renames this file to the newName.
void	setBinaryContent(byte [] content, long newModificationStamp, long newTimeStamp)
void	setBinaryContent(byte [] content, long newModificationStamp, long newTimeStamp, java.lang.Object requestor)
void	setFileType(FileType fileType)
protected void	setModificationStamp(long stamp)
void	setOriginalFile(VirtualFile originalFile)
void	setValid(boolean valid)
void	setWritable(boolean writable)

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

contentsToByteArray, contentsToByteArray, copy, exists, findChild, findFileByRelativePath, findOrCreateChildData, getBOM, getCanonicalFile, getCanonicalPath, getCharset, getDetectedLineSeparator, getExtension, getFileType, getInputStream, getModificationCount, getNameSequence, getNameWithoutExtension, getOutputStream, getOutputStream, getPresentableName, getPresentableUrl, getUrl, is, isCharsetSet, isInLocalFileSystem, isRecursiveOrCircularSymLink, isValidName, nameEquals, refresh, 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

LightVirtualFileBase

public LightVirtualFileBase(java.lang.String name,
                            FileType fileType,
                            long modificationStamp)

Method Detail

setFileType

public void setFileType(FileType fileType)

getOriginalFile

public VirtualFile getOriginalFile()

setOriginalFile

public void setOriginalFile(VirtualFile originalFile)

getFileSystem

public VirtualFileSystem getFileSystem()

Description copied from class: VirtualFile

Gets the VirtualFileSystem this file belongs to.

Specified by:

getFileSystem in class VirtualFile

Returns:

the VirtualFileSystem

getAssignedFileType

public FileType getAssignedFileType()

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

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

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

isDirectory

public boolean isDirectory()

Description copied from class: VirtualFile

Checks whether this file is a directory.

Specified by:

isDirectory in class VirtualFile

Returns:

true if this file is a directory, false otherwise

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

setValid

public void setValid(boolean valid)

getParent

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

getChildren

public VirtualFile[] getChildren()

Description copied from class: VirtualFile

Gets the child files.

Specified by:

getChildren in class VirtualFile

Returns:

array of the child files or null if this file is not a directory

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

protected void setModificationStamp(long stamp)

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

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.

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 void setWritable(boolean writable)

Overrides:

setWritable in class VirtualFile

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

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

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

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

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

setBinaryContent

public void setBinaryContent(byte [] content,
                             long newModificationStamp,
                             long newTimeStamp)
                      throws java.io.IOException

Overrides:

setBinaryContent in class VirtualFile

Throws:

java.io.IOException

setBinaryContent

public void setBinaryContent(byte [] content,
                             long newModificationStamp,
                             long newTimeStamp,
                             java.lang.Object requestor)
                      throws java.io.IOException

Overrides:

setBinaryContent in class VirtualFile

Throws:

java.io.IOException