GrizzledFile

Instance Constructors

new GrizzledFile(file: File)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
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
def deleteRecursively(): Either[String, Int]

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.
returns
Left(error) or Right(total), where total is the number of files and directories actually deleted.
def dirname: File

Get the directory name of the file.
Get the directory name of the file.
returns
the directory portion, as a File.
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.
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)
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val file: File
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listRecursively(topdown: Boolean = true): Stream[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 stream of File objects for everything under the directory.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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.

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.

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def touch(time: Long = 1): Either[String, Boolean]

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 return an error.
time
Set the last-modified time to this time, or to the current time if this parameter is negative.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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 use grizzled.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.

final class GrizzledFile extends AnyRef

Instance Constructors

new GrizzledFile(file: File)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def basename: File

def clone(): AnyRef

def copyTo(target: File): File

def copyTo(target: String): File

def deleteRecursively(): Either[String, Int]

def dirname: File

def dirnameBasename: (File, File)

def dirnameBasenameExtension: (File, String, String)

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val file: File

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def isEmpty: Boolean

final def isInstanceOf[T0]: Boolean

def listRecursively(topdown: Boolean = true): Stream[File]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def relativePath(relativeTo: File): String

def split: List[String]

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

def toString(): String

def touch(time: Long = 1): Either[String, Boolean]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def walk(topdown: Boolean = true): List[(String, List[String], List[String])]

Inherited from AnyRef

Inherited from Any

Ungrouped