com.helger.commons.io.monitor

Class FileMonitorManager

java.lang.Object

com.helger.commons.io.monitor.FileMonitorManager

All Implemented Interfaces:

Runnable

public class FileMonitorManager
extends Object
implements Runnable

This class manages all the available FileMonitor objects.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_DELAY
static int	DEFAULT_MAX_FILES

Constructor Summary

Constructors

Constructor and Description
FileMonitorManager()

Method Summary

Modifier and Type	Method and Description
void	addFileMonitor(FileMonitor aMonitor) Add a new FileMonitor.
FileMonitor	createFileMonitor(IFileMonitorCallback aListener) Create a new FileMonitor based on the passed file listener.
ICommonsList<FileMonitor>	getAllFileMonitors()
int	getChecksPerRun() get the number of files to check per run.
long	getDelay() Get the delay between runs.
int	getFileMonitorCount()
boolean	isRunning()
EChange	removeFileMonitor(FileMonitor aMonitor) Remove a FileMonitor.
void	run() Asks the agent for each file being monitored to check its file for changes.
FileMonitorManager	setChecksPerRun(int nChecksPerRun) set the number of files to check per run. a additional delay will be added if there are more files to check
FileMonitorManager	setDelay(long nDelay) Set the delay between runs.
void	start() Starts monitoring the files
void	stop() Stops monitoring the files.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELAY

public static final long DEFAULT_DELAY

See Also:

Constant Field Values

DEFAULT_MAX_FILES

public static final int DEFAULT_MAX_FILES

See Also:

Constant Field Values

Constructor Detail

FileMonitorManager

public FileMonitorManager()

Method Detail

getDelay

public long getDelay()

Get the delay between runs.

Returns:

The delay period in milliseconds.

setDelay

@Nonnull
public FileMonitorManager setDelay(long nDelay)

Set the delay between runs.

Parameters:

nDelay - The delay period in milliseconds.

Returns:

this

getChecksPerRun

public int getChecksPerRun()

get the number of files to check per run.

Returns:

The number of files to check per iteration.

setChecksPerRun

@Nonnull
public FileMonitorManager setChecksPerRun(int nChecksPerRun)

set the number of files to check per run. a additional delay will be added if there are more files to check

Parameters:

nChecksPerRun - a value less than 1 will disable this feature

Returns:

this

createFileMonitor

@Nonnull
public FileMonitor createFileMonitor(@Nonnull
                                               IFileMonitorCallback aListener)

Create a new FileMonitor based on the passed file listener.

Parameters:

aListener - The listener to be used. May not be null.

Returns:

The created FileMonitor that was already added.

See Also:

addFileMonitor(FileMonitor)

addFileMonitor

public void addFileMonitor(@Nonnull
                           FileMonitor aMonitor)

Add a new FileMonitor.

Parameters:

aMonitor - The monitor to be added. May not be null.

removeFileMonitor

@Nonnull
public EChange removeFileMonitor(@Nullable
                                           FileMonitor aMonitor)

Remove a FileMonitor.

Parameters:

aMonitor - The monitor to be remove. May be null.

Returns:

EChange

getAllFileMonitors

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<FileMonitor> getAllFileMonitors()

getFileMonitorCount

@Nonnegative
public int getFileMonitorCount()

Returns:

The number of contained FileMonitor objects. Always ≥ 0.

start

public void start()

Starts monitoring the files

Throws:

IllegalStateException - if the monitoring is already running

See Also:

isRunning(), stop()

stop

public void stop()

Stops monitoring the files.

isRunning

public boolean isRunning()

Returns:

true if the monitoring thread is running, false if not.

run

public void run()

Asks the agent for each file being monitored to check its file for changes.

Specified by:

run in interface Runnable