File

Value Members

1. def !(implicit codec: Codec): String

   

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

   

   Definition Classes

   AnyRef → Any

3. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

4. def /(f: (File) ⇒ File): File

   

5. def /(child: String): File

   

6. def <(text: String)(implicit codec: Codec): File

   

7. def <<(line: String)(implicit codec: Codec): File

   

8. def =!=(that: File): Boolean

   

9. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

10. def ===(that: File): Boolean

    

11. def >:(text: String)(implicit codec: Codec): File

    

12. def >>:(line: String)(implicit codec: Codec): File

    

13. def addPermission(permission: PosixFilePermission): File

    

14. def append(bytes: Array[Byte]): File

    

15. def append(text: String)(implicit codec: Codec): File

    

16. def appendLine(line: String)(implicit codec: Codec): File

    

17. def appendLines(lines: String*)(implicit codec: Codec): File

    

18. def appendNewLine()(implicit codec: Codec): File

    

19. def apply(permission: PosixFilePermission): Boolean

    

    test if file has this permission

20. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

21. def attributes: BasicFileAttributes

    

22. def bufferedReader(implicit codec: Codec): ManagedResource[BufferedReader]

    

23. def bufferedSource(implicit codec: Codec): ManagedResource[BufferedSource]

    

24. def bufferedWriter(implicit codec: Codec): ManagedResource[BufferedWriter]

    

25. def byteArray: Array[Byte]

    

26. def bytes: Iterator[Byte]

    

27. def changeExtensionTo(extension: String): File

    

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

28. def chars(implicit codec: Codec): Iterator[Char]

    

29. def checksum(algorithm: String): String

    
    returns

    checksum of this file (or directory) in hex format

30. def children: Files

    

31. def clear(): File

    

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

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

    returns

    this

32. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. def contains(file: File): Boolean

    

    Check if this directory contains this file

    Check if this directory contains this file

    returns

    true if this is a directory and it contains this file

34. def contentAsString(implicit codec: Codec): String

    

35. def contentType: Option[String]

    

36. def copyTo(destination: File, overwrite: Boolean = false): File

    
    returns

    destination

37. def createChild(child: String, asDirectory: Boolean = false): File

    

38. def createDirectories(): File

    

39. def createDirectory(): File

    

40. def createIfNotExists(asDirectory: Boolean = false): File

    

41. def delete(ignoreIOExceptions: Boolean = false): File

    

    Deletes this file or directory

    Deletes this file or directory

    ignoreIOExceptions

    If this is set to true, an exception is thrown when delete fails (else it is swallowed)

42. def digest(algorithm: String): Array[Byte]

    

43. def dosAttributes: DosFileAttributes

    

44. def entries: Files

    

45. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

46. def equals(obj: Any): Boolean

    

    Definition Classes

    File → AnyRef → Any

47. def exists: Boolean

    

48. def extension: Option[String]

    
    returns

    extension (including the dot) of this file if it is a regular file and has an extension, else None

49. def fileChannel: ManagedResource[FileChannel]

    

50. def fileReader: ManagedResource[FileReader]

    

51. def fileSystem: FileSystem

    

52. def fileWriter(append: Boolean = false): ManagedResource[FileWriter]

    

53. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

54. def fullPath: String

    

55. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

56. def glob(pattern: String, syntax: String = "glob", ignoreIOExceptions: Boolean = false): Files

    

    Util to glob from this file's path

    Util to glob from this file's path

    ignoreIOExceptions

    when set to true, any file visit exceptions (e.g. a read or permission error) would be silently ignored

    returns

    Set of files that matched

57. def group: GroupPrincipal

    

58. def groupName: String

    

59. def hasExtension: Boolean

    

60. def hashCode(): Int

    

    Definition Classes

    File → AnyRef → Any

61. def inputStream: ManagedResource[InputStream]

    

62. def isChildOf(parent: File): Boolean

    

63. def isDirectory: Boolean

    
    returns

    true if this file (or the file found by following symlink) is a directory

64. def isEmpty: Boolean

    
    returns

    true if file is not present or empty directory or 0-bytes file

65. def isExecutable: Boolean

    

66. def isGroupExecutable: Boolean

    

67. def isGroupReadable: Boolean

    

68. def isGroupWritable: Boolean

    

69. def isHidden: Boolean

    

70. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

71. def isOtherExecutable: Boolean

    

72. def isOtherReadable: Boolean

    

73. def isOtherWritable: Boolean

    

74. def isOwnerExecutable: Boolean

    

75. def isOwnerReadable: Boolean

    

76. def isOwnerWritable: Boolean

    

77. def isParentOf(child: File): Boolean

    

78. def isReadable: Boolean

    

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

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

    See also

    isOwnerReadable

