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 /(child: String): File

   

5. def <(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.default, codec: Codec): File.this.type

   

6. def <<(line: String)(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File.this.type

   

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

   

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

   

   Definition Classes

   AnyRef → Any

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

   

10. def >:(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.default, codec: Codec): File.this.type

    

11. def >>:(line: String)(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File.this.type

    

12. def addPermission(permission: PosixFilePermission)(implicit linkOptions: LinkOptions = File.LinkOptions.default): File.this.type

    

13. def append(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File.this.type

    

14. def appendByteArray(bytes: Array[Byte])(implicit openOptions: OpenOptions = File.OpenOptions.append): File.this.type

    

15. def appendBytes(bytes: Iterator[Byte])(implicit openOptions: OpenOptions = File.OpenOptions.append): File.this.type

    

16. def appendLine(line: String = "")(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File.this.type

    

17. def appendLines(lines: String*)(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File.this.type

    

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

18. def appendText(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File.this.type

    

19. def apply(permission: PosixFilePermission)(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

    test if file has this permission

20. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

21. def asynchronousFileChannel(implicit openOptions: OpenOptions = File.OpenOptions.default): ManagedResource[AsynchronousFileChannel]

    

22. def attributes(implicit linkOptions: LinkOptions = File.LinkOptions.default): BasicFileAttributes

    

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

    

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

    

25. def bufferedWriter(implicit codec: Codec, openOptions: OpenOptions = File.OpenOptions.default): ManagedResource[BufferedWriter]

    

26. def byteArray: Array[Byte]

    

27. def bytes: Iterator[Byte]

    

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

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

    

30. def checksum(algorithm: String): String

    
    returns

    checksum of this file (or directory) in hex format

31. def children: Files

    

32. def clear(): File.this.type

    

    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

33. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34. def collectChildren(matchFilter: (File) ⇒ Boolean)(implicit visitOptions: VisitOptions = File.VisitOptions.default): Files

    

    More Scala friendly way of doing Files.walk

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

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

    

37. def contentType: Option[String]

    

38. def copyTo(destination: File, overwrite: Boolean = false)(implicit copyOptions: CopyOptions = File.CopyOptions(overwrite)): destination.type

    
    returns

    destination

39. def createChild(child: String, asDirectory: Boolean = false)(implicit attributes: Attributes = File.Attributes.default, linkOptions: LinkOptions = File.LinkOptions.default): File

    

40. def createDirectories()(implicit attributes: Attributes = File.Attributes.default): File.this.type

    

41. def createDirectory()(implicit attributes: Attributes = File.Attributes.default): File.this.type

    

42. def createIfNotExists(asDirectory: Boolean = false, createParents: Boolean = false)(implicit attributes: Attributes = File.Attributes.default, linkOptions: LinkOptions = File.LinkOptions.default): File.this.type

    

    Create this file.

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

    asDirectory

    If you want this file to be created as a directory instead, set this to true (false by default)

    createParents

    If you also want all the parents to be created from root to this file (false by defailt)

43. def delete(swallowIOExceptions: Boolean = false): File.this.type

    

    Deletes this file or directory

    Deletes this file or directory

    swallowIOExceptions

    If this is set to true, any exception thrown is swallowed

44. def digest(algorithmName: String): Array[Byte]

    

45. def dosAttributes(implicit linkOptions: LinkOptions = File.LinkOptions.default): DosFileAttributes

    

46. def entries: Files

    

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

    

    Definition Classes

    AnyRef

48. def equals(obj: Any): Boolean

    

    Definition Classes

    File → AnyRef → Any

49. def exists(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

50. def extension(includeDot: Boolean = true, includeAll: Boolean = false, toLowerCase: Boolean = true): Option[String]

    
    includeDot

    whether the dot should be included in the extension or not

    includeAll

    whether all extension tokens should be included, or just the last one e.g. for bundle.tar.gz should it be .tar.gz or .gz

    toLowerCase

    to lowercase the extension or not e.g. foo.HTML should have .html or .HTML

    returns

    extension of this file if it is a regular file and has an extension, else None

51. def extension: Option[String]

    
    returns

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

52. def fileChannel(implicit openOptions: OpenOptions = File.OpenOptions.default, attributes: Attributes = File.Attributes.default): ManagedResource[FileChannel]

    

53. def fileReader: ManagedResource[FileReader]

    

54. def fileSystem: FileSystem

    

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

    

56. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

58. def glob(pattern: String)(implicit syntax: PathMatcherSyntax = File.PathMatcherSyntax.default, visitOptions: VisitOptions = File.VisitOptions.default): Files

    

    Util to glob from this file's path

    Util to glob from this file's path

    returns

    Set of files that matched

59. def group(implicit linkOptions: LinkOptions = File.LinkOptions.default): GroupPrincipal

    

60. def groupName(implicit linkOptions: LinkOptions = File.LinkOptions.default): String

    

61. def hasExtension: Boolean

    

    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

62. def hashCode(): Int

    

    Definition Classes

    File → AnyRef → Any

63. def inputStream(implicit openOptions: OpenOptions = File.OpenOptions.default): ManagedResource[InputStream]

    

64. def isChildOf(parent: File): Boolean

    

65. def isDirectory(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    
    returns

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

66. def isEmpty: Boolean

    
    returns

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

67. def isExecutable: Boolean

    

68. def isGroupExecutable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

69. def isGroupReadable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

70. def isGroupWritable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

71. def isHidden: Boolean

    

72. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

73. def isLocked(mode: RandomAccessMode, position: Long = 0L, size: Long = Long.MaxValue, isShared: Boolean = false): Boolean

    

74. def isOtherExecutable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

75. def isOtherReadable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

76. def isOtherWritable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

77. def isOwnerExecutable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

78. def isOwnerReadable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

79. def isOwnerWritable(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

80. def isParentOf(child: File): Boolean

    

81. def isReadLocked(position: Long = 0L, size: Long = Long.MaxValue, isShared: Boolean = false): Boolean

    

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

83. def isRegularFile(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    
    returns

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

84. def isSameContentAs(that: File): Boolean

    
    returns

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

85. def isSameFileAs(that: File): Boolean

    

86. def isSamePathAs(that: File): Boolean

    

87. def isSiblingOf(sibling: File): Boolean

    

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

89. def isSymbolicLink: Boolean

    

90. def isWriteLocked(position: Long = 0L, size: Long = Long.MaxValue, isShared: Boolean = false): Boolean

    

91. def isWriteable: Boolean

    

92. def lastModifiedTime(implicit linkOptions: LinkOptions = File.LinkOptions.default): Instant

    

93. def lineIterator(implicit codec: Codec): Iterator[String]

    

    Iterate over lines in a file (auto-close stream on complete) NOTE: If the iteration is partial, it may leave a stream open If you want partial iteration use @see lines()

94. def lines(implicit codec: Codec): Traversable[String]

    

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

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

    returns

    all lines in this file

95. def linkTo(destination: File, symbolic: Boolean = false)(implicit attributes: Attributes = File.Attributes.default): destination.type

    

96. def list: Files

    

97. def listRecursively(implicit visitOptions: VisitOptions = File.VisitOptions.default): Files

    

98. def listRelativePaths(implicit visitOptions: VisitOptions = File.VisitOptions.default): Iterator[Path]

    

99. def loadBytes: Array[Byte]

    

100. def md5: String

     

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

     
     returns

     destination

102. def name: String

     

     Name of file Certain files may not have a name e.g.

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

103. def nameOption: Option[String]

     

     Certain files may not have a name e.g.

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

104. def nameWithoutExtension: String

     

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

     

     Definition Classes

     AnyRef

106. def newAsynchronousFileChannel(implicit openOptions: OpenOptions = File.OpenOptions.default): AsynchronousFileChannel

     

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

     

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

     

109. def newBufferedWriter(implicit codec: Codec, openOptions: OpenOptions = File.OpenOptions.default): BufferedWriter

     

110. def newFileChannel(implicit openOptions: OpenOptions = File.OpenOptions.default, attributes: Attributes = File.Attributes.default): FileChannel

     

111. def newFileReader: FileReader

     

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

     

113. def newInputStream(implicit openOptions: OpenOptions = File.OpenOptions.default): InputStream

     

114. def newOutputStream(implicit openOptions: OpenOptions = File.OpenOptions.default): OutputStream

     

115. def newPrintWriter(autoFlush: Boolean = false)(implicit openOptions: OpenOptions = File.OpenOptions.default): PrintWriter

     

116. def newRandomAccess(mode: RandomAccessMode = File.RandomAccessMode.read): RandomAccessFile

     

117. def newScanner(implicit config: Config = Scanner.Config.default): Scanner

     

118. def newWatchService: WatchService

     

119. def notExists(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

     

120. final def notify(): Unit

     

     Definition Classes

     AnyRef

121. final def notifyAll(): Unit

     

     Definition Classes

     AnyRef

122. def outputStream(implicit openOptions: OpenOptions = File.OpenOptions.default): ManagedResource[OutputStream]

     

123. def overwrite(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.default, codec: Codec): File.this.type

     

124. def owner(implicit linkOptions: LinkOptions = File.LinkOptions.default): UserPrincipal

     

125. def ownerName(implicit linkOptions: LinkOptions = File.LinkOptions.default): String

     

126. def parent: File

     

     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

     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

     See also

     parentOption

127. def parentOption: Option[File]

     
     returns

     Some(parent) of this file or None if this is the root and thus has no parent

128. val path: Path

     

129. def pathAsString: String

     

130. def pathMatcher(syntax: PathMatcherSyntax)(pattern: String): PathMatcher

     

131. def permissions(implicit linkOptions: LinkOptions = File.LinkOptions.default): Set[PosixFilePermission]

     

132. def permissionsAsString(implicit linkOptions: LinkOptions = File.LinkOptions.default): String

     

133. def posixAttributes(implicit linkOptions: LinkOptions = File.LinkOptions.default): PosixFileAttributes

     

134. def printLines(lines: Iterator[Any])(implicit openOptions: OpenOptions = File.OpenOptions.append): File.this.type

     

135. def printWriter(autoFlush: Boolean = false)(implicit openOptions: OpenOptions = File.OpenOptions.default): ManagedResource[PrintWriter]

     

136. def randomAccess(mode: RandomAccessMode = File.RandomAccessMode.read): ManagedResource[RandomAccessFile]

     

137. def register(service: WatchService, events: Events = File.Events.all): File.this.type

     

138. def relativize(destination: File): Path

     

139. def removePermission(permission: PosixFilePermission)(implicit linkOptions: LinkOptions = File.LinkOptions.default): File.this.type

     

140. def renameTo(newName: String): File

     

141. def root: File

     

142. def scanner(implicit config: Config = Scanner.Config.default): ManagedResource[Scanner]

     

143. def setGroup(group: String): File.this.type

     

144. def setOwner(owner: String): File.this.type

     

145. def setPermissions(permissions: Set[PosixFilePermission]): File.this.type

     

146. def sha1: String

     

147. def sha256: String

     

148. def sha512: String

     

149. def sibling(name: String): File

     

150. def siblings: Files

     

151. def size(implicit visitOptions: VisitOptions = File.VisitOptions.default): Long

     
     returns

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

152. def symbolicLink: Option[File]

     
     returns

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

153. def symbolicLinkTo(destination: File)(implicit attributes: Attributes = File.Attributes.default): destination.type

     

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

     

     Definition Classes

     AnyRef

155. def toJava: java.io.File

     

156. def toString(): String

     

     Definition Classes

     File → AnyRef → Any

157. def tokens(implicit config: Config = Scanner.Config.default, codec: Codec): Traversable[String]

     

158. def touch(time: Instant = Instant.now())(implicit attributes: Attributes = File.Attributes.default, linkOptions: LinkOptions = File.LinkOptions.default): File.this.type

     

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

159. def unzip()(implicit codec: Codec): File

     

     unzip to a temporary zip file

     unzip to a temporary zip file

     returns

     the zip file

160. def unzipTo(destination: File)(implicit codec: Codec): destination.type

     

     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

161. def uri: URI

     

162. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

165. def walk(maxDepth: Int = Int.MaxValue)(implicit visitOptions: VisitOptions = File.VisitOptions.default): 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)

166. def watchService: ManagedResource[WatchService]

     

167. def write(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.default, codec: Codec): File.this.type

     

168. def writeByteArray(bytes: Array[Byte])(implicit openOptions: OpenOptions = File.OpenOptions.default): File.this.type

     

     Write byte array to file.

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

     returns

     this

169. def writeBytes(bytes: Iterator[Byte])(implicit openOptions: OpenOptions = File.OpenOptions.default): File.this.type

     

170. def writeText(text: String)(implicit openOptions: OpenOptions = File.OpenOptions.default, codec: Codec): File.this.type

     

171. def zip(compressionLevel: Int = Deflater.DEFAULT_COMPRESSION)(implicit codec: Codec): File

     

     zip to a temp directory

     zip to a temp directory

     returns

     the target directory

172. def zipTo(destination: File, compressionLevel: Int = Deflater.DEFAULT_COMPRESSION)(implicit codec: Codec): destination.type

     

     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