org.specs2.files

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

files
FilesRunner
SpecificationsFinder
ConsoleOutput
Classes
Output
FileSystem
FileWriter
FileReader
AnyRef
Any

Visibility

Public
All

Value Members

def != (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def ## (): Int

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

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

Attributes
final
Definition Classes
Any
def afterExecution (specs: Seq[SpecificationStructure])(implicit args: Arguments): Unit

print a message after the execution based on the number of specifications
print a message after the execution based on the number of specifications

Attributes
protected
Definition Classes
FilesRunner
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
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
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
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def beforeExecution (implicit args: Arguments): Unit

print a message before the execution
print a message before the execution

Attributes
protected
Definition Classes
FilesRunner
def canRead (path: String): Boolean

returns
true if the file can be read

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

returns
true if the file can be written

Definition Classes
FileSystem
def classNames (packageName: String, content: String, pattern: Pattern, suffix: String, verbose: Boolean = false): Seq[String]

adds possible specification class names found in the file filePath
The specification pattern is: "\\s*object\\s*(" + pattern + ")\\s*extends\\s*.*Spec.*\\s*\\{" This may be later extended to support other arbitrary patterns
The specification pattern is: "\\s*object\\s*(" + pattern + ")\\s*extends\\s*.*Spec.*\\s*\\{" This may be later extended to support other arbitrary patterns
adds possible specification class names found in the file filePath
The specification pattern is: "\\s*object\\s*(" + pattern + ")\\s*extends\\s*.*Spec.*\\s*\\{" This may be later extended to support other arbitrary patterns
content
content of the file
pattern
a regular expression which is supposed to match an object name extending a Specification

Definition Classes
SpecificationsFinder
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
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
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
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
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
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
def create [T <: AnyRef] (className: String = "", classLoader: ClassLoader = ...)(implicit m: ClassManifest[T]): Either[Throwable, T]

returns
an instance of a given class, returning either the instance, or an exception

Definition Classes
Classes
def createArguments (arguments: Array[String]): Arguments

returns
the Arguments object depending on the command-line options

Attributes
protected
Definition Classes
FilesRunner
def createDir (path: String): Boolean

creates a directory for a given path
creates a directory for a given path

Definition Classes
FileSystem
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
def createObject [T <: AnyRef] (className: String, printMessage: Boolean, printStackTrace: Boolean)(implicit m: ClassManifest[T]): Option[T]

A system property 'debugCreateObject' can be set to override the printMessage and printStackTrace parameters so that the exception message and stacktrace are printed when the object can't be created
A system property 'debugCreateObject' can be set to override the printMessage and printStackTrace parameters so that the exception message and stacktrace are printed when the object can't be created
returns
an instance of a given class and optionally print message and/or the stacktrace if the class can't be loaded.

Definition Classes
Classes
def createObject [T <: AnyRef] (className: String, printMessage: Boolean)(implicit m: ClassManifest[T]): Option[T]

returns
an instance of a given class and optionally print message if the class can't be loaded

Definition Classes
Classes
def createObject [T <: AnyRef] (className: String)(implicit m: ClassManifest[T]): Option[T]

returns
an instance of a given class

Definition Classes
Classes
def createSpecification (className: String, printMessage: Boolean, printStackTrace: Boolean): Option[SpecificationStructure]

returns
a SpecificationStructure object from a className if that class is a SpecificationStructure class.
Tries to load the class name and cast it to a specification None in case of an exception.

Definition Classes
SpecificationsFinder
def createSpecification (className: String): Option[SpecificationStructure]

returns
a SpecificationStructure object from a className if that class is a SpecificationStructure class.
Tries to load the class name and cast it to a specification None in case of an exception.

Definition Classes
SpecificationsFinder
def delete (path: String): Boolean

delete a file
delete a file

Definition Classes
FileWriter
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

Definition Classes
AnyRef → Any
def execute (s: SpecificationStructure, r: Reporter)(implicit args: Arguments): Reporter

report a specification
report a specification

Attributes
protected
Definition Classes
FilesRunner
def exists (path: String): Boolean

returns
true if the file exists

Definition Classes
FileWriter
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
def finalize (): Unit Attributes protected[lang] Definition Classes AnyRef Annotations @throws()
def flush (): Unit flush the content if necessary flush the content if necessary Definition Classes ConsoleOutput → Output
def getAbsolutePath (path: String): String returns the file absolute path Definition Classes FileSystem
def getCanonicalPath (path: String): String returns the file canonical path Definition Classes FileSystem
def getClass (): java.lang.Class[_] Attributes final Definition Classes AnyRef → Any
def getName (path: String): String returns the file name Definition Classes FileSystem
def getParent (path: String): String returns the file parent path Definition Classes FileSystem
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
def globToPattern (glob: String): String returns the regular expression equivalent to a glob pattern (see the specs for Fragments) Definition Classes FileSystem
def hashCode (): Int Definition Classes AnyRef → Any
def inputStream (filePath: String): InputStream returns a FileInputStream for a given file path Definition Classes FileReader
def isAbsolute (path: String): Boolean returns true if the file is absolute Definition Classes FileSystem
def isDir (path: String): Boolean returns true if the File represented by this path is a directory Definition Classes FileSystem
def isDirectory (path: String): Boolean returns true if the file is a directory Definition Classes FileSystem
def isFile (path: String): Boolean returns true if the file is a file Definition Classes FileSystem
def isHidden (path: String): Boolean returns true if the file is hidden Definition Classes FileSystem
def isInstanceOf [T0] : Boolean Attributes final Definition Classes Any
def listFiles (path: String): List[String] returns the files of that directory Definition Classes FileSystem
def loadXhtmlFile (filePath: String): 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
def loadXmlFile (filePath: String): NodeSeq returns the xml content of a file, using the XML parser Definition Classes FileReader
def main (arguments: Array[String]): Unit Definition Classes FilesRunner
def mkdirs (path: String): Boolean creates a new directory creates a new directory Definition Classes FileWriter
def ne (arg0: AnyRef): Boolean Attributes final Definition Classes AnyRef
def notify (): Unit Attributes final Definition Classes AnyRef
def notifyAll (): Unit Attributes final Definition Classes AnyRef
def packageName (content: String): String returns the package declaration at the beginning of a file Definition Classes SpecificationsFinder
def print (m: Any): Unit print an object with no newline print an object with no newline Definition Classes Output
def printStackTrace (t: Throwable): Unit print stacktraces print stacktraces Definition Classes Output
def printf (s: String, args: Any*): Unit print several objects according to a format string (see Console. print several objects according to a format string (see Console.printf) Definition Classes ConsoleOutput → Output
def println (m: Any): Unit print an object with a newline print an object with a newline Definition Classes Output
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
def readLines (path: String): IndexedSeq[String] Definition Classes FileReader
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
def reporters (implicit arguments: Arguments): List[Reporter] returns a reporter depending on the provided arguments Attributes protected Definition Classes FilesRunner
def specPattern (specType: String, pattern: String): String pattern to use to get specification names from file contents pattern to use to get specification names from file contents Definition Classes SpecificationsFinder
def specificationClassNames (implicit args: Arguments): Seq[String] returns the specifications class names to execute Attributes protected Definition Classes FilesRunner
def specificationNames (path: String = "**/*.scala", pattern: String = ".*Spec", basePath: String = FromSource.srcDir, verbose: Boolean = false): Seq[String] path a path to a directory containing scala files (it can be a glob: i.e. "dir/**/spec.scala") pattern a regular expression which is supposed to match an object name extending a Specification returns specification names by scanning files and trying to find specifications declarations Definition Classes SpecificationsFinder
def specifications (implicit args: Arguments): Seq[SpecificationStructure] returns the specifications to execute Attributes protected Definition Classes FilesRunner
def specifications (path: String = "**/*.scala", pattern: String = ".*Spec", filter: (String) ⇒ Boolean = (name: String) => true, basePath: String = FromSource.srcDir, verbose: Boolean = false): Seq[SpecificationStructure] path a path to a directory containing scala files (it can be a glob: i.e. "dir/**/spec.scala") pattern a regular expression which is supposed to match an object name extending a Specification filter a function to filter out unwanted specifications returns specifications created from specification names Definition Classes SpecificationsFinder
def synchronized [T0] (arg0: ⇒ T0): T0 Attributes final Definition Classes AnyRef
def toString (): String Definition Classes AnyRef → Any
def tryToCreateObject [T <: AnyRef] (className: String, printMessage: Boolean = true, printStackTrace: Boolean = true, loader: ClassLoader = ...)(implicit m: ClassManifest[T]): Option[T] Try to create an instance of a given class by using whatever constructor is available and trying to instantiate the first parameter recursively if there is a parameter for that constructor. Try to create an instance of a given class by using whatever constructor is available and trying to instantiate the first parameter recursively if there is a parameter for that constructor. This is useful to instantiate nested classes which are referencing their outer class in their constructor Definition Classes Classes
def unjar (path: String, dirPath: String, regexFilter: String): 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. path path of the jar file regexFilter regular expression filtering files which shouldn't be extracted Definition Classes FileSystem
def unjar (path: String, dest: String): 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. path path of the jar file dest destination directory path Definition Classes FileSystem
def wait (): Unit Attributes final Definition Classes AnyRef Annotations @throws()
def wait (arg0: Long, arg1: Int): Unit Attributes final Definition Classes AnyRef Annotations @throws()
def wait (arg0: Long): Unit Attributes final Definition Classes AnyRef Annotations @throws()
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
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
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 FilesRunner
            

              Inherited from SpecificationsFinder
            

              Inherited from ConsoleOutput
            

              Inherited from Classes
            

              Inherited from Output
            

              Inherited from FileSystem
            

              Inherited from FileWriter
            

              Inherited from FileReader
            

              Inherited from AnyRef
            

              Inherited from Any

files

object files extends FilesRunner

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def afterExecution (specs: Seq[SpecificationStructure])(implicit args: Arguments): Unit

def append (path: String)(function: (Writer) ⇒ Unit): Unit

def appendToFile (path: String, content: ⇒ String): Unit

def appendToXmlFile (path: String, content: ⇒ NodeSeq): Unit

def asInstanceOf [T0] : T0

def beforeExecution (implicit args: Arguments): Unit

def canRead (path: String): Boolean

def canWrite (path: String): Boolean

def classNames (packageName: String, content: String, pattern: Pattern, suffix: String, verbose: Boolean = false): Seq[String]

def clone (): AnyRef

def copy (input: InputStream, output: OutputStream): Unit

def copyDir (src: String, dest: String): Unit

def copyDir (url: URL, dest: String): Unit

def copyFile (path: String, dest: String): Unit

def copySpecResourcesDir (src: String, outputDir: String): Unit

def create [T <: AnyRef] (className: String = "", classLoader: ClassLoader = ...)(implicit m: ClassManifest[T]): Either[Throwable, T]

def createArguments (arguments: Array[String]): Arguments

def createDir (path: String): Boolean

def createFile (path: String): AnyVal

def createObject [T <: AnyRef] (className: String, printMessage: Boolean, printStackTrace: Boolean)(implicit m: ClassManifest[T]): Option[T]

def createObject [T <: AnyRef] (className: String, printMessage: Boolean)(implicit m: ClassManifest[T]): Option[T]

def createObject [T <: AnyRef] (className: String)(implicit m: ClassManifest[T]): Option[T]

def createSpecification (className: String, printMessage: Boolean, printStackTrace: Boolean): Option[SpecificationStructure]

def createSpecification (className: String): Option[SpecificationStructure]

def delete (path: String): Boolean

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def execute (s: SpecificationStructure, r: Reporter)(implicit args: Arguments): Reporter

def exists (path: String): Boolean

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

def finalize (): Unit

def flush (): Unit

def getAbsolutePath (path: String): String

def getCanonicalPath (path: String): String

def getClass (): java.lang.Class[_]

def getName (path: String): String

def getParent (path: String): String

def getWriter (path: String, append: Boolean = false): Writer

def globToPattern (glob: String): String

def hashCode (): Int

def inputStream (filePath: String): InputStream

def isAbsolute (path: String): Boolean

def isDir (path: String): Boolean

def isDirectory (path: String): Boolean

def isFile (path: String): Boolean

def isHidden (path: String): Boolean

def isInstanceOf [T0] : Boolean

def listFiles (path: String): List[String]

def loadXhtmlFile (filePath: String): NodeSeq

def loadXmlFile (filePath: String): NodeSeq

def main (arguments: Array[String]): Unit

def mkdirs (path: String): Boolean

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

def packageName (content: String): String

def print (m: Any): Unit

def printStackTrace (t: Throwable): Unit

def printf (s: String, args: Any*): Unit

def println (m: Any): Unit

def readFile (path: String): String

def readLines (path: String): IndexedSeq[String]

def removeDir (path: String): String

def reporters (implicit arguments: Arguments): List[Reporter]

def specPattern (specType: String, pattern: String): String

def specificationClassNames (implicit args: Arguments): Seq[String]

def specificationNames (path: String = "**/*.scala", pattern: String = ".*Spec", basePath: String = FromSource.srcDir, verbose: Boolean = false): Seq[String]

def specifications (implicit args: Arguments): Seq[SpecificationStructure]

def specifications (path: String = "**/*.scala", pattern: String = ".*Spec", filter: (String) ⇒ Boolean = (name: String) => true, basePath: String = FromSource.srcDir, verbose: Boolean = false): Seq[SpecificationStructure]

def synchronized [T0] (arg0: ⇒ T0): T0

def toString (): String

def tryToCreateObject [T <: AnyRef] (className: String, printMessage: Boolean = true, printStackTrace: Boolean = true, loader: ClassLoader = ...)(implicit m: ClassManifest[T]): Option[T]

def specificationNames (path: String = "**/.scala", pattern: String = ".Spec", basePath: String = FromSource.srcDir, verbose: Boolean = false): Seq[String]

def specifications (path: String = "**/.scala", pattern: String = ".Spec", filter: (String) ⇒ Boolean = (name: String) => true, basePath: String = FromSource.srcDir, verbose: Boolean = false): Seq[SpecificationStructure]