ch.sourcepond.io.fileobserver.impl.directory

Class Directory

java.lang.Object

ch.sourcepond.io.fileobserver.impl.directory.Directory

Direct Known Subclasses:

RootDirectory, SubDirectory

public abstract class Directory
extends Object

A directory has to fulfill two purposes. If firstly holds the WatchKey of watched directory. Secondly, it stores the checksums of changed files.

Method Summary

Modifier and Type	Method and Description
abstract void	addWatchedDirectory(ch.sourcepond.io.fileobserver.spi.WatchedDirectory pDirectoryKey) Adds the watched-directory specified to this directory instance.
void	cancelKey() Cancels the WatchKey held by this directory object (see WatchKey.cancel()).
void	forceInform(EventDispatcher pDispatcher) Iterates over the files contained by this directory and creates tasks which will be executed sometime in the future.
Path	getPath() Returns the path represented by this directory object.
ch.sourcepond.io.checksum.api.Resource	getResource(Path pFile)
abstract boolean	hasKeys()
void	informCreatedOrInitial(EventDispatcher pDispatcher, Directory pNewRootOrNull, Path pFile, Runnable pDoneCallback)
void	informDiscard(EventDispatcher pDispatcher, Path pFile, Runnable pDoneCallback) Iterates over the listeners specified and informs them that the file specified has been discarded through their PathChangeListener.discard(DispatchKey) method.
void	informIfChanged(EventDispatcher pDispatcher, Directory pNewRootOrNull, Path pFile, Runnable pDoneCallback, boolean pIsCreated) Triggers the PathChangeListener.modified(PathChangeEvent) on all listeners specified if the file represented by the path specified has been changed i.e.
void	informIfChanged(EventDispatcher pDispatcher, Path pFile, Runnable pDoneCallback, boolean pIsCreated) Triggers the PathChangeListener.modified(PathChangeEvent) on all listeners specified if the file represented by the path specified has been changed i.e.
boolean	isDirectParentOf(Directory pOther) Checks whether this directory is the directory parent of the directory specified.
abstract boolean	isRoot()
abstract Directory	rebase(Directory pBaseDirectory)
void	removeWatchedDirectory(EventDispatcher pDispatcher, ch.sourcepond.io.fileobserver.spi.WatchedDirectory pWatchedDirectory) Removes the watched-directory specified from this directory instance and informs the listeners specified through their PathChangeListener.discard(DispatchKey).
abstract Directory	toRootDirectory()

Methods inherited from class java.lang.Object

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

Method Detail

isRoot

public abstract boolean isRoot()

hasKeys

public abstract boolean hasKeys()

addWatchedDirectory

public abstract void addWatchedDirectory(ch.sourcepond.io.fileobserver.spi.WatchedDirectory pDirectoryKey)

Adds the watched-directory specified to this directory instance. When a change is detected, a DispatchKey will be generated for every WatchedDirectory.getKey()/relative-path combination. This DispatchKey instance will then be delivered (along with the readable file path) to the PathChangeListener objects which should be informed.

Note: The object returned by WatchedDirectory.getKey() should be immutable, String or an Enum objects are good condidates for being directory-keys.

Parameters:

pDirectoryKey - Directory key, must not be null

removeWatchedDirectory

public void removeWatchedDirectory(EventDispatcher pDispatcher,
                                   ch.sourcepond.io.fileobserver.spi.WatchedDirectory pWatchedDirectory)

Removes the watched-directory specified from this directory instance and informs the listeners specified through their PathChangeListener.discard(DispatchKey). If no such watched-directory is registered nothing happens.

Parameters:

pWatchedDirectory - Directory-key to be removed, must be not null

cancelKey

public void cancelKey()

Cancels the WatchKey held by this directory object (see WatchKey.cancel()). After this, checksum resources are cleared and no more events for this directory can be retrieved.

forceInform

public void forceInform(EventDispatcher pDispatcher)

Iterates over the files contained by this directory and creates tasks which will be executed sometime in the future. Such a task will inform the listener specified through its PathChangeListener.modified(PathChangeEvent) method. Note: only direct children will be considered, sub-directories and non-regular files will be ignored.

getPath

public Path getPath()

Returns the path represented by this directory object.

Returns:

Path of this directory, never null.

informDiscard

public void informDiscard(EventDispatcher pDispatcher,
                          Path pFile,
                          Runnable pDoneCallback)

Iterates over the listeners specified and informs them that the file specified has been discarded through their PathChangeListener.discard(DispatchKey) method. The listeners will be called asynchronously sometime in the future.

Parameters:

pFile - Discarded file, must be null

isDirectParentOf

public boolean isDirectParentOf(Directory pOther)

Checks whether this directory is the directory parent of the directory specified.

Parameters:

pOther - Other directory, must not be null

Returns:

true if this object is the direct parent of the directory specified, false otherwise

getResource

public ch.sourcepond.io.checksum.api.Resource getResource(Path pFile)

informCreatedOrInitial

public void informCreatedOrInitial(EventDispatcher pDispatcher,
                                   Directory pNewRootOrNull,
                                   Path pFile,
                                   Runnable pDoneCallback)

informIfChanged

public void informIfChanged(EventDispatcher pDispatcher,
                            Directory pNewRootOrNull,
                            Path pFile,
                            Runnable pDoneCallback,
                            boolean pIsCreated)

Triggers the PathChangeListener.modified(PathChangeEvent) on all listeners specified if the file represented by the path specified has been changed i.e. has a new checksum. If no checksum change has been detected, nothing happens.

Parameters:

pFile - File which potentially has changed, must not be null

informIfChanged

public void informIfChanged(EventDispatcher pDispatcher,
                            Path pFile,
                            Runnable pDoneCallback,
                            boolean pIsCreated)

Triggers the PathChangeListener.modified(PathChangeEvent) on all listeners specified if the file represented by the path specified has been changed i.e. has a new checksum. If no checksum change has been detected, nothing happens.

Parameters:

pFile - File which potentially has changed, must not be null

rebase

public abstract Directory rebase(Directory pBaseDirectory)

toRootDirectory

public abstract Directory toRootDirectory()