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

   

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

   

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

    

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

    

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

    

13. def append(bytes: Array[Byte])(implicit openOptions: OpenOptions): File

    

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

    

15. def appendLine(line: String)(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File

    

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

    

17. def appendNewLine()(implicit openOptions: OpenOptions = File.OpenOptions.append, codec: Codec): File

    

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

    

    test if file has this permission

19. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

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

    

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

    

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

    

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

    

24. def bufferedWriter(implicit codec: Codec, openOptions: OpenOptions = File.OpenOptions.default): 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 collectChildren(f: (File) ⇒ Boolean): Files

    

    More Scala friendly way of doing Files.walk

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

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

    

36. def contentType: Option[String]

    

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

    
    returns

    destination

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

    

39. def createDirectories()(implicit attributes: Attributes = File.Attributes.default): File

    

40. def createDirectory()(implicit attributes: Attributes = File.Attributes.default): File

    

41. def createIfNotExists(asDirectory: Boolean = false)(implicit attributes: Attributes = File.Attributes.default): File

    

42. def delete(swallowIOExceptions: Boolean = false): File

    

    Deletes this file or directory

    Deletes this file or directory

    swallowIOExceptions

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

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

    

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

    

45. def entries: Files

    

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

    

    Definition Classes

    AnyRef

47. def equals(obj: Any): Boolean

    

    Definition Classes

    File → AnyRef → Any

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

    

49. def extension: Option[String]

    
    returns

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

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

    

51. def fileReader: ManagedResource[FileReader]

    

52. def fileSystem: FileSystem

    

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

    

54. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

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

    

    Util to glob from this file's path

    Util to glob from this file's path

    returns

    Set of files that matched

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

    

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

    

59. def hasExtension: Boolean

    

60. def hashCode(): Int

    

    Definition Classes

    File → AnyRef → Any

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

    

62. def isChildOf(parent: File): Boolean

    

63. def isDirectory(implicit linkOptions: LinkOptions = File.LinkOptions.default): 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(implicit linkOptions: LinkOptions = File.LinkOptions.default): Boolean

    

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

    

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

    

69. def isHidden: Boolean

    

70. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

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

    

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

    

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

    

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

    

76. def isOwnerWritable(implicit linkOptions: LinkOptions = File.LinkOptions.default): 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(implicit linkOptions: LinkOptions = File.LinkOptions.default): 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 isSiblingOf(sibling: File): Boolean

    

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

85. def isSymbolicLink: Boolean

    

86. def isWriteable: Boolean

    

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

    

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

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

    

90. def list: Files

    

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

    

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

    

93. def loadBytes: Array[Byte]

    

94. def md5: String

    

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

    
    returns

    destination

96. def name: String

    

97. def nameWithoutExtension: String

    

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

    

    Definition Classes

    AnyRef

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

    

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

     

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

     

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

     

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

     

104. def newFileReader: FileReader

     

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

     

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

     

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

     

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

     

109. def newScanner(delimiter: String = File.Delimiters.default, includeDelimiters: Boolean = false)(implicit codec: Codec): Scanner

     

110. def newWatchService: WatchService

     

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

     

112. final def notify(): Unit

     

     Definition Classes

     AnyRef

113. final def notifyAll(): Unit

     

     Definition Classes

     AnyRef

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

     

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

     

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

     

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

     

118. def parent: File

     

     Return parent of this file NOTE: This API returns null if this file is the root; please wrap it in an Option if you expect to handle such behaviour

119. val path: Path

     

120. def pathAsString: String

     

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

     

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

     

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

     

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

     

125. def register(service: WatchService, events: Events = File.Events.all): File

     

126. def relativize(destination: File): Path

     

127. def removePermission(permission: PosixFilePermission)(implicit linkOptions: LinkOptions = File.LinkOptions.default): File

     

128. def renameTo(newName: String): File

     

129. def root: File

     

130. def scanner(delimiter: String = File.Delimiters.default, includeDelimiters: Boolean = false)(implicit codec: Codec): ManagedResource[Scanner]

     

131. def setGroup(group: String): File

     

132. def setOwner(owner: String): File

     

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

     

134. def sibling(name: String): File

     

135. def siblings: Files

     

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

     
     returns

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

137. def symbolicLink: Option[File]

     
     returns

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

138. def symbolicLinkTo(destination: File)(implicit attributes: Attributes = File.Attributes.default): Path

     

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

     

     Definition Classes

     AnyRef

140. def toJava: java.io.File

     

141. def toString(): String

     

     Definition Classes

     File → AnyRef → Any

142. def touch(time: Instant = Instant.now())(implicit attributes: Attributes = File.Attributes.default): File

     

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

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

     

     unzip to a temporary zip file

     unzip to a temporary zip file

     returns

     the zip file

144. def unzipTo(destination: File)(implicit codec: Codec): 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

145. def uri: URI

     

146. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

150. def watchService: ManagedResource[WatchService]

     

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

     

152. def write(bytes: Array[Byte])(implicit openOptions: OpenOptions): File

     

     Write byte array to file.

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

     returns

     this

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

154. def zipTo(destination: File, compressionLevel: Int = Deflater.DEFAULT_COMPRESSION)(implicit codec: Codec): 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