Package jetbrains.buildServer.configuration

Class FileWatcher

java.lang.Object

jetbrains.buildServer.configuration.ChangeObserver

jetbrains.buildServer.configuration.FileWatcher

All Implemented Interfaces:

ChangeProvider, Loggable

public class FileWatcher
extends ChangeObserver
implements ChangeProvider

Watches for changes in one file.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_CHECK_INTERVAL_MS

Constructor Summary

Constructors

Constructor	Description
FileWatcher(File file)
FileWatcher(File file, ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method	Description
boolean	changesDetected()	Returns true if changes in file detected
String	describe(boolean verbose)
File	getFile()
String	getRequestor()	Returns (short) string representation of this change source
void	resetChanged()	Call to reset changes status
String	toString()

Methods inherited from class jetbrains.buildServer.configuration.ChangeObserver

checkForModifications, clear, clearListeners, getSleepingPeriod, registerChangeProvider, registerListener, runActionWithDisabledObserver, setSkipListenersNotification, setSleepingPeriod, shutdownAll, start, stop, unregisterChangeProvider, unregisterListener

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHECK_INTERVAL_MS

public static final long DEFAULT_CHECK_INTERVAL_MS

See Also:

Constant Field Values

Constructor Detail

FileWatcher

public FileWatcher(@NotNull
                   File file)

Parameters:

file - file to watch changes in. May denote a directory as well, its lastModified attribute will be monitored for the change

FileWatcher

public FileWatcher(@NotNull
                   File file,
                   @NotNull
                   ScheduledExecutorService scheduler)

Parameters:

scheduler - executor that will be used to schedule watcher tasks

file - file to watch changes in. May denote a directory as well, its lastModified attribute will be monitored for the change

Method Detail

changesDetected

public boolean changesDetected()

Returns true if changes in file detected

Specified by:

changesDetected in interface ChangeProvider

Returns:

true if changes in file detected

See Also:

ChangeProvider.resetChanged()

resetChanged

public void resetChanged()

Call to reset changes status

Specified by:

resetChanged in interface ChangeProvider

getRequestor

public String getRequestor()

Description copied from interface: ChangeProvider

Returns (short) string representation of this change source

Specified by:

getRequestor in interface ChangeProvider

Returns:

(short) string representation of this change source

getFile

@NotNull
public File getFile()

Returns:

monitored file

toString

public String toString()

Overrides:

toString in class Object

describe

@NotNull
public String describe(boolean verbose)

Specified by:

describe in interface Loggable

Parameters:

verbose - verbosity of object description

Returns:

description of this object. If verbose is true, description should have mode details.