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

Class VirtualFileImpl

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

com.intellij.openapi.vfs.newvfs.impl.VirtualFileImpl

All Implemented Interfaces:

ModificationTracker, UserDataHolder, UserDataHolderEx, VirtualFileWithId

public class VirtualFileImpl
extends VirtualFileSystemEntry

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.newvfs.impl.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 boolean	changeUserMap(KeyFMap oldMap, KeyFMap newMap)
byte []	contentsToByteArray() Returns file content as an array of bytes.
byte []	contentsToByteArray(boolean cacheContent) Returns file content as an array of bytes.
NewVirtualFile	findChild(java.lang.String name) Finds child of this file with the given name.
NewVirtualFile	findChildIfCached(java.lang.String name)
java.util.Collection<VirtualFile>	getCachedChildren()
VirtualFile[]	getChildren() Gets the child files.
java.lang.String	getDetectedLineSeparator()
NewVirtualFileSystem	getFileSystem() Gets the VirtualFileSystem this file belongs to.
java.io.InputStream	getInputStream() Gets the InputStream for this file.
java.io.OutputStream	getOutputStream(java.lang.Object requestor, long modStamp, long timeStamp) Gets the OutputStream for this file and sets modification stamp and time stamp to the specified values after closing the stream.
protected KeyFMap	getUserMap()
boolean	isDirectory() Checks whether this file is a directory.
java.lang.Iterable<VirtualFile>	iterInDbChildren() iterated children will NOT contain NullVirtualFile.INSTANCE
NewVirtualFile	refreshAndFindChild(java.lang.String name)
void	setBinaryContent(byte [] content, long newModificationStamp, long newTimeStamp)
void	setBinaryContent(byte [] content, long newModificationStamp, long newTimeStamp, java.lang.Object requestor)
void	setDetectedLineSeparator(java.lang.String separator)
void	setPreloadedContentHint(byte[] preloadedContentHint)
protected void	setUserMap(KeyFMap map)

Methods inherited from class com.intellij.openapi.vfs.newvfs.impl.VirtualFileSystemEntry

appendPathOnFileSystem, copy, createChildData, createChildDirectory, delete, equals, exists, getCanonicalFile, getCanonicalPath, getCharset, getFileType, getId, getLength, getModificationStamp, getName, getNameId, getNameSequence, getParent, getPath, getPresentableName, getTimeStamp, getUrl, hashCode, invalidate, is, isDirty, isFileIndexed, isInLocalFileSystem, isRecursiveOrCircularSymLink, isValid, isWritable, markClean, markDirty, markDirtyRecursively, move, rename, setFileIndexed, setModificationStamp, setNewName, setParent, setTimeStamp, setWritable, toString, updateProperty

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

iterInDbChildrenWithoutLoadingVfsFromOtherProjects, refresh

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

findFileByRelativePath, findOrCreateChildData, getBOM, getExtension, getModificationCount, getNameWithoutExtension, getOutputStream, getPresentableUrl, isCharsetSet, isValidName, nameEquals, refresh, setBinaryContent, setBOM, setCharset, setCharset, setCharset, storeCharset

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

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

Methods inherited from class java.lang.Object

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

Method Detail

findChild

public NewVirtualFile findChild(java.lang.String name)

Description copied from class: VirtualFile

Finds child of this file with the given name.

Specified by:

findChild in class NewVirtualFile

Parameters:

name - the file name to search by

Returns:

the file if found any, null otherwise

getCachedChildren

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

Specified by:

getCachedChildren in class NewVirtualFile

iterInDbChildren

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

Description copied from class: NewVirtualFile

iterated children will NOT contain NullVirtualFile.INSTANCE

Specified by:

iterInDbChildren in class NewVirtualFile

getFileSystem

public NewVirtualFileSystem getFileSystem()

Description copied from class: VirtualFile

Gets the VirtualFileSystem this file belongs to.

Specified by:

getFileSystem in class NewVirtualFile

Returns:

the VirtualFileSystem

refreshAndFindChild

public NewVirtualFile refreshAndFindChild(java.lang.String name)

Specified by:

refreshAndFindChild in class NewVirtualFile

findChildIfCached

public NewVirtualFile findChildIfCached(java.lang.String name)

Specified by:

findChildIfCached in class NewVirtualFile

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

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

setPreloadedContentHint

public void setPreloadedContentHint(byte[] preloadedContentHint)

Overrides:

setPreloadedContentHint in class VirtualFile

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

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

Overrides:

contentsToByteArray in class NewVirtualFile

Returns:

file content

Throws:

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

See Also:

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

contentsToByteArray

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

Description copied from class: VirtualFile

Returns file content as an array of bytes.

Overrides:

contentsToByteArray in class VirtualFile

Parameters:

cacheContent - set true to

Returns:

file content

Throws:

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

See Also:

VirtualFile.contentsToByteArray()

getOutputStream

public java.io.OutputStream getOutputStream(java.lang.Object requestor,
                                            long modStamp,
                                            long timeStamp)
                                     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.

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

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

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

setBinaryContent

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

Overrides:

setBinaryContent in class VirtualFile

Throws:

java.io.IOException

getDetectedLineSeparator

public java.lang.String getDetectedLineSeparator()

Overrides:

getDetectedLineSeparator in class VirtualFile

Returns:

Line separator for this file. It is always null for directories and binaries, and possibly null if a separator isn't yet known.

See Also:

LineSeparator

setDetectedLineSeparator

public void setDetectedLineSeparator(java.lang.String separator)

Overrides:

setDetectedLineSeparator in class VirtualFile

setUserMap

protected void setUserMap(KeyFMap map)

Overrides:

setUserMap in class UserDataHolderBase

getUserMap

protected KeyFMap getUserMap()

Overrides:

getUserMap in class UserDataHolderBase

changeUserMap

protected boolean changeUserMap(KeyFMap oldMap,
                                KeyFMap newMap)

Overrides:

changeUserMap in class UserDataHolderBase