|
org.openide.filesystems 7.38.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.EventObject
org.openide.filesystems.FileEvent
public class FileEvent
Event for listening on filesystem changes.
By calling getFile()
the original file where the action occurred
can be obtained.
Field Summary |
---|
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
FileEvent(FileObject src)
Creates new FileEvent . |
|
FileEvent(FileObject src,
FileObject file)
Creates new FileEvent , specifying the action object. |
|
FileEvent(FileObject src,
FileObject file,
boolean expected)
Creates new FileEvent , specifying the action object. |
Method Summary | |
---|---|
boolean |
firedFrom(FileSystem.AtomicAction run)
Tests if FileEvent was fired from atomic action. |
FileObject |
getFile()
|
long |
getTime()
The time when this event has been created. |
boolean |
isExpected()
Getter to test whether the change has been expected or not. |
void |
runWhenDeliveryOver(Runnable r)
Support for batch processing of events. |
String |
toString()
|
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FileEvent(FileObject src)
FileEvent
. The FileObject
where the action occurred
is assumed to be the same as the source object.
src
- source file which sent this eventpublic FileEvent(FileObject src, FileObject file)
FileEvent
, specifying the action object.
Note that the two arguments of this method need not be identical in cases where it is reasonable that a different file object from the one affected would be listened to by other components. E.g., in the case of a file creation event, the event source (which listeners are attached to) would be the containing folder, while the action object would be the newly created file object.
src
- source file which sent this eventfile
- FileObject
where the action occurredpublic FileEvent(FileObject src, FileObject file, boolean expected)
FileEvent
, specifying the action object.
Note that the two arguments of this method need not be identical in cases where it is reasonable that a different file object from the one affected would be listened to by other components. E.g., in the case of a file creation event, the event source (which listeners are attached to) would be the containing folder, while the action object would be the newly created file object.
src
- source file which sent this eventfile
- FileObject
where the action occurredexpected
- sets flag whether the value was expectedMethod Detail |
---|
public final FileObject getFile()
public final long getTime()
public final boolean isExpected()
public final void runWhenDeliveryOver(Runnable r)
FileUtil.runAtomicAction(java.lang.Runnable)
action, there can be valid reason to do the processing only after
all of them are delivered. In such situation attach your Runnable
to provided event. Such Runnable
is then guaranteed to be called once.
Either immediately (if there is no batch delivery in progress)
or some time later (if there is a batch delivery). You can attach
single runnable multiple times, even to different events in the
same batch section and its Runnable.run()
method will still be
called just once. Object.equals(java.lang.Object)
is used
to check equality of two Runnable
s.
r
- the runnable to execute when batch event deliver is over
(can be even executed immediately)public String toString()
toString
in class EventObject
public boolean firedFrom(FileSystem.AtomicAction run)
run
- is tested atomic action.
|
org.openide.filesystems 7.38.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |