Package com.intellij.openapi.fileChooser.tree

Class FileRefresher

java.lang.Object

com.intellij.openapi.fileChooser.tree.FileRefresher

All Implemented Interfaces:

Disposable

public class FileRefresher
extends java.lang.Object
implements Disposable

This class is intended to refresh virtual files periodically.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
FileRefresher(boolean recursive, long delay, NotNullProducer<? extends ModalityState> producer)

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
boolean	isRecursive()
void	pause() Pauses files refreshing.
void	register(VirtualFile file) Registers the specified file to watch and to refresh.
void	start() Starts files refreshing immediately.
protected void	unwatch(java.lang.Object watcher) Stops watching file, which was added before.
protected java.lang.Object	watch(VirtualFile file, boolean recursive) Starts watching the specified file, which was added before.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRefresher

public FileRefresher(boolean recursive,
                     long delay,
                     NotNullProducer<? extends ModalityState> producer)

Parameters:

recursive - true if files should be considered as roots

delay - an amount of seconds before refreshing files

producer - a provider for modality state that can be invoked on background thread

Throws:

java.lang.IllegalArgumentException - if the specified delay is not positive

Method Detail

isRecursive

public boolean isRecursive()

Returns:

true if files should be considered as roots

watch

protected java.lang.Object watch(VirtualFile file,
                                 boolean recursive)

Starts watching the specified file, which was added before.

Parameters:

file - a file to watch

recursive - true if a file should be considered as root

Returns:

an object that allows to stop watching the specified file

unwatch

protected void unwatch(java.lang.Object watcher)

Stops watching file, which was added before.

Parameters:

watcher - an object that allows to stop watching a file

register

public final void register(VirtualFile file)

Registers the specified file to watch and to refresh.

Parameters:

file - a file to watch and to refresh

pause

public final void pause()

Pauses files refreshing.

start

public final void start()

Starts files refreshing immediately. If files are refreshing now, it will be restarted when finished.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable