com.helger.commons.io.monitor

Class FileMonitor

java.lang.Object

com.helger.commons.io.monitor.FileMonitor

public class FileMonitor
extends Object

A polling file monitor implementation. Use FileMonitorManager.createFileMonitor(IFileMonitorCallback) to use this class effectively. All files that have the same callback ( IFileMonitorCallback) can be encapsulated in the same FileMonitor.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FileMonitor(IFileMonitorCallback aListener)

Method Summary

Modifier and Type	Method and Description
EChange	addMonitoredFile(File aFile) Adds a file to be monitored.
IFileMonitorCallback	getListener()
boolean	isRecursive() Access method to get the recursive setting when adding files for monitoring.
EChange	removeMonitoredFile(File aFile) Removes a file from being monitored.
FileMonitor	setRecursive(boolean bRecursive) Access method to set the recursive setting when adding files for monitoring.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMonitor

public FileMonitor(@Nonnull
                   IFileMonitorCallback aListener)

Method Detail

getListener

@Nonnull
public IFileMonitorCallback getListener()

Returns:

The listener as passed in the constructor. Never null.

isRecursive

public boolean isRecursive()

Access method to get the recursive setting when adding files for monitoring.

Returns:

true if monitoring is enabled for children.

setRecursive

@Nonnull
public FileMonitor setRecursive(boolean bRecursive)

Access method to set the recursive setting when adding files for monitoring.

Parameters:

bRecursive - true if monitoring should be enabled for children, false otherwise.

Returns:

this

addMonitoredFile

@Nonnull
public EChange addMonitoredFile(@Nonnull
                                          File aFile)

Adds a file to be monitored.

Parameters:

aFile - The File to monitor.

Returns:

EChange

removeMonitoredFile

@Nonnull
public EChange removeMonitoredFile(@Nonnull
                                             File aFile)

Removes a file from being monitored.

Parameters:

aFile - The File to remove from monitoring.

Returns:

EChange

toString

public String toString()

Overrides:

toString in class Object