Package org.apache.commons.jci.listeners

Class AbstractFilesystemAlterationListener

java.lang.Object

org.apache.commons.jci.listeners.AbstractFilesystemAlterationListener

All Implemented Interfaces:

FilesystemAlterationListener

Direct Known Subclasses:

FileChangeListener, ReloadingListener

public abstract class AbstractFilesystemAlterationListener
extends java.lang.Object
implements FilesystemAlterationListener

AbstractFilesystemAlterationListener provides some convenience methods helping to implement a FilesystemAlterationListener.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AbstractFilesystemAlterationListener.Signal

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Collection<java.io.File>	changedDirectories
private java.util.Collection<java.io.File>	changedFiles
private AbstractFilesystemAlterationListener.Signal	checkSignal
private java.util.Collection<java.io.File>	createdDirectories
private java.util.Collection<java.io.File>	createdFiles
private java.util.Collection<java.io.File>	deletedDirectories
private java.util.Collection<java.io.File>	deletedFiles
private AbstractFilesystemAlterationListener.Signal	eventSignal
private org.apache.commons.logging.Log	log
protected FilesystemAlterationObserver	observer

Constructor Summary

Constructors

Constructor	Description
AbstractFilesystemAlterationListener()

Method Summary

Modifier and Type	Method	Description
java.util.Collection<java.io.File>	getChangedDirectories()
java.util.Collection<java.io.File>	getChangedFiles()
java.util.Collection<java.io.File>	getCreatedDirectories()
java.util.Collection<java.io.File>	getCreatedFiles()
java.util.Collection<java.io.File>	getDeletedDirectories()
java.util.Collection<java.io.File>	getDeletedFiles()
void	onDirectoryChange(java.io.File pDir)
void	onDirectoryCreate(java.io.File pDir)
void	onDirectoryDelete(java.io.File pDir)
void	onFileChange(java.io.File pFile)
void	onFileCreate(java.io.File pFile)
void	onFileDelete(java.io.File pFile)
void	onStart(FilesystemAlterationObserver pObserver)
void	onStop(FilesystemAlterationObserver pObserver)
protected void	signals()
void	waitForCheck()	wait for the next filesystem check to happen
void	waitForEvent()
void	waitForFirstCheck()	we don't reset the signal so if there was a check it is already true and exit immediatly otherwise it will behave just like waitForCheck()
private boolean	waitForSignal(AbstractFilesystemAlterationListener.Signal pSignal, int pSecondsTimeout)

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.apache.commons.logging.Log log

createdFiles

private final java.util.Collection<java.io.File> createdFiles

changedFiles

private final java.util.Collection<java.io.File> changedFiles

deletedFiles

private final java.util.Collection<java.io.File> deletedFiles

createdDirectories

private final java.util.Collection<java.io.File> createdDirectories

changedDirectories

private final java.util.Collection<java.io.File> changedDirectories

deletedDirectories

private final java.util.Collection<java.io.File> deletedDirectories

eventSignal

private final AbstractFilesystemAlterationListener.Signal eventSignal

checkSignal

private final AbstractFilesystemAlterationListener.Signal checkSignal

observer

protected FilesystemAlterationObserver observer

Constructor Detail

AbstractFilesystemAlterationListener

public AbstractFilesystemAlterationListener()

Method Detail

onDirectoryCreate

public void onDirectoryCreate(java.io.File pDir)

Specified by:

onDirectoryCreate in interface FilesystemAlterationListener

onDirectoryChange

public void onDirectoryChange(java.io.File pDir)

Specified by:

onDirectoryChange in interface FilesystemAlterationListener

onDirectoryDelete

public void onDirectoryDelete(java.io.File pDir)

Specified by:

onDirectoryDelete in interface FilesystemAlterationListener

onFileCreate

public void onFileCreate(java.io.File pFile)

Specified by:

onFileCreate in interface FilesystemAlterationListener

onFileChange

public void onFileChange(java.io.File pFile)

Specified by:

onFileChange in interface FilesystemAlterationListener

onFileDelete

public void onFileDelete(java.io.File pFile)

Specified by:

onFileDelete in interface FilesystemAlterationListener

getChangedDirectories

public java.util.Collection<java.io.File> getChangedDirectories()

getChangedFiles

public java.util.Collection<java.io.File> getChangedFiles()

getCreatedDirectories

public java.util.Collection<java.io.File> getCreatedDirectories()

getCreatedFiles

public java.util.Collection<java.io.File> getCreatedFiles()

getDeletedDirectories

public java.util.Collection<java.io.File> getDeletedDirectories()

getDeletedFiles

public java.util.Collection<java.io.File> getDeletedFiles()

signals

protected void signals()

onStart

public void onStart(FilesystemAlterationObserver pObserver)

Specified by:

onStart in interface FilesystemAlterationListener

onStop

public void onStop(FilesystemAlterationObserver pObserver)

Specified by:

onStop in interface FilesystemAlterationListener

waitForEvent

public void waitForEvent()
                  throws java.lang.Exception

Throws:

java.lang.Exception

waitForFirstCheck

public void waitForFirstCheck()
                       throws java.lang.Exception

we don't reset the signal so if there was a check it is already true and exit immediatly otherwise it will behave just like waitForCheck()

Throws:

java.lang.Exception - in case of a timeout

waitForCheck

public void waitForCheck()
                  throws java.lang.Exception

wait for the next filesystem check to happen

Throws:

java.lang.Exception - in case of a timeout

waitForSignal

private boolean waitForSignal(AbstractFilesystemAlterationListener.Signal pSignal,
                              int pSecondsTimeout)