o

sbt.io

Path

object Path extends Mapper

Linear Supertypes
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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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
  5. def absolute(file: File): File
  6. 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
  7. def apply(f: String): RichFile
  8. def apply(f: File): RichFile
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. 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
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. 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. 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"
      }
    2. ,
    3. 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"
      ...
  13. 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"
      ...
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. 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
  17. def fileProperty(name: String): File
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. 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
  20. 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
  21. 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
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def makeString(paths: Seq[File], sep: String): String
  26. def makeString(paths: Seq[File]): String
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def newerThan(a: File, b: File): Boolean
  29. def normalizeBase(base: String): String
    Definition Classes
    Mapper
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. 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
  33. def rebase(oldBases: Iterable[File], newBase: File, zero: FileMap = transparent): FileMap
    Definition Classes
    Mapper
  34. 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
  35. def relativeTo(bases: Iterable[File], zero: PathMap = transparent): PathMap
    Definition Classes
    Mapper
  36. 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
  37. 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
  38. 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
  39. val sep: Char

    The separator character of the platform.

  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. def toURLs(files: Seq[File]): Array[URL]
  43. 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
  44. def transparent: (Any) ⇒ Option[Nothing]

    A mapper that ignores all inputs.

    A mapper that ignores all inputs.

    Definition Classes
    Mapper
  45. def userHome: File
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Mapper

Inherited from AnyRef

Inherited from Any

Ungrouped