sbt.io

FileTreeDataView

trait FileTreeDataView[+T] extends FileTreeView with AutoCloseable

Provides a view into the file system that allows retrieval of the children of a particular path where each child has an associated FileTreeDataView.Entry that is generally derived from the file (e.g. the FileTreeDataView.Entry.value may be the md5 hash of the underlying file). Specific implementations may or may not use a cache for retrieval. It extends FileTreeView since FileTreeView.list can be trivially implemented using listEntries.

Linear Supertypes
FileTreeView, AutoCloseable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FileTreeDataView
  2. FileTreeView
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit

    Definition Classes
    AutoCloseable
    Annotations
    @throws( classOf[java.lang.Exception] )
  2. abstract def list(path: Path, maxDepth: Int, filter: (TypedPath) ⇒ Boolean): Seq[TypedPath]

    List the contents of the current directory.

    List the contents of the current directory.

    path

    the path to list

    maxDepth

    controls the depth of children of the path to include in the results. When maxDepth is -1, list should only return the TypedPath for this directory. For non-negative values, list should return only entries whose relativized path has

    maxDepth - 1

    the children of the path should be included in the result, but none of the children of any of the subdirectories should be included.

    filter

    only return files accepted by the filter

    returns

    a sequence of TypedPaths.

    Definition Classes
    FileTreeView
  3. abstract def listEntries(path: Path, maxDepth: Int, filter: (Entry[T]) ⇒ Boolean): Seq[Entry[T]]

    List the contents of the current directory where each returned FileTreeDataView.Entry has a data value associated with it.

    List the contents of the current directory where each returned FileTreeDataView.Entry has a data value associated with it.

    path

    the path to list

    maxDepth

    controls the depth of children of the path to include in the results. When maxDepth is -1, listEntries should only return the TypedPath for this directory. For non-negative values, listEntries should return only entries whose relativized path has

    maxDepth - 1

    when maxDepth is zero, all of the children of the path should be included in the result, but none of the children of any of the subdirectories should be included.

    filter

    only return files accepted by the filter

    returns

    a sequence of FileTreeDataView.Entry instances.

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from FileTreeView

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped