scala3-compiler-bootstrapped/dotty.tools.io/File

File

class File(jpath: JPath)(implicit constructorCodec: Codec) extends Path with Chars

An abstraction for files. For character data, a Codec can be supplied at either creation time or when a method involving character data is called (with the latter taking precedence if supplied.) If neither is available, the value of scala.io.Codec.default is used.

Authors:

Paul Phillips

Since:

2.8 ''Note: This is library is considered experimental and should not be used unless you know what you are doing.''

Companion:
object
trait Chars
trait Bytes
class Path
class Object
trait Matchable
class Any

Value members

Concrete methods

override def addExtension(ext: String): File
Definition Classes
def appendAll(strings: String*): Unit
def bufferedWriter(): BufferedWriter

Wraps a BufferedWriter around the result of writer().

Wraps a BufferedWriter around the result of writer().

def inputStream(): InputStream

Obtains an InputStream.

Obtains an InputStream.

override def length: Long
Definition Classes
override def normalize: File
Definition Classes
def outputStream(append: Boolean): OutputStream

Obtains a OutputStream.

Obtains a OutputStream.

def printlnAll(strings: String*): Unit

Calls println on each string (so it adds a newline in the PrintWriter fashion.)

Calls println on each string (so it adds a newline in the PrintWriter fashion.)

def setExecutable(executable: Boolean, ownerOnly: Boolean): Boolean

Reflection since we're into the java 6+ API.

Reflection since we're into the java 6+ API.

override def toAbsolute: File
Definition Classes
override def toDirectory: Directory
Definition Classes
override def toFile: File
Definition Classes
override def walkFilter(cond: Path => Boolean): Iterator[Path]
Definition Classes
def writeAll(strings: String*): Unit

Creates a new file and writes all the Strings to it.

Creates a new file and writes all the Strings to it.

def writer(append: Boolean, codec: Codec): OutputStreamWriter

Obtains an OutputStreamWriter wrapped around a FileOutputStream. This should behave like a less broken version of java.io.FileWriter, in that unlike the java version you can specify the encoding.

Obtains an OutputStreamWriter wrapped around a FileOutputStream. This should behave like a less broken version of java.io.FileWriter, in that unlike the java version you can specify the encoding.

Inherited methods

def /(child: File): File
Inherited from:
Path
def /(child: Directory): Directory
Inherited from:
Path
def /(child: Path): Path
Inherited from:
Path
def /(child: String): Path

Creates a new Path with the specified path appended. Assumes the type of the new component implies the type of the result.

Creates a new Path with the specified path appended. Assumes the type of the new component implies the type of the result.

Inherited from:
Path
def applyReader[T](f: BufferedReader => T): T

Creates a BufferedReader and applies the closure, automatically closing it on completion.

Creates a BufferedReader and applies the closure, automatically closing it on completion.

Inherited from:
Chars
def bufferedReader(codec: Codec): BufferedReader
Inherited from:
Chars
def bufferedReader(): BufferedReader

Wraps a BufferedReader around the result of reader().

Wraps a BufferedReader around the result of reader().

Inherited from:
Chars
def bytes(): Iterator[Byte]
Inherited from:
Bytes
def bytesAsInts(): Iterator[Int]
Inherited from:
Bytes
def canRead: Boolean
Inherited from:
Path
def canWrite: Boolean
Inherited from:
Path
def changeExtension(ext: String): Path
Inherited from:
Path
def chars(codec: Codec): BufferedSource

Caller is responsible for closing the returned BufferedSource.

Caller is responsible for closing the returned BufferedSource.

Inherited from:
Chars
def createDirectory(force: Boolean, failIfExists: Boolean): Directory
Inherited from:
Path
def createFile(failIfExists: Boolean): File
Inherited from:
Path
def delete(): Unit
Inherited from:
Path
def deleteRecursively(): Boolean

Deletes the path recursively. Returns false on failure. Use with caution!

Deletes the path recursively. Returns false on failure. Use with caution!

Inherited from:
Path
def endsWith(other: Path): Boolean
Inherited from:
Path
override def equals(other: Any): Boolean
Definition Classes
Path -> Any
Inherited from:
Path
def exists: Boolean
Inherited from:
Path
def extension: String
Inherited from:
Path
def hasExtension(ext: String, exts: String*): Boolean
Inherited from:
Path
override def hashCode(): Int
Definition Classes
Path -> Any
Inherited from:
Path
def ifDirectory[T](f: Directory => T): Option[T]
Inherited from:
Path
def ifFile[T](f: File => T): Option[T]
Inherited from:
Path
def isAbsolute: Boolean
Inherited from:
Path
def isDirectory: Boolean
Inherited from:
Path
def isEmpty: Boolean
Inherited from:
Path
def isFile: Boolean
Inherited from:
Path
def isFresher(other: Path): Boolean
Inherited from:
Path
def isSame(other: Path): Boolean
Inherited from:
Path
def lastModified: FileTime
Inherited from:
Path
def lines(codec: Codec): Iterator[String]

Beware! Leaks an InputStream which will not be closed until it gets finalized.

Beware! Leaks an InputStream which will not be closed until it gets finalized.

Inherited from:
Chars
def lines(): Iterator[String]

Beware! Leaks an InputStream which will not be closed until it gets finalized.

Beware! Leaks an InputStream which will not be closed until it gets finalized.

Inherited from:
Chars
def name: String
Inherited from:
Path
def parent: Directory
Returns:

The path of the parent directory, or root if path is already root

Inherited from:
Path
def parents: List[Directory]
Inherited from:
Path
def path: String
Inherited from:
Path
def reader(codec: Codec): InputStreamReader

Obtains an InputStreamReader wrapped around a FileInputStream.

Obtains an InputStreamReader wrapped around a FileInputStream.

Inherited from:
Chars
def relativize(other: Path): Path
Inherited from:
Path
def resolve(other: Path): Path
Inherited from:
Path
def segments: List[String]
Inherited from:
Path
def slurp(codec: Codec): String
Inherited from:
Chars
def slurp(): String

Convenience function to import entire file into a String.

Convenience function to import entire file into a String.

Inherited from:
Chars
def stripExtension: String
Inherited from:
Path
def toAbsoluteWithRoot(root: Path): Path

If this path is absolute, returns it: otherwise, returns an absolute path made up of root / this.

If this path is absolute, returns it: otherwise, returns an absolute path made up of root / this.

Inherited from:
Path
def toByteArray(): Array[Byte]

This method aspires to be the fastest way to read a stream of known length into memory.

This method aspires to be the fastest way to read a stream of known length into memory.

Inherited from:
Bytes
def toCanonical: Path
Inherited from:
Path
override def toString(): String
Definition Classes
Path -> Any
Inherited from:
Path
def toURI: URI
Inherited from:
Path
def toURL: URL
Inherited from:
Path
def truncate(): Boolean
Inherited from:
Path
def walk: Iterator[Path]

Equivalent to walkFilter(_ => true).

Equivalent to walkFilter(_ => true).

Inherited from:
Path

Concrete fields

override val creationCodec: Codec

Inherited fields

val separator: Char
Inherited from:
Path
val separatorStr: String
Inherited from:
Path