grizzled.file

GrizzledFile

class GrizzledFile extends AnyRef

A wrapper for java.io.File that provides additional methods. By importing the implicit conversion functions, you can use the methods in this class transparently from a java.io.File object.

import grizzled.file.GrizzledFile._

val file = new File("/tmp/foo/bar")
println(file.split) // prints: List(/tmp, foo, bar)
attributes: final
go to: companion
linear super types: AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. GrizzledFile
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new GrizzledFile (file: File)

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  8. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  9. def basename : File

    Get the basename (file name only) part of a path.

    Get the basename (file name only) part of a path.

    returns

    the file name portion, as a File

  10. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected
    definition classes: AnyRef
  11. def copyTo (target: File) : File

    Copy the file to a target directory or file.

    Copy the file to a target directory or file.

    target

    path to the target file or directory

    returns

    the target file

  12. def copyTo (target: String) : File

    Copy the file to a target directory or file.

    Copy the file to a target directory or file.

    target

    path to the target file or directory

    returns

    the target file

  13. def deleteRecursively () : Unit

    Recursively remove the directory specified by this object.

    Recursively remove the directory specified by this object. This method is conceptually equivalent to rm -r on a Unix system.

  14. def dirname : File

    Get the directory name of the file.

    Get the directory name of the file.

    returns

    the directory portion, as a File.

  15. def dirnameBasename : (File, File)

    Split the file's path into directory (dirname) and file (basename) components.

    Split the file's path into directory (dirname) and file (basename) components. Analogous to Python's os.path.pathsplit() function.

    returns

    a (dirname, basename) tuple of File objects.

  16. def dirnameBasenameExtension : (File, String, String)

    Split this file's pathname into the directory name, basename, and extension pieces.

    Split this file's pathname into the directory name, basename, and extension pieces.

    returns

    a 3-tuple of (dirname, basename, extension)

  17. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  18. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  19. val file : File

  20. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected
    definition classes: AnyRef
  21. def getClass () : java.lang.Class[_]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  22. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  23. def isEmpty : Boolean

    Determine whether a directory is empty.

    Determine whether a directory is empty. Only meaningful for a directory.

    returns

    true if the directory is empty, false if not

  24. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  25. def listRecursively (topdown: Boolean =true) : Iterator[File]

    List a directory recursively, returning File objects for each file (and subdirectory) found.

    List a directory recursively, returning File objects for each file (and subdirectory) found. This method does lazy evaluation, instead of calculating everything up-front, as walk() does.

    If topdown is true, a directory is generated before the entries for any of its subdirectories (directories are generated top down). If topdown is false, a directory directory is generated after the entries for all of its subdirectories (directories are generated bottom up).

    topdown

    true to do a top-down traversal, false otherwise.

    returns

    a generator (iterator) of File objects for everything under the directory.

  26. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  27. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  28. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  29. def relativePath (relativeTo: File) : String

    Get the path of this file, relative to some other file.

    Get the path of this file, relative to some other file.

    relativeTo

    the other file

    returns

    the path of this file, relative to the other file.

  30. def split : List[String]

    Split this file's path into its constituent components.

    Split this file's path into its constituent components. If the path is absolute, the first piece will have a file separator in the beginning. Examples:

    Input Output
    "" List("")
    "/" List("/")
    "foo" List("foo")
    "foo/bar" List("foo", "bar")
    "." List(".")
    "../foo" List("..", "foo")
    "./foo" List(".", "foo")
    "/foo/bar/baz" List("/foo", "bar", "baz")
    "foo/bar/baz" List("foo", "bar", "baz")
    "/foo" List("/foo")

    returns

    the component pieces.

  31. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  32. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  33. def touch (time: Long =-1) : Unit

    Similar to the Unix touch command, this function:

    Similar to the Unix touch command, this function:

    • updates the access and modification time for the path represented by this object
    • creates the path (as a file), if it does not exist

    If the file corresponds to an existing directory, this method will throw an exception.

    time

    Set the last-modified time to this time, or to the current time if this parameter is negative.

  34. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  35. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  36. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  37. def walk (topdown: Boolean =true) : List[(String, List[String], List[String])]

    Directory tree lister, adapted from Python's os.walk() function.

    Directory tree lister, adapted from Python's os.walk() function. NOTE: This function generates the entire directory tree in memory, before returning. If you want a lazy generator, with optional filtering, use the listRecursively() method.

    For each directory in the directory tree rooted at this object (including the directory itself, but excluding '.' and '..'), yields a 3-tuple.

    dirpath, dirnames, filenames
    

    dirpath is a string, the path to the directory. dirnamesis a list of the names of the subdirectories in dirpath (excluding '.' and '..'). filenames is a list of the names of the non-directory files in dirpath. Note that the names in the lists are just names, with no path components. To get a full path (which begins with this directory) to a file or directory in dirpath, use dirpath + java.io.fileSeparator + name, or usegrizzled.file.util.joinPath().

    If topdown is true, the triplet for a directory is generated before the triplets for any of its subdirectories (directories are generated top down). If topdown is false, the triplet for a directory is generated after the triples for all of its subdirectories (directories are generated bottom up).

    **WARNING!** This method does not grok symbolic links!

    topdown

    true to do a top-down traversal, false otherwise.

    returns

    List of triplets, as described above.

Inherited from AnyRef

Inherited from Any