com.helger.commons.scopes.io

Class ScopedFileMonitorManager

java.lang.Object

com.helger.commons.scopes.AbstractSingleton

com.helger.commons.scopes.singleton.GlobalSingleton

com.helger.commons.scopes.io.ScopedFileMonitorManager

All Implemented Interfaces:

IScopeDestructionAware

public class ScopedFileMonitorManager
extends GlobalSingleton

A global scoped singleton encapsulating a FileMonitorManager

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ScopedFileMonitorManager() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addFileMonitor(FileMonitor aMonitor) Add a new FileMonitor.
FileMonitor	createFileMonitor(IFileListener aListener) Create a new FileMonitor based on the passed file listener.
int	getChecksPerRun() get the number of files to check per run.
long	getDelay() Get the delay between runs.
static ScopedFileMonitorManager	getInstance()
boolean	isRunning()
protected void	onDestroy(IScope aScopeInDestruction) Called when this singleton is destroyed.
EChange	removeFileMonitor(FileMonitor aMonitor) Remove a FileMonitor.
void	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
void	setDelay(long nDelay) Set the delay between runs.
EChange	start() Starts monitoring the files
EChange	stop() Stops monitoring the files.

Methods inherited from class com.helger.commons.scopes.singleton.GlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.helger.commons.scopes.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopedFileMonitorManager

@Deprecated
 @UsedViaReflection
public ScopedFileMonitorManager()

Deprecated.

Method Detail

getInstance

@Nonnull
public static ScopedFileMonitorManager getInstance()

onDestroy

protected void onDestroy(@Nonnull
                         IScope aScopeInDestruction)

Description copied from class: AbstractSingleton

Called when this singleton is destroyed. Perform all cleanup in this method. This method is called when "inDestruction" is true and "isDestroyed" is false.

Overrides:

onDestroy in class AbstractSingleton

Parameters:

aScopeInDestruction - The scope in destruction. Never null.

start

@Nonnull
public EChange start()

Starts monitoring the files

Returns:

EChange

Throws:

IllegalStateException - if the monitoring is already running

See Also:

isRunning(), stop()

stop

@Nonnull
public EChange stop()

Stops monitoring the files.

Returns:

EChange

isRunning

public boolean isRunning()

Returns:

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

getDelay

public long getDelay()

Get the delay between runs.

Returns:

The delay period in milliseconds.

setDelay

public void setDelay(long nDelay)

Set the delay between runs.

Parameters:

nDelay - The delay period in milliseconds.

getChecksPerRun

public int getChecksPerRun()

get the number of files to check per run.

Returns:

The number of files to check per iteration.

setChecksPerRun

public void 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

createFileMonitor

@Nonnull
public FileMonitor createFileMonitor(@Nonnull
                                               IFileListener 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