org.specs2.matcher

PathMatchers

trait PathMatchers extends PathBaseMatchers with PathBeHaveMatchers

The PathMatchers trait provides matchers which are applicable to strings representing paths

Linear Supertypes
PathBeHaveMatchers, PathBaseMatchers, FileSystem, FileWriter, FileReader, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PathMatchers
  2. PathBeHaveMatchers
  3. PathBaseMatchers
  4. FileSystem
  5. FileWriter
  6. FileReader
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class PathResultMatcher extends AnyRef

    Definition Classes
    PathBeHaveMatchers

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. def aDirectoryPath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  7. def aFilePath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  8. def aHiddenPath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  9. def aReadablePath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  10. def aWritablePath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  11. def anAbsolutePath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  12. def anExistingPath: PathMatcher

    Definition Classes
    PathBeHaveMatchers
  13. def append(path: String)(function: (Writer) ⇒ Unit): Unit

    append some content to a file and take care of closing the file.

    append some content to a file and take care of closing the file.

    Usage:

    write("./dir/hello.txt") { out =>
    out.write("content")
    }
    path

    path of the file to write

    Definition Classes
    FileWriter
  14. def appendToFile(path: String, content: ⇒ String): Unit

    writes some content to a file.

    writes some content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter
  15. def appendToXmlFile(path: String, content: ⇒ NodeSeq): Unit

    writes some xml content to a file.

    writes some xml content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter
  16. def asAbsolutePath(name: String): PathMatcher

    Definition Classes
    PathBeHaveMatchers
  17. def asCanonicalPath(name: String): PathMatcher

    Definition Classes
    PathBeHaveMatchers
  18. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  19. def beADirectoryPath: PathMatcher

    matches if new File(path).

    matches if new File(path).isDirectory

    Definition Classes
    PathBaseMatchers
  20. def beAFilePath: PathMatcher

    matches if new File(path).

    matches if new File(path).isFile

    Definition Classes
    PathBaseMatchers
  21. def beAHiddenPath: PathMatcher

    matches if new File(path).

    matches if new File(path).isHidden

    Definition Classes
    PathBaseMatchers
  22. def beAReadablePath: PathMatcher

    matches if new File(path).

    matches if new File(path).canRead

    Definition Classes
    PathBaseMatchers
  23. def beAWritablePath: PathMatcher

    matches if new File(path).

    matches if new File(path).canWrite

    Definition Classes
    PathBaseMatchers
  24. def beAnAbsolutePath: PathMatcher

    matches if new File(path).

    matches if new File(path).isAbsolute

    Definition Classes
    PathBaseMatchers
  25. def beAnExistingPath: PathMatcher

    matches if new File(path).

    matches if new File(path).exists

    Definition Classes
    PathBaseMatchers
  26. def beEqualToIgnoringSep(other: String): PathMatcher

    matches if 2 paths are the same regardless of their separators

    matches if 2 paths are the same regardless of their separators

    Definition Classes
    PathBaseMatchers
  27. def canRead(path: String): Boolean

    returns

    true if the file can be read

    Definition Classes
    FileSystem
  28. def canWrite(path: String): Boolean

    returns

    true if the file can be written

    Definition Classes
    FileSystem
  29. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def copy(input: InputStream, output: OutputStream): Unit

    Copy an input stream to an output stream.

    Copy an input stream to an output stream.

    input

    input stream

    output

    output stream

    Definition Classes
    FileSystem
  31. def copyDir(src: String, dest: String): Unit

    copy the content of a directory to another.

    copy the content of a directory to another.

    dest

    destination directory path

    Definition Classes
    FileSystem
  32. def copyDir(url: URL, dest: String): Unit

    copy the content of a directory to another.

    copy the content of a directory to another.

    url

    url of the directory to copy

    dest

    destination directory path

    Definition Classes
    FileSystem
  33. def copyFile(path: String, dest: String): Unit

    Copy the content of a directory to another.

    Copy the content of a directory to another.

    path

    path of the file to copy

    dest

    destination directory path

    Definition Classes
    FileSystem
  34. def copySpecResourcesDir(src: String, outputDir: String): Unit

    Copy specs resources found either in the specs jar or in the classpath directories to an output directory

    Copy specs resources found either in the specs jar or in the classpath directories to an output directory

    src

    name of the resource directory to copy

    outputDir

    output directory where to copy the files to

    Definition Classes
    FileSystem
  35. def createDir(path: String): Boolean

    creates a directory for a given path

    creates a directory for a given path

    Definition Classes
    FileSystem
  36. def createFile(path: String): AnyVal

    creates a file for a given path.

    creates a file for a given path. Create the parent directory if necessary.

    Definition Classes
    FileWriter
  37. def delete(path: String): Boolean

    delete a file

    delete a file

    Definition Classes
    FileWriter
  38. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  39. def equalToIgnoringSep(other: String): PathMatcher

    Definition Classes
    PathBeHaveMatchers
  40. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  41. def exists(path: String): Boolean

    returns

    true if the file exists

    Definition Classes
    FileWriter
  42. def filePaths(basePath: String = ".", path: String = "*", verbose: Boolean = false): Seq[String]

    path

    glob expression, for example: ./dir/**/.xml

    returns

    the list of paths represented by the "glob" definition path

    Definition Classes
    FileSystem
  43. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  44. def getAbsolutePath(path: String): String

    returns

    the file absolute path

    Definition Classes
    FileSystem
  45. def getCanonicalPath(path: String): String

    returns

    the file canonical path

    Definition Classes
    FileSystem
  46. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  47. def getName(path: String): String

    returns

    the file name

    Definition Classes
    FileSystem
  48. def getParent(path: String): String

    returns

    the file parent path

    Definition Classes
    FileSystem
  49. def getWriter(path: String, append: Boolean = false): Writer

    The getWriter function can be overriden to provide a mock writer writing to the console for example

    The getWriter function can be overriden to provide a mock writer writing to the console for example

    returns

    a Writer object opened on the file designated by path

    Definition Classes
    FileWriter
  50. def globToPattern(glob: String): String

    returns

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

    Definition Classes
    FileSystem
  51. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  52. def haveAsAbsolutePath(path: String): PathMatcher

    matches if new File(path).

    matches if new File(path).getAbsolutePath == absolutePath

    Definition Classes
    PathBaseMatchers
  53. def haveAsCanonicalPath(path: String): PathMatcher

    matches if new File(path).

    matches if new File(path).getCanonicalPath == canonicalPath

    Definition Classes
    PathBaseMatchers
  54. def haveParentPath(parent: String): PathMatcher

    matches if new File(path).

    matches if new File(path).getParent == parent

    Definition Classes
    PathBaseMatchers
  55. def havePathName(name: String): PathMatcher

    matches if new File(path).

    matches if new File(path).getName == name

    Definition Classes
    PathBaseMatchers
  56. def inputStream(filePath: String): InputStream

    returns

    a FileInputStream for a given file path

    Definition Classes
    FileReader
  57. def isAbsolute(path: String): Boolean

    returns

    true if the file is absolute

    Definition Classes
    FileSystem
  58. def isDir(path: String): Boolean

    returns

    true if the File represented by this path is a directory

    Definition Classes
    FileSystem
  59. def isDirectory(path: String): Boolean

    returns

    true if the file is a directory

    Definition Classes
    FileSystem
  60. def isFile(path: String): Boolean

    returns

    true if the file is a file

    Definition Classes
    FileSystem
  61. def isHidden(path: String): Boolean

    returns

    true if the file is hidden

    Definition Classes
    FileSystem
  62. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  63. def listFiles(path: String): List[String]

    returns

    the files of that directory

    Definition Classes
    FileSystem
  64. def listPaths(list: String*): PathMatcher

    matches if new File(path).

    matches if new File(path).list == list(files)

    Definition Classes
    PathBaseMatchers
  65. def loadXhtmlFile(filePath: String, report: (Exception, String) ⇒ Unit = defaultLoadXhtmlFileReport, sourceErrors: Boolean = true): NodeSeq

    returns

    the xml content of a file using the Xhtml parser

    if the file contains several nodes, it wraps them up in a single artificial node

    Definition Classes
    FileReader
  66. def loadXmlFile(filePath: String)(report: (Exception) ⇒ Unit = (e:Exception) => e.printStackTrace): NodeSeq

    returns

    the xml content of a file, using the XML parser

    Definition Classes
    FileReader
  67. def mkdirs(path: String): Boolean

    creates a new directory

    creates a new directory

    Definition Classes
    FileWriter
  68. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  71. def parentPath(parent: String): PathMatcher

    Definition Classes
    PathBeHaveMatchers
  72. def pathName(name: String): PathMatcher

    Definition Classes
    PathBeHaveMatchers
  73. def readFile(path: String): String

    reads the content of a file

    reads the content of a file

    path

    the path of the file to read

    returns

    the content of the file at path

    Definition Classes
    FileReader
  74. def readLines(path: String): IndexedSeq[String]

    Definition Classes
    FileReader
  75. def removeDir(path: String): String

    deletes the directory and all directory content at the specified path and return the parent path of that directory

    deletes the directory and all directory content at the specified path and return the parent path of that directory

    Definition Classes
    FileSystem
  76. def samePath(p1: String, p2: String): Boolean

    returns

    true if 2 paths are the same according to their canonical representation

    Definition Classes
    FileSystem
  77. def silentLoadXhtmlFileReport: (Exception, String) ⇒ Unit

    Definition Classes
    FileReader
  78. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  79. implicit def toPathResultMatcher(result: MatchResult[String]): PathResultMatcher

    matcher aliases and implicits to use with be / have + matcher

    matcher aliases and implicits to use with be / have + matcher

    Definition Classes
    PathBeHaveMatchers
  80. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def write(path: String)(function: (Writer) ⇒ Unit): Unit

    writes some content to a file and take care of closing the file.

    writes some content to a file and take care of closing the file.

    Usage:

    write("./dir/hello.txt") { out =>
    out.write("content")
    }
    path

    path of the file to write

    Definition Classes
    FileWriter
  85. def writeFile(path: String, content: ⇒ String): Unit

    writes some content to a file.

    writes some content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter
  86. def writeXmlFile(path: String, content: ⇒ NodeSeq): Unit

    writes some xml content to a file.

    writes some xml content to a file.

    path

    path of the file to read

    content

    content of the file to write

    Definition Classes
    FileWriter

Inherited from PathBeHaveMatchers

Inherited from PathBaseMatchers

Inherited from FileSystem

Inherited from FileWriter

Inherited from FileReader

Inherited from AnyRef

Inherited from Any

Ungrouped