scala3-compiler-bootstrapped
DocsAPI
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.io/PlainFile

PlainFile

dotty.tools.io.PlainFile
See thePlainFile companion object
class PlainFile(val givenPath: Path) extends AbstractFile

This class implements an abstract file backed by a File.

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

Attributes

Companion
object
Graph
Supertypes
class AbstractFile
class Object
trait Matchable
class Any
Show all
Known subtypes
class JarArchive

Members list

Value members

Concrete methods

def absolute: PlainFile

The absolute file.

The absolute file.

Attributes

override def container: AbstractFile

Returns the containing directory of this abstract file

Returns the containing directory of this abstract file

Attributes

Definition Classes
def create(): Unit

Does this abstract file denote an existing file?

Does this abstract file denote an existing file?

Attributes

def delete(): Unit

Delete the underlying file or directory (recursively).

Delete the underlying file or directory (recursively).

Attributes

override def equals(that: Any): Boolean

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

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

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

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

Definition Classes
Any
override def hashCode(): Int

Calculates a hash code value for the object.

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

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
override def input: InputStream

returns an input stream so the file can be read

returns an input stream so the file can be read

Attributes

Definition Classes
def isDirectory: Boolean

Is this abstract file a directory?

Is this abstract file a directory?

Attributes

def iterator: Iterator[AbstractFile]

Returns all abstract subfiles of this abstract directory.

Returns all abstract subfiles of this abstract directory.

Attributes

def jpath: JPath

Returns the underlying Path if any and null otherwise.

Returns the underlying Path if any and null otherwise.

Attributes

def lastModified: Long

Returns the time that this abstract file was last modified.

Returns the time that this abstract file was last modified.

Attributes

def lookupName(name: String, directory: Boolean): AbstractFile

Returns the abstract file in this abstract directory with the specified name. If there is no such file, returns null. The argument "directory" tells whether to look for a directory or or a regular file.

Returns the abstract file in this abstract directory with the specified name. If there is no such file, returns null. The argument "directory" tells whether to look for a directory or or a regular file.

Attributes

def lookupNameUnchecked(name: String, directory: Boolean): AbstractFile

Returns a plain file with the given name. It does not check that it exists.

Returns a plain file with the given name. It does not check that it exists.

Attributes

def name: String

Returns the name of this abstract file.

Returns the name of this abstract file.

Attributes

override def output: OutputStream

Returns an output stream for writing the file

Returns an output stream for writing the file

Attributes

Definition Classes
def path: String

Returns the path of this abstract file.

Returns the path of this abstract file.

Attributes

override def sizeOption: Option[Int]

size of this file if it is a concrete file.

size of this file if it is a concrete file.

Attributes

Definition Classes
override def underlyingSource: Option[AbstractFile]

An underlying source, if known. Mostly, a zip/jar file.

An underlying source, if known. Mostly, a zip/jar file.

Attributes

Definition Classes

Inherited methods

