Package com.intellij.openapi.vfs.impl.jar

Class CoreJarVirtualFile

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.openapi.vfs.VirtualFile

com.intellij.openapi.vfs.impl.jar.CoreJarVirtualFile

All Implemented Interfaces:

ModificationTracker, UserDataHolder, UserDataHolderEx

public class CoreJarVirtualFile
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
CoreJarVirtualFile(CoreJarHandler handler, java.lang.CharSequence name, long length, long timestamp, CoreJarVirtualFile parent)

Method Summary

Modifier and Type	Method and Description
byte []	contentsToByteArray() Returns file content as an array of bytes.
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.
long	getModificationStamp() Gets modification stamp value.
java.lang.String	getName() Gets the name of this file.
java.lang.CharSequence	getNameSequence()
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.
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	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.

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

contentsToByteArray, copy, createChildData, createChildDirectory, delete, exists, findChild, findFileByRelativePath, findOrCreateChildData, getBOM, getCanonicalFile, getCanonicalPath, getCharset, getDetectedLineSeparator, getExtension, getFileType, getModificationCount, getNameWithoutExtension, getOutputStream, getPresentableName, getPresentableUrl, getUrl, is, isCharsetSet, isInLocalFileSystem, isRecursiveOrCircularSymLink, isValidName, move, nameEquals, refresh, rename, setBinaryContent, setBinaryContent, setBinaryContent, setBOM, setCharset, setCharset, setCharset, setDetectedLineSeparator, setPreloadedContentHint, setWritable, 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

CoreJarVirtualFile

public CoreJarVirtualFile(CoreJarHandler handler,
                          java.lang.CharSequence name,
                          long length,
                          long timestamp,
                          CoreJarVirtualFile parent)

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

Overrides:

getNameSequence in class VirtualFile

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

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

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

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

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

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

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

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

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