FileTreeRepository
Related Doc:
package files
Add an observer of cache events.
Add an observer of cache events.
the observer to add
the handle to the observer.
Add an observer of events.
Add an observer of events.
the observer to add
the handle to the observer.
Catch any exceptions in subclasses.
Catch any exceptions in subclasses.
List all of the files for the path, returning only those files that are accepted by the
provided filter.
List all of the files for the path, returning only those files that are accepted by the
provided filter.
the root path to list
the maximum depth of subdirectories to query
include only paths accepted by the filter
a List of TypedPath instances accepted by the filter.
List all of the files for the path that are accepted by the filter.
List all of the files for the path that are accepted by the filter.
the path to list. If this is a file, returns a list containing the Entry for the file or an empty list if the file is not monitored by the path.
the maximum depth of subdirectories to return
include only paths accepted by this
a List of Entry instances accepted by the filter. The list will be empty if the path is not a subdirectory of this CachedDirectory or if it is a subdirectory, but the CachedDirectory was created without the recursive flag.
Register a path with the cache.
Register a path with the cache. A successful call to this method will both start monitoring of the path add will fill the cache for this path.
the directory to watch for file events and to add to the cache
the maximum maxDepth of subdirectories to watch
an com.swoval.functional.Either that will return a right value when no exception is thrown. The right value will be true if the path has not been previously registered. The com.swoval.functional.Either will be a left if any IOException is thrown attempting to register the path.
Remove an observer.
Unregister a path from the cache.
Unregister a path from the cache. This removes the path from monitoring and from the cache so long as the path isn't covered by another registered path. For example, if the path /foo was previously registered, after removal, no changes to /foo or files in /foo should be detected by the cache. Moreover, calling FileTreeRepository.list for /foo should return an empty list. If, however, we register both /foo recursively and /foo/bar (recursively or not), after unregistering /foo/bar, changes to /foo/bar should continue to be detected and /foo/bar should be included in the list returned by FileTreeRepository.list.
the path to unregister
Provides an in memory cache of portions of the file system. Directories are added to the cache using the FileTreeRepository.register method. Once a Path is added the cache, its contents may be retrieved using the FileTreeRepository.list method. The cache stores the path information in Entry instances.
A default implementation is provided by FileTreeRepositories.get. The user may cache arbitrary information in the cache by customizing the Converter that is passed into the factory FileTreeRepositories.get.
The cache allows the user to register a regular file, directory or symbolic link. After registration, the cache should monitor the path (and in the case of symbolic links, the target of the link) for updates. Whenever an update is detected, the cache updates its internal representation of the file system. When that is complete, it will notify all of the registered com.swoval.files.Observers of the change. In general, the update that is sent in the callback will be visible if the user lists the relevant path. It is however, possible that if the file is being updated rapidly that the internal state of the cache may change in between the callback being invoked and the user listing the path. Once the file system activity settles down, the cache should always end up in a consistent state where it mirrors the state of the file system.
The semantics of the list method are very similar to the linux
lstool. Listing a directory returns all of the subdirectories and files contained in the directory and the empty list if the directory is empty. Listing a file, however, will return the entry for the file if it exists and the empty list otherwise.the type of data stored in the Entry instances for the cache