Package com.intellij.openapi.vfs.newvfs.events

Class VFileEvent

java.lang.Object

com.intellij.openapi.vfs.newvfs.events.VFileEvent

Direct Known Subclasses:

VFileContentChangeEvent, VFileCopyEvent, VFileCreateEvent, VFileDeleteEvent, VFileMoveEvent, VFilePropertyChangeEvent

public abstract class VFileEvent
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
VFileEvent(java.lang.Object requestor, boolean isFromRefresh)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	computePath()
abstract boolean	equals(java.lang.Object o)
abstract VirtualFile	getFile() Returns the VirtualFile which this event belongs to.
abstract VirtualFileSystem	getFileSystem()
java.lang.String	getPath() Returns the file path (in system independent format) affected by this event. Note that the path might be cached, thus can become out-of-date if requested later, asynchronously from the event dispatching procedure (e.g.
java.lang.Object	getRequestor()
abstract int	hashCode()
boolean	isFromRefresh()
boolean	isFromSave() Returns true if the VFS change described by the event is the save of a document.
abstract boolean	isValid()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VFileEvent

public VFileEvent(java.lang.Object requestor,
                  boolean isFromRefresh)

Method Detail

isFromRefresh

public boolean isFromRefresh()

isFromSave

public boolean isFromSave()

Returns true if the VFS change described by the event is the save of a document.

getRequestor

public java.lang.Object getRequestor()

getPath

public java.lang.String getPath()

Returns the file path (in system independent format) affected by this event.

Note that the path might be cached, thus can become out-of-date if requested later, asynchronously from the event dispatching procedure (e.g. event.getPath() can become not equal to event.getFile().getPath()).

computePath

protected abstract java.lang.String computePath()

getFile

public abstract VirtualFile getFile()

Returns the VirtualFile which this event belongs to. In some cases it may be null - it is not guaranteed that there is such file.

NB: Use this method with caution, because VFileCreateEvent.getFile() needs VirtualFile.findChild(String) which may be a performance leak.

getFileSystem

public abstract VirtualFileSystem getFileSystem()

isValid

public abstract boolean isValid()

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object