org.specs2.io

FileSystem

Related Docs: object FileSystem | package io

trait FileSystem extends FilePathReader

Interface for the FileSystem where effects are denoted with the "Action" type

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

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def copyDir(src: DirectoryPath, dest: DirectoryPath): Action[Unit]

    copy the content of a directory to another.

    copy the content of a directory to another.

    src

    path of the directory to copy

    dest

    destination directory path

  7. def copyFile(dest: DirectoryPath)(filePath: FilePath): Action[Unit]

    copy a file to a destination directory

    copy a file to a destination directory

    dest

    destination directory path

    filePath

    path of the file to copy

  8. def createFile(filePath: FilePath): Action[Boolean]

    create a new file

  9. def delete(dir: DirectoryPath): Action[Unit]

    delete a directory

  10. def delete(file: FilePath): Action[Unit]

    delete files or directories

  11. def deleteFile(filePath: FilePath): Action[Boolean]

    delete a file

  12. def doesNotExist(directoryPath: DirectoryPath): Action[Boolean]

    returns

    true if the directory doesn't exist

    Definition Classes
    FilePathReader
  13. def doesNotExist(filePath: FilePath): Action[Boolean]

    returns

    true if the file doesn't exist

    Definition Classes
    FilePathReader
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def exists(directoryPath: DirectoryPath): Action[Boolean]

    returns

    true if the directory exists

    Definition Classes
    FilePathReader
  17. def exists(filePath: FilePath): Action[Boolean]

    returns

    true if the file exists

    Definition Classes
    FilePathReader
  18. def filePaths(dir: DirectoryPath, glob: String, verbose: Boolean): Action[IndexedSeq[FilePath]]

    returns

    the list of file paths accessible from dir

    Definition Classes
    FilePathReader
  19. def filterWithPattern(pattern: String): (FilePath) ⇒ Boolean

    filter files according to a regex pattern

    filter files according to a regex pattern

    Definition Classes
    FilePathReader
  20. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  22. def globToPattern(glob: String): String

    returns

    the regular expression equivalent to a glob pattern (see the specs for Fragments)

    Definition Classes
    FilePathReader
  23. def hashCode(): Int

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

    Definition Classes
    Any
  25. def listDirectDirectoryPaths(directory: DirectoryPath): Action[IndexedSeq[DirectoryPath]]

    returns

    the files directly accessible from a directory

    Definition Classes
    FilePathReader
  26. def listDirectFilePaths(directory: DirectoryPath): Action[IndexedSeq[FilePath]]

    returns

    the files directly accessible from a directory

    Definition Classes
    FilePathReader
  27. def listFilePaths(directory: DirectoryPath): Action[IndexedSeq[FilePath]]

    returns

    the files accessible recursively from a directory

    Definition Classes
    FilePathReader
  28. def md5(filePath: FilePath): Action[String]

    returns

    the MD5 hash of a file

    Definition Classes
    FilePathReader
  29. def mkdirs(path: FilePath): Action[Unit]

    create a the directory containing a file and its parent directories

  30. def mkdirs(path: DirectoryPath): Action[Unit]

    create a directory and its parent directories

  31. def mustBeADirectory(file: File): Action[Unit]

    succeeds if the file is a directory

    succeeds if the file is a directory

    Definition Classes
    FilePathReader
  32. def mustExist(file: File): Action[Unit]

    succeeds if the file exists

    succeeds if the file exists

    Definition Classes
    FilePathReader
  33. def mustNotBeADirectory(file: File): Action[Unit]

    succeeds if the file is not a directory

    succeeds if the file is not a directory

    Definition Classes
    FilePathReader
  34. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  37. def readBytes(filePath: FilePath): Action[Array[Byte]]

    read the content of a file as an Array of Bytes

    read the content of a file as an Array of Bytes

    Definition Classes
    FilePathReader
  38. def readFile(path: FilePath): Action[String]

    returns

    the content of a file encoded as UTF8

    Definition Classes
    FilePathReader
  39. def readFileWithCodec(path: FilePath, codec: Codec): Action[String]

    returns

    the content of a file with a specific codec

    Definition Classes
    FilePathReader
  40. def readLines(filePath: FilePath): Action[IndexedSeq[String]]

    returns

    the content of a file as UTF-8 lines

    Definition Classes
    FilePathReader
  41. def readLinesWithCodec(filePath: FilePath, codec: Codec): Action[IndexedSeq[String]]

    returns

    the content of a file with a specific codec

    Definition Classes
    FilePathReader
  42. def replaceInFile(filePath: FilePath, source: String, target: String): Action[Unit]

    replace a string in a file

  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  44. def toString(): String

    Definition Classes
    AnyRef → Any
  45. def unjar(jarUrl: URL, dest: DirectoryPath, regexFilter: String): Action[Unit]

    Unjar the jar (or zip file) specified by "path" to the "dest" directory.

    Unjar the jar (or zip file) specified by "path" to the "dest" directory. Filters files which shouldn't be extracted with a regular expression.

    jarUrl

    path of the jar file

    dest

    destination directory path

    regexFilter

    regular expression filtering files which shouldn't be extracted; the expression must capture the path of an entry as group 1 which will then be used relative to dirPath as target path for that entry

  46. def updateFileContent(filePath: FilePath)(update: (String) ⇒ String): Action[Unit]

    modify the content of a file

  47. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. def withEphemeralFile(path: FilePath)(action: Action[Unit]): Action[Unit]

    execute an action with a File, then delete it

  51. def writeFile(filePath: FilePath, content: String): Action[Unit]

    write a string to a file as UTF-8

  52. def writeFileTask(filePath: FilePath, content: String): Task[Unit]

    write a string to a file as UTF-8

Inherited from FilePathReader

Inherited from AnyRef

Inherited from Any

Ungrouped