ch.sourcepond.io.fileobserver.impl.directory

Class SubDirectory

java.lang.Object

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

ch.sourcepond.io.fileobserver.impl.directory.SubDirectory

public class SubDirectory
extends Directory

Method Summary

Modifier and Type	Method and Description
void	addWatchedDirectory(ch.sourcepond.io.fileobserver.spi.WatchedDirectory pDirectoryKey) Adds the watched-directory specified to this directory instance.
Directory	getParent()
boolean	hasKeys()
boolean	isRoot()
Directory	rebase(Directory pBaseDirectory)
boolean	remove(ch.sourcepond.io.fileobserver.spi.WatchedDirectory pDirectoryKey) INTERNAL API, only ot be used in class hierarchy
Directory	toRootDirectory()

Methods inherited from class ch.sourcepond.io.fileobserver.impl.directory.Directory

cancelKey, forceInform, getPath, getResource, informCreatedOrInitial, informDiscard, informIfChanged, informIfChanged, isDirectParentOf, removeWatchedDirectory

Methods inherited from class java.lang.Object

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

Method Detail

addWatchedDirectory

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

Description copied from class: Directory

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.

Specified by:

addWatchedDirectory in class Directory

Parameters:

pDirectoryKey - Directory key, must not be null

remove

public boolean remove(ch.sourcepond.io.fileobserver.spi.WatchedDirectory pDirectoryKey)

Description copied from class: Directory

INTERNAL API, only ot be used in class hierarchy

Removes the directory-key specified from this directory instance. If no such key is registered nothing happens.

Parameters:

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

Returns:

true if the directory-key specified was removed, false otherwise.

isRoot

public boolean isRoot()

Specified by:

isRoot in class Directory

hasKeys

public boolean hasKeys()

Specified by:

hasKeys in class Directory

rebase

public Directory rebase(Directory pBaseDirectory)

Specified by:

rebase in class Directory

toRootDirectory

public Directory toRootDirectory()

Specified by:

toRootDirectory in class Directory

getParent

public Directory getParent()