org.sadun.util.polling.pollmanagers
Class SuspendablePollManager

java.lang.Object
  org.sadun.util.polling.pollmanagers.SuspendablePollManager

All Implemented Interfaces:

PollManager

public class SuspendablePollManager

extends java.lang.Object

implements PollManager

This pollmanager adds suspension capabilities to another pollmanager.

Author:

Cristiano Sadun

Constructor Summary

SuspendablePollManager(PollManager pgmt)

SuspendablePollManager(PollManager pgmt, boolean processExceptionEvents)

Method Summary

void	cycleEnded(CycleEndEvent evt) Invoked when a polling cycle has ended (the pooler is going to sleep)
void	cycleStarted(CycleStartEvent evt) Invoked when a polling cycle start (the pooler has just awaken)
void	directoryLookupEnded(DirectoryLookupEndEvent evt) Invoked when the poller has finished looking into a directory
void	directoryLookupStarted(DirectoryLookupStartEvent evt) Invoked when the poller is starting to look into a directory
void	exceptionDeletingTargetFile(java.io.File target) Invoked when an automove operation fails since the given file cannot be deleted
void	exceptionMovingFile(java.io.File file, java.io.File dest) Invoked when an automove operation fails since the given file cannot be moved to the given destination
void	fileFound(FileFoundEvent evt) Invoked for each of the files found, if setSendSingleFileEvent() has been invoked before starting the poller thread.
void	fileMoved(FileMovedEvent evt) If the automove mode is active, is invoked for each automatic move operation executed by the poller.
void	fileSetFound(FileSetFoundEvent evt) Invoked when the poller has found a set of file matching the current criteria
boolean	isSuspended()
void	setSuspended(boolean suspended)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuspendablePollManager

public SuspendablePollManager(PollManager pgmt,
                              boolean processExceptionEvents)

SuspendablePollManager

public SuspendablePollManager(PollManager pgmt)

Method Detail

cycleStarted

public void cycleStarted(CycleStartEvent evt)

Description copied from interface: PollManager

Invoked when a polling cycle start (the pooler has just awaken)

Specified by:

cycleStarted in interface PollManager

Parameters:

evt - the cycle start event

cycleEnded

public void cycleEnded(CycleEndEvent evt)

Description copied from interface: PollManager

Invoked when a polling cycle has ended (the pooler is going to sleep)

Specified by:

cycleEnded in interface PollManager

Parameters:

evt - the cycle end event

directoryLookupStarted

public void directoryLookupStarted(DirectoryLookupStartEvent evt)

Description copied from interface: PollManager

Invoked when the poller is starting to look into a directory

Specified by:

directoryLookupStarted in interface PollManager

Parameters:

evt - the lookup start event

directoryLookupEnded

public void directoryLookupEnded(DirectoryLookupEndEvent evt)

Description copied from interface: PollManager

Invoked when the poller has finished looking into a directory

Specified by:

directoryLookupEnded in interface PollManager

Parameters:

evt - the lookup end event

fileFound

public void fileFound(FileFoundEvent evt)

Description copied from interface: PollManager

Invoked for each of the files found, if setSendSingleFileEvent() has been invoked before starting the poller thread.

Specified by:

fileFound in interface PollManager

Parameters:

evt - the file set found event

fileMoved

public void fileMoved(FileMovedEvent evt)

Description copied from interface: PollManager

If the automove mode is active, is invoked for each automatic move operation executed by the poller.

Specified by:

fileMoved in interface PollManager

fileSetFound

public void fileSetFound(FileSetFoundEvent evt)

Description copied from interface: PollManager

Invoked when the poller has found a set of file matching the current criteria

Specified by:

fileSetFound in interface PollManager

Parameters:

evt - the file set found event

exceptionMovingFile

public void exceptionMovingFile(java.io.File file,
                                java.io.File dest)

Description copied from interface: PollManager

Invoked when an automove operation fails since the given file cannot be moved to the given destination

Specified by:

exceptionMovingFile in interface PollManager

Parameters:

file - the file that caused the exception

dest - the expected destination

exceptionDeletingTargetFile

public void exceptionDeletingTargetFile(java.io.File target)

Description copied from interface: PollManager

Invoked when an automove operation fails since the given file cannot be deleted

Specified by:

exceptionDeletingTargetFile in interface PollManager

Parameters:

target - the file that caused the exception

isSuspended

public boolean isSuspended()

setSuspended

public void setSuspended(boolean suspended)