final def ++[B >: AbstractFile](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
final def addString(b: StringBuilder): b.type

Attributes

Inherited from:
IterableOnceOps
final def addString(b: StringBuilder, sep: String): b.type

Attributes

Inherited from:
IterableOnceOps
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

Attributes

Inherited from:
IterableOnceOps
def bufferedOutput: BufferedOutputStream

Returns a buffered output stream for writing the file - defaults to out

Returns a buffered output stream for writing the file - defaults to out

Attributes

Inherited from:
AbstractFile
def canonicalPath: String

Returns the path of this abstract file in a canonical form.

Returns the path of this abstract file in a canonical form.

Attributes

Inherited from:
AbstractFile
def collect[B](pf: PartialFunction[AbstractFile, B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def collectFirst[B](pf: PartialFunction[AbstractFile, B]): Option[B]

Attributes

Inherited from:
IterableOnceOps
def concat[B >: AbstractFile](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def copyToArray[B >: AbstractFile](xs: Array[B], start: Int, len: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: AbstractFile](xs: Array[B], start: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: AbstractFile](xs: Array[B]): Int

Attributes

Inherited from:
IterableOnceOps
def corresponds[B](that: IterableOnce[B])(p: (AbstractFile, B) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def count(p: AbstractFile => Boolean): Int

Attributes

Inherited from:
IterableOnceOps
def drop(n: Int): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def dropRight(n: Int): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def dropWhile(p: AbstractFile => Boolean): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
override def empty: Iterable[AbstractFile]

Attributes

Definition Classes
Inherited from:
IterableFactoryDefaults
def exists: Boolean

Does this abstract file denote an existing file?

Does this abstract file denote an existing file?

Attributes

Inherited from:
AbstractFile
def exists(p: AbstractFile => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def file: JFile

Returns the underlying File if any and null otherwise.

Returns the underlying File if any and null otherwise.

Attributes

Inherited from:
AbstractFile
def fileNamed(name: String): AbstractFile

Get the file in this directory with the given name, creating an empty file if it does not already existing.

Get the file in this directory with the given name, creating an empty file if it does not already existing.

Attributes

Inherited from:
AbstractFile
def filter(pred: AbstractFile => Boolean): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def filterNot(pred: AbstractFile => Boolean): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def find(p: AbstractFile => Boolean): Option[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def flatMap[B](f: AbstractFile => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def flatten[B](implicit asIterable: AbstractFile => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def fold[A1 >: AbstractFile](z: A1)(op: (A1, A1) => A1): A1

Attributes

Inherited from:
IterableOnceOps
def foldLeft[B](z: B)(op: (B, AbstractFile) => B): B

Attributes

Inherited from:
IterableOnceOps
def foldRight[B](z: B)(op: (AbstractFile, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def forall(p: AbstractFile => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def foreach[U](f: AbstractFile => U): Unit

Attributes

Inherited from:
IterableOnceOps
def groupBy[K](f: AbstractFile => K): Map[K, Iterable[AbstractFile]]

Attributes

Inherited from:
IterableOps
def groupMap[K, B](key: AbstractFile => K)(f: AbstractFile => B): Map[K, Iterable[B]]

Attributes

Inherited from:
IterableOps
def groupMapReduce[K, B](key: AbstractFile => K)(f: AbstractFile => B)(reduce: (B, B) => B): Map[K, B]

Attributes

Inherited from:
IterableOps
def grouped(size: Int): Iterator[Iterable[AbstractFile]]

Attributes

Inherited from:
IterableOps
def head: AbstractFile

Attributes

Inherited from:
IterableOps
def headOption: Option[AbstractFile]

Attributes

Inherited from:
IterableOps
def init: Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def inits: Iterator[Iterable[AbstractFile]]

Attributes

Inherited from:
IterableOps
def isClassContainer: Boolean

Does this abstract file represent something which can contain classfiles?

Does this abstract file represent something which can contain classfiles?

Attributes

Inherited from:
AbstractFile
def isEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
override def isTraversableAgain: Boolean

Attributes

Definition Classes
Inherited from:
IterableOps
def isVirtual: Boolean

Does this abstract file correspond to something on-disk?

Does this abstract file correspond to something on-disk?

Attributes

Inherited from:
AbstractFile
def iterableFactory: IterableFactory[Iterable]

Attributes

Inherited from:
Iterable
def knownSize: Int

Attributes

Inherited from:
IterableOnce
def last: AbstractFile

Attributes

Inherited from:
IterableOps
def lastOption: Option[AbstractFile]

Attributes

Inherited from:
IterableOps
def lazyZip[B](that: Iterable[B]): LazyZip2[AbstractFile, B, Iterable.this.type]

Attributes

Inherited from:
Iterable
final def lookupPath(parts: Seq[String], directory: Boolean): AbstractFile

Drill down through subdirs looking for the target, as in lookupName. Ths target name is the last of parts.

Drill down through subdirs looking for the target, as in lookupName. Ths target name is the last of parts.

Attributes

Inherited from:
AbstractFile
def lookupPathUnchecked(path: String, directory: Boolean): AbstractFile

Return an abstract file that does not check that path denotes an existing file.

Return an abstract file that does not check that path denotes an existing file.

Attributes

Inherited from:
AbstractFile
def map[B](f: AbstractFile => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def max[B >: AbstractFile](implicit ord: Ordering[B]): AbstractFile

Attributes

Inherited from:
IterableOnceOps
def maxBy[B](f: AbstractFile => B)(implicit ord: Ordering[B]): AbstractFile

Attributes

Inherited from:
IterableOnceOps
def maxByOption[B](f: AbstractFile => B)(implicit ord: Ordering[B]): Option[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def maxOption[B >: AbstractFile](implicit ord: Ordering[B]): Option[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def min[B >: AbstractFile](implicit ord: Ordering[B]): AbstractFile

Attributes

Inherited from:
IterableOnceOps
def minBy[B](f: AbstractFile => B)(implicit ord: Ordering[B]): AbstractFile

Attributes

Inherited from:
IterableOnceOps
def minByOption[B](f: AbstractFile => B)(implicit ord: Ordering[B]): Option[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def minOption[B >: AbstractFile](implicit ord: Ordering[B]): Option[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
final def mkString: String

Attributes

Inherited from:
IterableOnceOps
final def mkString(sep: String): String

Attributes

Inherited from:
IterableOnceOps
final def mkString(start: String, sep: String, end: String): String

Attributes

Inherited from:
IterableOnceOps
def nonEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
def partitionMap[A1, A2](f: AbstractFile => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def product[B >: AbstractFile](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def reduce[B >: AbstractFile](op: (B, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeft[B >: AbstractFile](op: (B, AbstractFile) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeftOption[B >: AbstractFile](op: (B, AbstractFile) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceOption[B >: AbstractFile](op: (B, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceRight[B >: AbstractFile](op: (AbstractFile, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceRightOption[B >: AbstractFile](op: (AbstractFile, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
final def resolveSibling(name: String): AbstractFile | Null

Returns the sibling abstract file in the parent of this abstract file or directory. If there is no such file, returns null.

Returns the sibling abstract file in the parent of this abstract file or directory. If there is no such file, returns null.

Attributes

Inherited from:
AbstractFile
final def resolveSiblingWithExtension(extension: FileExtension): AbstractFile | Null

Attributes

Inherited from:
AbstractFile
protected def reversed: Iterable[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def scan[B >: AbstractFile](z: B)(op: (B, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def scanLeft[B](z: B)(op: (B, AbstractFile) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def scanRight[B](z: B)(op: (AbstractFile, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def size: Int

Attributes

Inherited from:
IterableOnceOps
def sizeCompare(that: Iterable[_]): Int

Attributes

Inherited from:
IterableOps
def sizeCompare(otherSize: Int): Int

Attributes

Inherited from:
IterableOps
final def sizeIs: SizeCompareOps

Attributes

Inherited from:
IterableOps
def slice(from: Int, until: Int): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def sliding(size: Int, step: Int): Iterator[Iterable[AbstractFile]]

Attributes

Inherited from:
IterableOps
def sliding(size: Int): Iterator[Iterable[AbstractFile]]

Attributes

Inherited from:
IterableOps
def span(p: AbstractFile => Boolean): (Iterable[AbstractFile], Iterable[AbstractFile])

Attributes

Inherited from:
IterableOps
override def splitAt(n: Int): (Iterable[AbstractFile], Iterable[AbstractFile])

Attributes

Definition Classes
Inherited from:
IterableOps
def stepper[S <: Stepper[_]](implicit shape: StepperShape[AbstractFile, S]): S

Attributes

Inherited from:
IterableOnce
def subdirectoryNamed(name: String): AbstractFile

Get the subdirectory with a given name, creating it if it does not already exist.

Get the subdirectory with a given name, creating it if it does not already exist.

Attributes

Inherited from:
AbstractFile
def sum[B >: AbstractFile](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def tail: Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def tails: Iterator[Iterable[AbstractFile]]

Attributes

Inherited from:
IterableOps
def take(n: Int): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def takeRight(n: Int): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
def takeWhile(p: AbstractFile => Boolean): Iterable[AbstractFile]

Attributes

Inherited from:
IterableOps
override def tapEach[U](f: AbstractFile => U): Iterable[AbstractFile]

Attributes

Definition Classes
Inherited from:
IterableOps
def to[C1](factory: Factory[AbstractFile, C1]): C1

Attributes

Inherited from:
IterableOnceOps
def toArray[B >: AbstractFile : ClassTag]: Array[B]

Attributes

Inherited from:
IterableOnceOps
final def toBuffer[B >: AbstractFile]: Buffer[B]

Attributes

Inherited from:
IterableOnceOps
def toByteArray: Array[Byte]

Returns contents of file (if applicable) in a byte array.

Returns contents of file (if applicable) in a byte array.

Attributes

Inherited from:
AbstractFile
def toCharArray: Array[Char]

Returns contents of file (if applicable) in a Char array. warning: use Global.getSourceFile() to use the proper encoding when converting to the char array.

Returns contents of file (if applicable) in a Char array. warning: use Global.getSourceFile() to use the proper encoding when converting to the char array.

Attributes

Inherited from:
AbstractFile
def toIndexedSeq: IndexedSeq[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def toList: List[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def toMap[K, V](implicit ev: AbstractFile <:< (K, V)): Map[K, V]

Attributes

Inherited from:
IterableOnceOps
def toSeq: Seq[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def toSet[B >: AbstractFile]: Set[B]

Attributes

Inherited from:
IterableOnceOps
override def toString(): String

Returns the path of this abstract file.

Returns the path of this abstract file.

Attributes

Definition Classes
Inherited from:
AbstractFile
def toURL: URL

Attributes

Inherited from:
AbstractFile
def toVector: Vector[AbstractFile]

Attributes

Inherited from:
IterableOnceOps
def transpose[B](implicit asIterable: AbstractFile => Iterable[B]): Iterable[Iterable[B]]

Attributes

Inherited from:
IterableOps
def unzip[A1, A2](implicit asPair: AbstractFile => (A1, A2)): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def unzip3[A1, A2, A3](implicit asTriple: AbstractFile => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

Attributes

Inherited from:
IterableOps
def view: View[AbstractFile]

Attributes

Inherited from:
IterableOps
def withFilter(p: AbstractFile => Boolean): WithFilter[AbstractFile, Iterable]

Attributes

Inherited from:
IterableOps
def zip[B](that: IterableOnce[B]): Iterable[(AbstractFile, B)]

Attributes

Inherited from:
IterableOps
def zipAll[A1 >: AbstractFile, B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

Attributes

Inherited from:
IterableOps
def zipWithIndex: Iterable[(AbstractFile, Int)]

Attributes

Inherited from:
IterableOps

Deprecated and Inherited methods

def ++:[B >: AbstractFile](that: IterableOnce[B]): Iterable[B]

Attributes

Deprecated
[Since version 2.13.0] Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
final def /:[B](z: B)(op: (B, AbstractFile) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
final def :\[B](z: B)(op: (AbstractFile, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
def aggregate[B](z: => B)(seqop: (B, AbstractFile) => B, combop: (B, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] `aggregate` is not relevant for sequential collections. Use `foldLeft(z)(seqop)` instead.
Inherited from:
IterableOnceOps
def companion: IterableFactory[Iterable]

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
final def copyToBuffer[B >: AbstractFile](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
def extension: String

Returns the extension of this abstract file as a String.

Returns the extension of this abstract file as a String.

Attributes

Deprecated
true
Inherited from:
AbstractFile
def hasDefiniteSize: Boolean

Attributes

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
Inherited from:
IterableOnceOps
def hasExtension(other: String): Boolean

Checks extension case insensitively.

Checks extension case insensitively.

Attributes

Deprecated
true
Inherited from:
AbstractFile
final def repr: Iterable[AbstractFile]

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
def seq: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.0] Iterable.seq always returns the iterable itself
Inherited from:
Iterable
final def toIterable: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
final def toIterator: Iterator[AbstractFile]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
final def toStream: Stream[AbstractFile]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
final def toTraversable: Iterable[AbstractFile]

Attributes

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
def view(from: Int, until: Int): View[AbstractFile]

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps

Concrete fields

override val absolutePath: String

Returns the absolute path of this abstract file as an interned string.

Returns the absolute path of this abstract file as an interned string.

Attributes

Inherited fields

val ext: FileExtension

Returns the extension of this abstract file.

Returns the extension of this abstract file.

Attributes

Inherited from:
AbstractFile
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL