Package com.swoval.files

Provides classes for monitoring directories for file system updates.

See: Description

Interface Summary

Interface	Description
DirectoryDataView<T>
DirectoryView	A repository for a directory.
FileTreeDataView<T>	A repository for which each Path has an associated data value.
FileTreeDataViews.CacheObserver<T>	Provides callbacks to run when different types of file events are detected by the cache.
FileTreeDataViews.Converter<R>	Converts a Path into an arbitrary value to be cached.
FileTreeDataViews.Entry<T>	Container class for CachedDirectoryImpl entries.
FileTreeDataViews.ObservableCache<T>	A file tree cache that can be monitored for events.
FileTreeRepository<T>	Provides an in memory cache of portions of the file system.
FileTreeView
FileTreeViews.Observable<T>
FileTreeViews.Observer<T>	Generic Observer for an FileTreeViews.Observable.
PathWatcher<T>	Watches directories for file changes.
RegisterableWatchService	Augments the java.nio.file.WatchService with a RegisterableWatchService.register(java.nio.file.Path, java.nio.file.WatchEvent.Kind<?>...) method.
TypedPath	A mix-in for an object that represents a file system path.

Class Summary

Class	Description
FileTreeDataViews	Provides functional interfaces for processing and managing instances of FileTreeDataView.
FileTreeRepositories	Provides factory methods for generating instances of FileTreeRepository.
FileTreeViews	Provides static methods returning instances of the various view interfaces defined throughout this package.
PathWatchers	Provides factory methods to create instances of PathWatcher.
PathWatchers.Event	Container for PathWatcher events.
PathWatchers.Event.Kind	An enum like class to indicate the type of file event.
RegisterableWatchServices	Provides a platform dependent implementation of RegisterableWatchService.
TypedPaths	Provides a default TypedPath implementation.

Package com.swoval.files Description

Provides classes for monitoring directories for file system updates. The PathWatcher provides a raw api to monitor directories for file events. The FileTreeRepository generates an in memory cache of a set of directories that can be listed. The cache can store arbitrary user data that is returned to the user whenever the cache is listed or fires a callback (see FileTreeDataViews.CacheObserver).

The implementation of all of the classes in this package uses only apis and code constructs that can be translated by scalagen. This can cause some of the code to look a bit awkward or not be quite idiomatic java.