Class/Object

com.swoval.files

FileTreeRepositoryImpl

Related Docs: object FileTreeRepositoryImpl | package files

Permalink

class FileTreeRepositoryImpl[T <: AnyRef] extends FileTreeRepository[T]

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileTreeRepositoryImpl
  2. FileTreeRepository
  3. ObservableCache
  4. PathWatcher
  5. Observable
  6. FileTreeDataView
  7. FileTreeView
  8. AutoCloseable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileTreeRepositoryImpl(directoryTree: FileCacheDirectoryTree[T], watcher: FileCachePathWatcher[T])

    Permalink
  2. new FileTreeRepositoryImpl(directoryTree: FileCacheDirectoryTree[T], watcher: FileCachePathWatcher[T], logger: Logger)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addCacheObserver(observer: CacheObserver[T]): Int

    Permalink

    Add an observer of cache events.

    Add an observer of cache events.

    observer

    the observer to add

    returns

    the handle to the observer.

    Definition Classes
    FileTreeRepositoryImplObservableCache
  5. def addObserver(observer: Observer[_ >: Entry[T]]): Int

    Permalink

    Add an observer of events.

    Add an observer of events.

    observer

    the observer to add

    returns

    the handle to the observer.

    Definition Classes
    FileTreeRepositoryImplObservable
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def close(): Unit

    Permalink

    Cleans up the path watcher and clears the directory cache.

    Cleans up the path watcher and clears the directory cache.

    Definition Classes
    FileTreeRepositoryImplPathWatcher → AutoCloseable
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def list(path: Path, maxDepth: Int, filter: Filter[_ >: TypedPath]): List[TypedPath]

    Permalink

    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.

    path

    the root path to list

    maxDepth

    the maximum depth of subdirectories to query

    filter

    include only paths accepted by the filter

    returns

    a List of TypedPath instances accepted by the filter.

    Definition Classes
    FileTreeRepositoryImplFileTreeDataViewFileTreeView
  16. def listEntries(path: Path, maxDepth: Int, filter: Filter[_ >: Entry[T]]): List[Entry[T]]

    Permalink

    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.

    path

    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.

    maxDepth

    the maximum depth of subdirectories to return

    filter

    include only paths accepted by this

    returns

    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.

    Definition Classes
    FileTreeRepositoryImplFileTreeDataView
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. def register(path: Path, maxDepth: Int): Either[IOException, Boolean]

    Permalink

    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.

    path

    the directory to watch for file events and to add to the cache

    maxDepth

    the maximum maxDepth of subdirectories to watch

    returns

    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.

    Definition Classes
    FileTreeRepositoryImplFileTreeRepositoryPathWatcher
  21. def removeObserver(handle: Int): Unit

    Permalink

    Remove an observer.

    Remove an observer.

    handle

    the handle that was returned by addObserver

    Definition Classes
    FileTreeRepositoryImplObservable
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. def unregister(path: Path): Unit

    Permalink

    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.

    path

    the path to unregister

    Definition Classes
    FileTreeRepositoryImplFileTreeRepositoryPathWatcher
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from FileTreeRepository[T]

Inherited from ObservableCache[T]

Inherited from PathWatcher[Entry[T]]

Inherited from Observable[Entry[T]]

Inherited from FileTreeDataView[T]

Inherited from FileTreeView

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped