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

Class StubVirtualFile

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.vfs.VirtualFile

com.intellij.openapi.vfs.newvfs.impl.StubVirtualFile

All Implemented Interfaces:

ModificationTracker, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

FakeVirtualFile, NullVirtualFile

public class StubVirtualFile
extends 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
StubVirtualFile()

Method Summary

Modifier and Type	Method and Description
protected void	clearUserData()
byte []	contentsToByteArray() Returns file content as an array of bytes.
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.
VirtualFile[]	getChildren() Gets the child files.
VirtualFileSystem	getFileSystem() Gets the VirtualFileSystem this file belongs to.
java.io.InputStream	getInputStream() Gets the InputStream for this file.
long	getLength() File length in bytes.
java.lang.String	getName() Gets the name of this file.
java.io.OutputStream	getOutputStream(java.lang.Object requestor, long newModificationStamp, long newTimeStamp) Gets the OutputStream for this file and sets modification stamp and time stamp to the specified values after closing the stream.
VirtualFile	getParent() Gets the parent VirtualFile.
java.lang.String	getPath() Gets the path of this file.
long	getTimeStamp() Gets the timestamp for this file.
java.lang.String	getUrl() Returns the URL of 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.
<T> void	putCopyableUserData(Key<T> key, T value)
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
<T> T	putUserDataIfAbsent(Key<T> key, T value)
void	refresh(boolean asynchronous, boolean recursive) Refreshes the cached file information from the physical file system.
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.
<T> boolean	replace(Key<T> key, T oldValue, T newValue) Replaces (atomically) old value in the map with the new one
void	setBinaryContent(byte [] content, long newModificationStamp, long newTimeStamp)
void	setBinaryContent(byte [] content, long newModificationStamp, long newTimeStamp, java.lang.Object requestor)
void	setBOM(byte [] BOM)
void	setCharset(java.nio.charset.Charset charset)
void	setCharset(java.nio.charset.Charset charset, java.lang.Runnable whenChanged)
void	setCharset(java.nio.charset.Charset charset, java.lang.Runnable whenChanged, boolean fireEventsWhenChanged)
void	setDetectedLineSeparator(java.lang.String separator)
void	setPreloadedContentHint(byte[] preloadedContentHint)
protected void	setUserMap(KeyFMap map)
void	setWritable(boolean writable)
protected void	storeCharset(java.nio.charset.Charset charset)

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

contentsToByteArray, exists, findChild, findFileByRelativePath, findOrCreateChildData, getBOM, getCanonicalFile, getCanonicalPath, getCharset, getDetectedLineSeparator, getExtension, getFileType, getModificationCount, getModificationStamp, getNameSequence, getNameWithoutExtension, getOutputStream, getPresentableName, getPresentableUrl, is, isCharsetSet, isInLocalFileSystem, isRecursiveOrCircularSymLink, isValidName, nameEquals, rename, setBinaryContent, toString

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

changeUserMap, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

StubVirtualFile

public StubVirtualFile()

Method Detail

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

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

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

getInputStream

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

Description copied from class: VirtualFile

Gets the InputStream for this file. Skips BOM if there is any. See Unicode Byte Order Mark FAQ for an explanation.

Specified by:

getInputStream in class VirtualFile

Returns:

InputStream

Throws:

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

See Also:

VirtualFile.contentsToByteArray()

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.

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

getOutputStream

public java.io.OutputStream getOutputStream(java.lang.Object requestor,
                                            long newModificationStamp,
                                            long newTimeStamp)
                                     throws java.io.IOException

Description copied from class: VirtualFile

Gets the OutputStream for this file and sets modification stamp and time stamp to the specified values after closing the stream.

Normally, you should not use this method.

Writes BOM first, if there is any. See Unicode Byte Order Mark FAQ for an explanation.

Specified by:

getOutputStream 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() and SafeWriteRequestor.

newModificationStamp - new modification stamp or -1 if no special value should be set

newTimeStamp - new time stamp or -1 if no special value should be set

Returns:

OutputStream

Throws:

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

See Also:

VirtualFile.getModificationStamp()

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

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

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

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

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

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

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

createChildDirectory

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

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

createChildData

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

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

delete

public void delete(java.lang.Object requestor)

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

move

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

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

copy

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

Overrides:

copy in class VirtualFile

storeCharset

protected void storeCharset(java.nio.charset.Charset charset)

Overrides:

storeCharset in class VirtualFile

setCharset

public void setCharset(java.nio.charset.Charset charset)

Overrides:

setCharset in class VirtualFile

setCharset

public void setCharset(java.nio.charset.Charset charset,
                       java.lang.Runnable whenChanged)

Overrides:

setCharset in class VirtualFile

setCharset

public void setCharset(java.nio.charset.Charset charset,
                       java.lang.Runnable whenChanged,
                       boolean fireEventsWhenChanged)

Overrides:

setCharset in class VirtualFile

setBinaryContent

public void setBinaryContent(byte [] content,
                             long newModificationStamp,
                             long newTimeStamp)

Overrides:

setBinaryContent in class VirtualFile

setBinaryContent

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

Overrides:

setBinaryContent in class VirtualFile

refresh

public void refresh(boolean asynchronous,
                    boolean recursive)

Description copied from class: VirtualFile

Refreshes the cached file information from the physical file system. If this file is not a directory the timestamp value is refreshed and contentsChanged event is fired if it is changed.

If this file is a directory the set of its children is refreshed. If recursive value is true all children are refreshed recursively.

When invoking synchronous refresh from a thread other than the event dispatch thread, the current thread must NOT be in a read action, otherwise a deadlock may occur.

Overrides:

refresh in class VirtualFile

Parameters:

asynchronous - if true, the method will return immediately and the refresh will be processed in the background. If false, the method will return only after the refresh is done and the VFS change events caused by the refresh have been fired and processed in the event dispatch thread. Instead of synchronous refreshes, it's recommended to use asynchronous refreshes with a postRunnable whenever possible.

recursive - whether to refresh all the files in this directory recursively

setBOM

public void setBOM(byte [] BOM)

Overrides:

setBOM in class VirtualFile

setDetectedLineSeparator

public void setDetectedLineSeparator(java.lang.String separator)

Overrides:

setDetectedLineSeparator in class VirtualFile

setPreloadedContentHint

public void setPreloadedContentHint(byte[] preloadedContentHint)

Overrides:

setPreloadedContentHint in class VirtualFile

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

Overrides:

putUserData in class UserDataHolderBase

putCopyableUserData

public <T> void putCopyableUserData(Key<T> key,
                                    T value)

Overrides:

putCopyableUserData in class UserDataHolderBase

replace

public <T> boolean replace(Key<T> key,
                           T oldValue,
                           T newValue)

Description copied from interface: UserDataHolderEx

Replaces (atomically) old value in the map with the new one

Specified by:

replace in interface UserDataHolderEx

Overrides:

replace in class UserDataHolderBase

Returns:

true if old value got replaced, false otherwise

See Also:

ConcurrentMap.replace(Object, Object, Object)

putUserDataIfAbsent

public <T> T putUserDataIfAbsent(Key<T> key,
                                 T value)

Specified by:

putUserDataIfAbsent in interface UserDataHolderEx

Overrides:

putUserDataIfAbsent in class UserDataHolderBase

Returns:

written or already existing value

clearUserData

protected void clearUserData()

Overrides:

clearUserData in class UserDataHolderBase

setUserMap

protected void setUserMap(KeyFMap map)

Overrides:

setUserMap in class UserDataHolderBase