79. def isRegularFile: Boolean

    
    returns

    true if this file (or the file found by following symlink) is a regular file

80. def isSameContentAs(that: File): Boolean

    
    returns

    true if this file is exactly same as that file For directories, it checks for equivalent directory structure

81. def isSameFileAs(that: File): Boolean

    

82. def isSamePathAs(that: File): Boolean

    

83. def isSimilarContentAs(that: File): Boolean

    

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

84. def isSymbolicLink: Boolean

    

85. def isWriteable: Boolean

    

86. def lastModifiedTime: Instant

    

87. def lines(implicit codec: Codec): Iterator[String]

    

88. def linkTo(destination: File, symbolic: Boolean = false): File

    

89. def list: Files

    

90. def listRecursively: Files

    

91. def listRelativePaths: Iterator[Path]

    

92. def loadBytes: Array[Byte]

    

93. def md5: String

    

94. def moveTo(destination: File, overwrite: Boolean = false): File

    
    returns

    destination

95. def name: String

    

96. def nameWithoutExtension: String

    

97. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

98. def newBufferedReader(implicit codec: Codec): BufferedReader

    

99. def newBufferedSource(implicit codec: Codec): BufferedSource

    

100. def newBufferedWriter(implicit codec: Codec): BufferedWriter

     

101. def newFileChannel: FileChannel

     

102. def newFileReader: FileReader

     

103. def newFileWriter(append: Boolean = false): FileWriter

     

104. def newInputStream: InputStream

     

105. def newOutputStream: OutputStream

     

106. def newRandomAccess(mode: String = "r"): RandomAccessFile

     

107. def newScanner(delimiter: String = Scanner.defaultDelimiter, includeDelimiters: Boolean = false)(implicit codec: Codec): Scanner

     

108. def newWatchKey(events: Kind[_]*): WatchKey

     

109. def newWatchService: WatchService

     

110. def notExists: Boolean

     

111. final def notify(): Unit

     

     Definition Classes

     AnyRef

112. final def notifyAll(): Unit

     

     Definition Classes

     AnyRef

113. def outputStream: ManagedResource[OutputStream]

     

114. def overwrite(text: String)(implicit codec: Codec): File

     

115. def owner: UserPrincipal

     

116. def ownerName: String

     

117. def parent: File

     

118. val path: Path

     

119. def permissions: Set[PosixFilePermission]

     

120. def posixAttributes: PosixFileAttributes

     

121. def randomAccess(mode: String = "r"): ManagedResource[RandomAccessFile]

     

122. def relativize(destination: File): Path

     

123. def removePermission(permission: PosixFilePermission): File

     

124. def renameTo(newName: String): File

     

125. def root: File

     

126. def scanner(delimiter: String = Scanner.defaultDelimiter, includeDelimiters: Boolean = false)(implicit codec: Codec): ManagedResource[Scanner]

     

127. def setGroup(group: String): File

     

128. def setOwner(owner: String): File

     

129. def setPermissions(permissions: Set[PosixFilePermission]): File

     

130. def size: Long

     
     returns

     file size (for directories, return size of the directory) in bytes

131. def symbolicLink: Option[File]

     
     returns

     Some(target) if this is a symbolic link (to target) else None

132. def symbolicLinkTo(destination: File): Path

     

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

     

     Definition Classes

     AnyRef

134. def toJava: java.io.File

     

135. def toString(): String

     

     Definition Classes

     File → AnyRef → Any

136. def touch(time: Instant = Instant.now()): File

     

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

137. def unzip(): File

     

     unzip to a temporary zip file

     unzip to a temporary zip file

     returns

     the zip file

138. def unzipTo(destination: File): File

     

     Unzips this zip file

     Unzips this zip file

     destination

     destination folder; Creates this if it does not exist

     returns

     The destination where contents are unzipped

139. def uri: URI

     

140. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

142. final def wait(arg0: Long): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

143. def walk(maxDepth: Int = Int.MaxValue): Files

     

     Walk the directory tree recursively upto maxDepth

     Walk the directory tree recursively upto maxDepth

     returns

     List of children in BFS maxDepth level deep (includes self since self is at depth = 0)

144. def watchService: ManagedResource[WatchService]

     

145. def write(text: String)(implicit codec: Codec): File

     

146. def write(bytes: Array[Byte]): File

     

     Write byte array to file.

     Write byte array to file. For large files, piping in streams is recommended

     returns

     this

147. def zip(): File

     

     zip to a temp directory

     zip to a temp directory

     returns

     the target directory

148. def zipTo(destination: File): File

     

     Zips this file (or directory)

     Zips this file (or directory)

     destination

     The destination file; Creates this if it does not exists

     returns

     The destination zip file