Extensions for java.nio.file.Path
absolutePathString
Converts this possibly relative path to an absolute path and returns its string representation.
fun Path.absolutePathString(): StringappendLines
appendText
Appends text to the content of this file using UTF-8 or the specified charset.
fun Path.appendText(
text: CharSequence,
charset: Charset = Charsets.UTF_8)bufferedReader
Returns a new BufferedReader for reading the content of this file.
fun Path.bufferedReader(
charset: Charset = Charsets.UTF_8,
bufferSize: Int = DEFAULT_BUFFER_SIZE,
vararg options: OpenOption
): BufferedReaderbufferedWriter
Returns a new BufferedWriter for writing the content of this file.
fun Path.bufferedWriter(
charset: Charset = Charsets.UTF_8,
bufferSize: Int = DEFAULT_BUFFER_SIZE,
vararg options: OpenOption
): BufferedWritercopyToRecursively
Recursively copies this directory and its content to the specified destination target path. Note that if this function throws, partial copying may have taken place.
fun Path.copyToRecursively(
target: Path,
onError: (source: Path, target: Path, exception: Exception) -> OnErrorResult = { _, _, exception -> throw exception },
followLinks: Boolean,
copyAction: CopyActionContext.(source: Path, target: Path) -> CopyActionResult = { src, dst ->
src.copyToIgnoringExistingDirectory(dst, followLinks)
}
): PathcreateDirectories
Creates a directory ensuring that all nonexistent parent directories exist by creating them first.
fun Path.createDirectories(
vararg attributes: FileAttribute<*>
): PathcreateDirectory
Creates a new directory or throws an exception if there is already a file or directory located by this path.
fun Path.createDirectory(
vararg attributes: FileAttribute<*>
): PathcreateFile
Creates a new and empty file specified by this path, failing if the file already exists.
fun Path.createFile(
vararg attributes: FileAttribute<*>
): PathcreateParentDirectories
Ensures that all parent directories of this path exist, creating them if required.
fun Path.createParentDirectories(
vararg attributes: FileAttribute<*>
): PathcreateSymbolicLinkPointingTo
Creates a new symbolic link located by this path to the given target.
fun Path.createSymbolicLinkPointingTo(
target: Path,
vararg attributes: FileAttribute<*>
): PathdeleteExisting
Deletes the existing file or empty directory specified by this path.
fun Path.deleteExisting()deleteIfExists
Deletes the file or empty directory specified by this path if it exists.
fun Path.deleteIfExists(): BooleandeleteRecursively
Recursively deletes this directory and its content. Note that if this function throws, partial deletion may have taken place.
fun Path.deleteRecursively()exists
Checks if the file located by this path exists.
fun Path.exists(vararg options: LinkOption): Booleanextension
Returns the extension of this path (not including the dot), or an empty string if it doesn't have one.
val Path.extension: StringfileAttributesView
Returns a file attributes view of a given type V or throws an UnsupportedOperationException if the requested attribute view type is not available..
fun <V : FileAttributeView> Path.fileAttributesView(
vararg options: LinkOption
): VfileAttributesViewOrNull
Returns a file attributes view of a given type V
or null if the requested attribute view type is not available.
fun <V : FileAttributeView> Path.fileAttributesViewOrNull(
vararg options: LinkOption
): V?getAttribute
Reads the value of a file attribute.
fun Path.getAttribute(
attribute: String,
vararg options: LinkOption
): Any?getLastModifiedTime
Returns the last modified time of the file located by this path.
fun Path.getLastModifiedTime(
vararg options: LinkOption
): FileTimegetOwner
Returns the owner of a file.
fun Path.getOwner(vararg options: LinkOption): UserPrincipal?getPosixFilePermissions
Returns the POSIX file permissions of the file located by this path.
fun Path.getPosixFilePermissions(
vararg options: LinkOption
): Set<PosixFilePermission>inputStream
Constructs a new InputStream of this file and returns it as a result.
fun Path.inputStream(vararg options: OpenOption): InputStreaminvariantSeparatorsPath
val Path.invariantSeparatorsPath: StringinvariantSeparatorsPathString
Returns the string representation of this path using the invariant separator '/' to separate names in the path.
val Path.invariantSeparatorsPathString: StringisDirectory
Checks if the file located by this path is a directory.
fun Path.isDirectory(vararg options: LinkOption): BooleanisExecutable
Checks if the file located by this path exists and is executable.
fun Path.isExecutable(): BooleanisReadable
Checks if the file located by this path exists and is readable.
fun Path.isReadable(): BooleanisRegularFile
Checks if the file located by this path is a regular file.
fun Path.isRegularFile(vararg options: LinkOption): BooleanisSymbolicLink
Checks if the file located by this path exists and is a symbolic link.
fun Path.isSymbolicLink(): BooleanisWritable
Checks if the file located by this path exists and is writable.
fun Path.isWritable(): Booleanname
Returns the name of the file or directory denoted by this path as a string, or an empty string if this path has zero path elements.
val Path.name: StringnotExists
Checks if the file located by this path does not exist.
fun Path.notExists(vararg options: LinkOption): BooleanoutputStream
Constructs a new OutputStream of this file and returns it as a result.
fun Path.outputStream(
vararg options: OpenOption
): OutputStreampathString
Returns the string representation of this path.
val Path.pathString: StringreadAttributes
Reads a file's attributes of the specified type A in bulk.
fun <A : BasicFileAttributes> Path.readAttributes(
vararg options: LinkOption
): AReads the specified list of attributes of a file in bulk.
fun Path.readAttributes(
attributes: String,
vararg options: LinkOption
): Map<String, Any?>reader
Returns a new InputStreamReader for reading the content of this file.
fun Path.reader(
charset: Charset = Charsets.UTF_8,
vararg options: OpenOption
): InputStreamReadersetAttribute
Sets the value of a file attribute.
fun Path.setAttribute(
attribute: String,
value: Any?,
vararg options: LinkOption
): PathsetOwner
Sets the file owner to the specified value.
fun Path.setOwner(value: UserPrincipal): PathsetPosixFilePermissions
Sets the POSIX file permissions for the file located by this path.
fun Path.setPosixFilePermissions(
value: Set<PosixFilePermission>
): PathvisitFileTree
Visits this directory and all its content with the specified visitor.
fun Path.visitFileTree(
visitor: FileVisitor<Path>,
maxDepth: Int = Int.MAX_VALUE,
followLinks: Boolean = false)Visits this directory and all its content with the FileVisitor defined in builderAction.
fun Path.visitFileTree(
maxDepth: Int = Int.MAX_VALUE,
followLinks: Boolean = false,
builderAction: FileVisitorBuilder.() -> Unit)walk
Returns a sequence of paths for visiting this directory and all its content.
fun Path.walk(vararg options: PathWalkOption): Sequence<Path>writeBytes
Writes an array of bytes to this file.
fun Path.writeBytes(
array: ByteArray,
vararg options: OpenOption)writeLines
Write the specified collection of char sequences lines to a file terminating each one with the platform's line separator.
fun Path.writeLines(
lines: Iterable<CharSequence>,
charset: Charset = Charsets.UTF_8,
vararg options: OpenOption
): PathWrite the specified sequence of char sequences lines to a file terminating each one with the platform's line separator.
fun Path.writeLines(
lines: Sequence<CharSequence>,
charset: Charset = Charsets.UTF_8,
vararg options: OpenOption
): Pathwriter
Returns a new OutputStreamWriter for writing the content of this file.
fun Path.writer(
charset: Charset = Charsets.UTF_8,
vararg options: OpenOption
): OutputStreamWriterwriteText
Sets the content of this file as text encoded using UTF-8 or the specified charset.
fun Path.writeText(
text: CharSequence,
charset: Charset = Charsets.UTF_8,
vararg options: OpenOption)