scala.tools.nsc.io

File

class File 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.

Source
File.scala
Since

2.8

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. File
  2. Chars
  3. Bytes
  4. Path
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new File(jfile: JFile)(implicit constructorCodec: Codec)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from File to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (File, B)

    Implicit information
    This member is added by an implicit conversion from File to ArrowAssoc[File] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. def /(child: File): File

    Definition Classes
    Path
  7. def /(child: Directory): Directory

    Definition Classes
    Path
  8. def /(child: Path): Path

    Creates a new Path with the specified path appended.

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

    Definition Classes
    Path
  9. final def ==(arg0: AnyRef): Boolean

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

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

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

    Definition Classes
    Any
  11. def addExtension(ext: String): File

    Definition Classes
    FilePath
  12. def appendAll(strings: String*): Unit

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

    Definition Classes
    Chars
  14. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    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 expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(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 type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  15. def bufferedInput(): BufferedInputStream

    Definition Classes
    Bytes
  16. def bufferedOutput(append: Boolean = false): BufferedOutputStream

  17. def bufferedReader(codec: Codec): BufferedReader

    Definition Classes
    Chars
  18. def bufferedReader(): BufferedReader

    Wraps a BufferedReader around the result of reader().

    Wraps a BufferedReader around the result of reader().

    Definition Classes
    Chars
  19. def bufferedWriter(append: Boolean, codec: Codec): BufferedWriter

  20. def bufferedWriter(append: Boolean): BufferedWriter

  21. def bufferedWriter(): BufferedWriter

    Wraps a BufferedWriter around the result of writer().

  22. def bytes(): Iterator[Byte]

    Definition Classes
    Bytes
  23. def bytesAsInts(): Iterator[Int]

    Definition Classes
    Bytes
  24. def canRead: Boolean

    Definition Classes
    Path
  25. def canWrite: Boolean

    Definition Classes
    Path
  26. def changeExtension(ext: String): Path

    Definition Classes
    Path
  27. def chars(codec: Codec): BufferedSource

    Definition Classes
    Chars
  28. def chars(): BufferedSource

    Definition Classes
    Chars
  29. def clone(): AnyRef

    Create a copy of the receiver object.

    Create 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  30. def copyTo(destPath: Path, preserveFileDate: Boolean = false): Boolean

  31. def createDirectory(force: Boolean = true, failIfExists: Boolean = false): Directory

    Definition Classes
    Path
  32. def createFile(failIfExists: Boolean = false): File

    Definition Classes
    Path
  33. val creationCodec: Codec

    Calls to methods requiring byte<->char transformations should be offered in a form which allows specifying the codec.

    Calls to methods requiring byte<->char transformations should be offered in a form which allows specifying the codec. When it is not specified, the one discovered at creation time will be used, which will always find the one in scala.io.Codec if no other is available. This can be overridden to use a different default.

    Definition Classes
    FileChars
  34. def delete(): Boolean

    Definition Classes
    Path
  35. def deleteIfExists(): Boolean

    Definition Classes
    Path
  36. def deleteRecursively(): Boolean

    Deletes the path recursively.

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

    Definition Classes
    Path
  37. def endsWith(other: Path): Boolean

    Definition Classes
    Path
  38. def ensuring(cond: (File) ⇒ Boolean, msg: ⇒ Any): File

    Implicit information
    This member is added by an implicit conversion from File to Ensuring[File] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  39. def ensuring(cond: (File) ⇒ Boolean): File

    Implicit information
    This member is added by an implicit conversion from File to Ensuring[File] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  40. def ensuring(cond: Boolean, msg: ⇒ Any): File

    Implicit information
    This member is added by an implicit conversion from File to Ensuring[File] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  41. def ensuring(cond: Boolean): File

    Implicit information
    This member is added by an implicit conversion from File to Ensuring[File] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  42. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional 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).

    returns

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

    Definition Classes
    AnyRef
  43. def equals(other: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in Any.

    returns

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

    Definition Classes
    Path → AnyRef → Any
  44. def exists: Boolean

    Definition Classes
    Path
  45. def extension: String

    Definition Classes
    Path
  46. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  47. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from File to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  48. final def getClass(): Class[_]

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

    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.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  49. def hasExtension(ext: String, exts: String*): Boolean

    Definition Classes
    Path
  50. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

    Definition Classes
    Path → AnyRef → Any
  51. def ifDirectory[T](f: (Directory) ⇒ T): Option[T]

    Definition Classes
    Path
  52. def ifFile[T](f: (File) ⇒ T): Option[T]

    Definition Classes
    Path
  53. def inputStream(): FileInputStream

    Obtains an InputStream.

    Obtains an InputStream.

    Definition Classes
    FileBytes
  54. def isAbsolute: Boolean

    Definition Classes
    Path
  55. def isDirectory: Boolean

    Definition Classes
    Path
  56. def isEmpty: Boolean

    Definition Classes
    Path
  57. def isFile: Boolean

    Definition Classes
    Path
  58. def isFresher(other: Path): Boolean

    Definition Classes
    Path
  59. def isHidden: Boolean

    Definition Classes
    Path
  60. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.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 specified type.

    returns

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

    Definition Classes
    Any
  61. def isRootPath: Boolean

    Definition Classes
    Path
  62. def isSame(other: Path): Boolean

    Definition Classes
    Path
  63. def isValid: Boolean

    Definition Classes
    FilePath
  64. def lastModified: Long

    Definition Classes
    Path
  65. def lastModified_=(time: Long): Boolean

    Definition Classes
    Path
  66. def length: Long

    Definition Classes
    FileBytesPath
  67. def lines(codec: Codec): Iterator[String]

    Definition Classes
    Chars
  68. def lines(): Iterator[String]

    Definition Classes
    Chars
  69. def name: String

    Definition Classes
    Path
  70. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

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

    Definition Classes
    AnyRef
  71. def normalize: File

    Definition Classes
    FilePath
  72. def notExists: Boolean

    Definition Classes
    Path
  73. final 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.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  74. final 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.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  75. def outputStream(append: Boolean = false): FileOutputStream

    Obtains a OutputStream.

  76. def parent: Directory

    returns

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

    Definition Classes
    Path
  77. def parents: List[Directory]

    Definition Classes
    Path
  78. def path: String

    Definition Classes
    Path
  79. def printStream(append: Boolean = false): PrintStream

  80. def printWriter(append: Boolean): PrintWriter

  81. def printWriter(): PrintWriter

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

  83. def reader(codec: Codec): InputStreamReader

    Definition Classes
    Chars
  84. def reader(): InputStreamReader

    Obtains an InputStreamReader wrapped around a FileInputStream.

    Obtains an InputStreamReader wrapped around a FileInputStream.

    Definition Classes
    Chars
  85. def relativize(other: Path): Path

    Definition Classes
    Path
  86. def resolve(other: Path): Path

    Definition Classes
    Path
  87. def root: Option[Path]

    Definition Classes
    Path
  88. def safeSlurp(): Option[String]

  89. def segments: List[String]

    Definition Classes
    Path
  90. val separator: Char

    Definition Classes
    Path
  91. val separatorStr: String

    Definition Classes
    Path
  92. def setExecutable(executable: Boolean, ownerOnly: Boolean = true): Boolean

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

  93. def slurp(codec: Codec): String

    Definition Classes
    Chars
  94. def slurp(): String

    Convenience function to import entire file into a String.

    Convenience function to import entire file into a String.

    Definition Classes
    Chars
  95. def startsWith(other: Path): Boolean

    Definition Classes
    Path
  96. def stripExtension: String

    Definition Classes
    Path
  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  98. def toAbsolute: File

    Definition Classes
    FilePath
  99. 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.

    Definition Classes
    Path
  100. 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.

    Definition Classes
    Bytes
  101. def toCanonical: Path

    Definition Classes
    Path
  102. def toDirectory: Directory

    Definition Classes
    FilePath
  103. def toFile: File

    Definition Classes
    FilePath
  104. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    Path → AnyRef → Any
  105. def toURI: URI

    Definition Classes
    Path
  106. def toURL: URL

    Definition Classes
    Path
  107. def touch(modTime: Long = System.currentTimeMillis): AnyVal

    Definition Classes
    Path
  108. def truncate(): Boolean

    Definition Classes
    Path
  109. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  112. def walk: Iterator[Path]

    Equivalent to walkFilter(_ => false).

    Equivalent to walkFilter(_ => false).

    Definition Classes
    Path
  113. def walkFilter(cond: (Path) ⇒ Boolean): Iterator[Path]

    If this path is a container, recursively iterate over its contents.

    If this path is a container, recursively iterate over its contents. The supplied condition is a filter which is applied to each element, with that branch of the tree being closed off if it is true. So for example if the condition is true for some subdirectory, nothing under that directory will be in the Iterator; but otherwise each file and subdirectory underneath it will appear.

    Definition Classes
    FilePath
  114. def withCodec(codec: Codec): File

  115. def writeAll(strings: String*): Unit

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

  116. def writeBytes(bytes: Array[Byte]): Unit

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

  118. def writer(append: Boolean): OutputStreamWriter

  119. def writer(): OutputStreamWriter

    Obtains an OutputStreamWriter wrapped around a FileOutputStream.

    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.

  120. def [B](y: B): (File, B)

    Implicit information
    This member is added by an implicit conversion from File to ArrowAssoc[File] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from File to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (file: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from File to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (file: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: File

    Implicit information
    This member is added by an implicit conversion from File to ArrowAssoc[File] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (file: ArrowAssoc[File]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: File

    Implicit information
    This member is added by an implicit conversion from File to Ensuring[File] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (file: Ensuring[File]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Chars

Inherited from Bytes

Inherited from Path

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from File to StringAdd

Inherited by implicit conversion any2stringfmt from File to StringFormat

Inherited by implicit conversion any2ArrowAssoc from File to ArrowAssoc[File]

Inherited by implicit conversion any2Ensuring from File to Ensuring[File]