File

DSL to drop to child

DSL to drop to child

For large number of lines that may not fit in memory, use printLines

If you need to specify a charset, use the above version

Resolves ../../foo to the fully qualified path

Changes the file-extension by renaming this file; if file does not have an extension, it adds the extension Example usage file"foo.java".changeExtensionTo(".scala")

If file does not exist (or is a directory) no change is done and the current file is returned

If this is a directory, remove all its children If its a file, empty the contents

More Scala friendly way of doing Files.walk Note: This is lazy (returns an Iterator) and won't evaluate till we reify the iterator (e.g. using .toList)

Check if this directory contains this file

return the content type of the file e.g. text/html

Copy this file to destination similar to unix cp command

Copies this file into the given directory

Create this directory and all its parents Unlike the JDK, this by default sanely handles the JDK-8130464 bug If you want default Java behaviour, use File.LinkOptions.noFollow

Create this directory

Create this file

Create this file. If it exists, don't do anything

Deletes this file or directory Unless otherwise specified, this does not follow symlinks i.e. if this is a symlink, only the symlink itself is deleted and not the linked object

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an 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 Any 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 usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Util to glob from this file's path

Util to match from this file's path using Regex

Returns the extension if file is a regular file If file is unreadable or does not exist, it is assumed to be not a regular file See: https://github.com/pathikrit/better-files/issues/89

Calculate 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.

Check if a file is locked.

This differs from the above as this checks if the JVM can read this file even though the OS cannot in certain platforms

Almost same as isSameContentAs but uses faster md5 hashing to compare (and thus small chance of false positive) Also works for directories

Iterate over lines in a file (auto-close stream on complete) If you want partial iteration use @see lines()

Load all lines from this file Note: Large files may cause an OutOfMemory in which case, use the streaming version @see lineIterator

List files recursively up to given depth using a custom file filter

load bytes into memory - for large files you want to use @see bytes which uses an iterator

Move this to destination similar to unix mv command

Moves this file into the given directory

Name of file Certain files may not have a name e.g. root directory - returns empty string in that case

Certain files may not have a name e.g. root directory - returns None in that case

Return the file name without extension e.g. for foo.tar.gz return foo

Return parent of this file NOTE: This API returns null if this file is the root; please use parentOption if you expect to handle roots

Write lines into this file

Deserialize a object using Java's default serialization from this file

register a watch service for given events

getResource... always uses "/" for separator https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html#getResource(java.lang.String)

Streamed unzipping is slightly slower but supports larger files and more encodings

test if file has this permission

Returns a string representation of the object.

The default representation is platform dependent.

Java's temporary files/directories are not cleaned up by default. If we explicitly call .deleteOnExit(), it gets added to shutdown handler which is not ideal for long running systems with millions of temporary files as: a) it would slowdown shutdown and b) occupy unnecessary disk-space during app lifetime

This util auto-deletes the resource when done using the Dispose facility

Example usage: File.temporaryDirectory().foreach(tempDir => doSomething(tempDir)

Similar to string.split(), this returns tokens from the file by given splitter (default is whitespace)

Similar to the UNIX command touch - create this file if it does not exist and set its last modification time

unzip to a temporary zip file

Unzips this zip file

Set a file attribute e.g. file("dos:system") = true

Walk the directory tree recursively upto maxDepth

Write byte array to file. For large contents consider using the writeBytes

Serialize a object using Java's serializer into this file, creating it and its parents if they do not exist

zip to a temp directory

Adds these files into this zip file Example usage: File("test.zip").zipIn(Seq(file"hello.txt", file"hello2.txt"))

Zips this file (or directory)