better.files

File

class File extends AnyRef

Scala wrapper around java.nio.files.Path

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. File
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new File(_path: Path)

Value Members

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

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  4. final def ##(): Int

    Definition Classes
    AnyRef → Any

  5. def /(child: String): File

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

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

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

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

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

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

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

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

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

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

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

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

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

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

    test if file has this permission

  21. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

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

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

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

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

  27. def byteArray: Array[Byte]

  28. def bytes: Iterator[Byte]

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

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

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

  31. def checksum(algorithm: String): String

    returns

    checksum of this file (or directory) in hex format

  32. def children: Files

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

  34. def clone(): AnyRef

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

  35. def collectChildren(f: (File) ⇒ Boolean): Files

    More Scala friendly way of doing Files.

    More Scala friendly way of doing Files.walk

    f
    returns

  36. def contains(file: File): Boolean

    Check if this directory contains this file

    Check if this directory contains this file

    file
    returns

    true if this is a directory and it contains this file

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

  38. def contentType: Option[String]

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

    destination
    overwrite
    returns

    destination

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

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

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

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

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

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

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

  47. def entries: Files

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

    Definition Classes
    AnyRef

  49. def equals(obj: Any): Boolean

    Definition Classes
    File → AnyRef → Any

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

  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, 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

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

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

  61. def hasExtension: Boolean

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

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

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

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

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

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

  79. def isParentOf(child: File): Boolean

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

    returns

    See also

    isOwnerReadable

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

  82. def isSameContentAs(that: File): Boolean

    returns

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

  83. def isSameFileAs(that: File): Boolean

  84. def isSamePathAs(that: File): Boolean

  85. def isSiblingOf(sibling: File): Boolean

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

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

    that
    returns

  87. def isSymbolicLink: Boolean

  88. def isWriteable: Boolean

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

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

    codec
    returns

    all lines in this file

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

  92. def list: Files

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

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

  95. def loadBytes: Array[Byte]

  96. def md5: String

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

    destination
    overwrite
    returns

    destination

  98. def name: String

  99. def nameWithoutExtension: String

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

    Definition Classes
    AnyRef

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

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

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

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

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

  106. def newFileReader: FileReader

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

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

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

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

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

  112. def newWatchService: WatchService

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

  114. final def notify(): Unit

    Definition Classes
    AnyRef

  115. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

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

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

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

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

    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

    returns

  121. val path: Path

  122. def pathAsString: String

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

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

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

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

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

  128. def relativize(destination: File): Path

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

  130. def renameTo(newName: String): File

  131. def root: File

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

  133. def setGroup(group: String): File

  134. def setOwner(owner: String): File

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

  136. def sibling(name: String): File

  137. def siblings: Files

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

    returns

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

  139. def symbolicLink: Option[File]

    returns

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

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

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

    Definition Classes
    AnyRef

  142. def toJava: java.io.File

  143. def toString(): String

    Definition Classes
    File → AnyRef → Any

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

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

    unzip to a temporary zip file

    unzip to a temporary zip file

    returns

    the zip file

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

  147. def uri: URI

  148. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    maxDepth
    returns

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

  152. def watchService: ManagedResource[WatchService]

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

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

    bytes
    returns

    this

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped