o

sbt.io

Path

object Path extends Mapper

Linear Supertypes
Mapper, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Path
  2. Mapper
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type FileMap = (File) ⇒ Option[File]
    Definition Classes
    Mapper
  2. type PathMap = (File) ⇒ Option[String]
    Definition Classes
    Mapper

Value Members

  1. def abs: FileMap

    Pairs a File with the absolute File obtained by calling getAbsoluteFile.

    Pairs a File with the absolute File obtained by calling getAbsoluteFile. Note that this usually means that relative files are resolved against the current working directory.

    Definition Classes
    Mapper
  2. def absolute(file: File): File
  3. def allSubpaths(base: File): Traversable[(File, String)]

    Selects all descendants of base directory and maps them to a path relative to base.

    Selects all descendants of base directory and maps them to a path relative to base. base itself is not included.

    Definition Classes
    Mapper
  4. def apply(f: String): RichFile
  5. def apply(f: File): RichFile
  6. val basic: PathMap

    A path mapper that pairs a File with the path returned by calling getPath on it.

    A path mapper that pairs a File with the path returned by calling getPath on it.

    Definition Classes
    Mapper
  7. def contentOf(baseDirectory: File): Seq[(File, String)]

    return a Seq of mappings excluding the directory itself.

    return a Seq of mappings excluding the directory itself.

    baseDirectory

    The directory that should be turned into a mappings sequence.

    returns

    mappings - The basicDirectory's contents exlcuding basicDirectory itself

    Definition Classes
    Mapper
    Examples:

    1. In order to create mappings for a static directory "extra" add

      mappings ++= contentOf(baseDirectory.value / "extra")

      The resulting mappings sequence will look something like this

      File(baseDirectory/extras/file1) -> "file1"
File(baseDirectory/extras/file2) -> "file2"
...
      2. ,

    2. Add a static directory "extra" and re-map the destination to a different path

      mappings ++= contentOf(baseDirectory.value / "extra").map {
  case (src, destination) => src -> s"new/path/destination"
}
  8. def directory(baseDirectory: File): Seq[(File, String)]

    return a Seq of mappings which effect is to add a whole directory in the generated package

    return a Seq of mappings which effect is to add a whole directory in the generated package

    baseDirectory

    The directory that should be turned into a mappings sequence.

    returns

    mappings The baseDirectory and all of its contents

    Definition Classes
    Mapper
    Example:

    1. In order to create mappings for a static directory "extra" add

      mappings ++= directory(baseDirectory.value / "extra")

      The resulting mappings sequence will look something like this

      File(baseDirectory/extras) -> "extras"
File(baseDirectory/extras/file1) -> "extras/file1"
File(baseDirectory/extras/file2) -> "extras/file2"
...
  9. def fail: (Any) ⇒ Nothing

    A mapper that throws an exception for any input.

    A mapper that throws an exception for any input. This is useful as the last mapper in a pipeline to ensure every input gets mapped.

    Definition Classes
    Mapper
  10. def fileProperty(name: String): File
  11. def flat(newDirectory: File): FileMap

    Constructs a FileMap that pairs a file with a file with the same name in newDirectory.

    Constructs a FileMap that pairs a file with a file with the same name in newDirectory. For example, if newDirectory is /a/b, then /r/s/t/d.txt will be paired with /a/b/d.txt

    Definition Classes
    Mapper
  12. val flat: PathMap

    A path mapper that pairs a File with its name.

    A path mapper that pairs a File with its name. For example, /x/y/z.txt gets paired with z.txt.

    Definition Classes
    Mapper
  13. def flatRebase(newBase: String): PathMap

    A path mapper that pairs a File with a path constructed from newBase and the file's name.

    A path mapper that pairs a File with a path constructed from newBase and the file's name. For example, if newBase = /new/a/, then /old/x/z.txt gets paired with /new/a/z.txt.

    Definition Classes
    Mapper
  14. def makeString(paths: Seq[File], sep: String): String
  15. def makeString(paths: Seq[File]): String
  16. def newerThan(a: File, b: File): Boolean
  17. def normalizeBase(base: String): String
    Definition Classes
    Mapper
  18. def rebase(oldBase: File, newBase: File): FileMap

    Produces a File mapper that pairs a descendant of oldBase with a file in newBase that preserving the relative path of the original file against oldBase.

    Produces a File mapper that pairs a descendant of oldBase with a file in newBase that preserving the relative path of the original file against oldBase. For example, if oldBase is /old/x/ and newBase is /new/a/, /old/x/y/z.txt gets paired with /new/a/y/z.txt.

    Definition Classes
    Mapper
  19. def rebase(oldBases: Iterable[File], newBase: File, zero: FileMap = transparent): FileMap
    Definition Classes
    Mapper
  20. def rebase(oldBase: File, newBase: String): PathMap

    A path mapper that pairs a descendent of oldBase with newBase prepended to the path relative to oldBase.

    A path mapper that pairs a descendent of oldBase with newBase prepended to the path relative to oldBase. For example, if oldBase = /old/x/ and newBase = new/a/, then /old/x/y/z.txt gets paired with new/a/y/z.txt.

    Definition Classes
    Mapper
  21. def relativeTo(bases: Iterable[File], zero: PathMap = transparent): PathMap
    Definition Classes
    Mapper
  22. def relativeTo(base: File): PathMap

    A path mapper that pairs a File with its path relative to base.

    A path mapper that pairs a File with its path relative to base. If the File is not a descendant of base, it is not handled (None is returned by the mapper).

    Definition Classes
    Mapper
  23. def resolve(newDirectory: File): FileMap

    Returns a FileMap that resolves a relative File against newDirectory and pairs the original File with the resolved File.

    Returns a FileMap that resolves a relative File against newDirectory and pairs the original File with the resolved File. The mapper ignores absolute files.

    Definition Classes
    Mapper
  24. def selectSubpaths(base: File, filter: FileFilter): Traversable[(File, String)]

    Selects descendants of base directory matching filter and maps them to a path relative to base.

    Selects descendants of base directory matching filter and maps them to a path relative to base. base itself is not included.

    Definition Classes
    Mapper
  25. val sep: Char

    The separator character of the platform.

  26. def toURLs(files: Seq[File]): Array[URL]
  27. def total[A, B](f: (A) ⇒ B): (A) ⇒ Some[B]

    A mapper that is defined on all inputs by the function f.

    A mapper that is defined on all inputs by the function f.

    Definition Classes
    Mapper
  28. def transparent: (Any) ⇒ Option[Nothing]

    A mapper that ignores all inputs.

    A mapper that ignores all inputs.

    Definition Classes
    Mapper
  29. def userHome: File