Spec-Zone.ru › Kotlin 1.8

Расширения для java.nio.file.Path

kotlin-stdlib / kotlin.io.path / java.nio.file.Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

absolute

Преобразует этот, возможно, относительный путь в абсолютный путь.

fun Path.absolute(): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

absolutePathString

Преобразует этот, возможно, относительный путь в абсолютный путь и возвращает его строковое представление.

fun Path.absolutePathString(): String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

appendBytes

Добавляет массив байтов array к содержимому этого файла.

fun Path.appendBytes(array: ByteArray)
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

appendLines

Добавляет указанную коллекцию последовательностей символов lines в файл, завершая каждую из них разделителем строк платформы.

fun Path.appendLines(
    lines: Iterable<CharSequence>, 
    charset: Charset = Charsets.UTF_8
): Path

Добавляет указанную последовательность последовательностей символов lines в файл, завершая каждую из них разделителем строк платформы.

fun Path.appendLines(
    lines: Sequence<CharSequence>, 
    charset: Charset = Charsets.UTF_8
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

appendText

Добавляет text к содержимому этого файла, используя UTF-8 или указанную charset.

fun Path.appendText(
    text: CharSequence, 
    charset: Charset = Charsets.UTF_8)
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

bufferedReader

Возвращает новый BufferedReader для чтения содержимого этого файла.

fun Path.bufferedReader(
    charset: Charset = Charsets.UTF_8, 
    bufferSize: Int = DEFAULT_BUFFER_SIZE, 
    vararg options: OpenOption
): BufferedReader
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

bufferedWriter

Возвращает новый BufferedWriter для записи содержимого этого файла.

fun Path.bufferedWriter(
    charset: Charset = Charsets.UTF_8, 
    bufferSize: Int = DEFAULT_BUFFER_SIZE, 
    vararg options: OpenOption
): BufferedWriter
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

copyTo

Копирует файл или каталог, расположенный по этому пути, в указанный путь target.

fun Path.copyTo(
    target: Path, 
    overwrite: Boolean = false
): Path
fun Path.copyTo(
    target: Path, 
    vararg options: CopyOption
): Path
Требования к платформе и версии: JVM (1.8), JRE7 (1.8)

copyToRecursively

Рекурсивно копирует этот каталог и его содержимое в указанный путь назначения target. Обратите внимание, что если эта функция выдает исключение, частичное копирование могло произойти.

fun Path.copyToRecursively(
    target: Path, 
    onError: (source: Path, target: Path, exception: Exception) -> OnErrorResult = { _, _, exception -> throw exception }, 
    followLinks: Boolean, 
    overwrite: Boolean
): Path
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)
    }
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

createDirectories

Создает каталог, гарантируя, что все несуществующие родительские каталоги существуют, создавая их сначала.

fun Path.createDirectories(
    vararg attributes: FileAttribute<*>
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

createDirectory

Создает новый каталог или выдает исключение, если по этому пути уже существует файл или каталог.

fun Path.createDirectory(
    vararg attributes: FileAttribute<*>
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

createFile

Создает новый пустой файл, указанный этим путем, выдавая ошибку, если файл уже существует.

fun Path.createFile(
    vararg attributes: FileAttribute<*>
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

createLinkPointingTo

Создает новую ссылку (запись каталога), расположенную по этому пути, для существующего файла target.

fun Path.createLinkPointingTo(target: Path): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

createSymbolicLinkPointingTo

Создает новую символическую ссылку, расположенную по этому пути, на указанный target.

fun Path.createSymbolicLinkPointingTo(
    target: Path, 
    vararg attributes: FileAttribute<*>
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

deleteExisting

Удаляет существующий файл или пустой каталог, указанный этим путем.

fun Path.deleteExisting()
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

deleteIfExists

Удаляет файл или пустой каталог, указанный этим путем, если он существует.

fun Path.deleteIfExists(): Boolean
Требования к платформе и версии: JVM (1.8), JRE7 (1.8)

deleteRecursively

Рекурсивно удаляет этот каталог и его содержимое. Обратите внимание, что если эта функция выдает исключение, частичное удаление могло произойти.

fun Path.deleteRecursively()
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

div

Разрешает данный путь other относительно этого пути.

operator fun Path.div(other: Path): Path

Разрешает данную строку пути other относительно этого пути.

operator fun Path.div(other: String): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

exists

Проверяет, существует ли файл, расположенный по этому пути.

fun Path.exists(vararg options: LinkOption): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

extension

Возвращает расширение этого пути (без точки) или пустую строку, если его нет.

val Path.extension: String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

fileAttributesView

Возвращает представление атрибутов файла заданного типа V или вызывает исключение UnsupportedOperationException, если запрашиваемый тип представления атрибутов недоступен.

fun <V : FileAttributeView> Path.fileAttributesView(
    vararg options: LinkOption
): V
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

fileAttributesViewOrNull

Возвращает представление атрибутов файла заданного типа V или null если запрашиваемый тип представления атрибутов недоступен.

fun <V : FileAttributeView> Path.fileAttributesViewOrNull(
    vararg options: LinkOption
): V?
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

fileSize

Возвращает размер обычного файла в байтах как значение Long или вызывает исключение, если файл не существует.

fun Path.fileSize(): Long
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

fileStore

Возвращает FileStore, представляющий файловую систему, где находится файл.

fun Path.fileStore(): FileStore
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

forEachDirectoryEntry

Выполняет заданное действие action для каждой записи в этом каталоге, при необходимости фильтруя по совпадению с указанным шаблоном glob.

fun Path.forEachDirectoryEntry(
    glob: String = "*", 
    action: (Path) -> Unit)
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

forEachLine

Читает этот файл построчно, используя указанную кодировку charset, и вызывает action для каждой строки. Кодировка по умолчанию — UTF-8.

fun Path.forEachLine(
    charset: Charset = Charsets.UTF_8, 
    action: (line: String) -> Unit)
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

getAttribute

Считывает значение атрибута файла.

fun Path.getAttribute(
    attribute: String, 
    vararg options: LinkOption
): Any?
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

getLastModifiedTime

Возвращает время последнего изменения файла, расположенного по этому пути.

fun Path.getLastModifiedTime(
    vararg options: LinkOption
): FileTime
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

getOwner

Возвращает владельца файла.

fun Path.getOwner(vararg options: LinkOption): UserPrincipal?
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

getPosixFilePermissions

Возвращает разрешения POSIX для файла, расположенного по этому пути.

fun Path.getPosixFilePermissions(
    vararg options: LinkOption
): Set<PosixFilePermission>
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

inputStream

Создает новый InputStream этого файла и возвращает его в качестве результата.

fun Path.inputStream(vararg options: OpenOption): InputStream
Требования к платформе и версии: JVM (1.4), JRE7 (1.4)

invariantSeparatorsPath

val Path.invariantSeparatorsPath: String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

invariantSeparatorsPathString

Возвращает строковое представление этого пути, используя инвариантный разделитель '/' для разделения имен в пути.

val Path.invariantSeparatorsPathString: String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isDirectory

Проверяет, является ли файл, расположенный по этому пути, каталогом.

fun Path.isDirectory(vararg options: LinkOption): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isExecutable

Проверяет, существует ли файл, расположенный по этому пути, и является ли он исполняемым.

fun Path.isExecutable(): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isHidden

Проверяет, считается ли файл, расположенный по этому пути, скрытым.

fun Path.isHidden(): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isReadable

Проверяет, существует ли файл, расположенный по этому пути, и является ли он читаемым.

fun Path.isReadable(): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isRegularFile

Проверяет, является ли файл, расположенный по этому пути, обычным файлом.

fun Path.isRegularFile(vararg options: LinkOption): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isSameFileAs

Проверяет, указывает ли файл, расположенный по этому пути, на тот же файл или каталог, что и other.

fun Path.isSameFileAs(other: Path): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isSymbolicLink

Проверяет, существует ли файл, расположенный по этому пути, и является ли он символической ссылкой.

fun Path.isSymbolicLink(): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

isWritable

Проверяет, существует ли файл, расположенный по этому пути, и является ли он записываемым.

fun Path.isWritable(): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

listDirectoryEntries

Возвращает список записей в этом каталоге, при необходимости фильтруя их по совпадению с указанным шаблоном glob.

fun Path.listDirectoryEntries(glob: String = "*"): List<Path>
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

moveTo

Перемещает или переименовывает файл, расположенный по этому пути, в путь target.

fun Path.moveTo(
    target: Path, 
    vararg options: CopyOption
): Path
fun Path.moveTo(
    target: Path, 
    overwrite: Boolean = false
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

name

Возвращает имя файла или каталога, обозначенного этим путем, в виде строки, или пустую строку, если этот путь имеет нулевое количество элементов пути.

val Path.name: String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

nameWithoutExtension

Возвращает name этого файла или каталога без расширения, или пустую строку, если этот путь имеет нулевое количество элементов пути.

val Path.nameWithoutExtension: String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

notExists

Проверяет, существует ли файл, расположенный по этому пути.

fun Path.notExists(vararg options: LinkOption): Boolean
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

outputStream

Создает новый OutputStream этого файла и возвращает его в качестве результата.

fun Path.outputStream(
    vararg options: OpenOption
): OutputStream
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

pathString

Возвращает строковое представление этого пути.

val Path.pathString: String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

readAttributes

Считывает атрибуты файла указанного типа A оптом.

fun <A : BasicFileAttributes> Path.readAttributes(
    vararg options: LinkOption
): A

Считывает указанный список атрибутов файла оптом.

fun Path.readAttributes(
    attributes: String, 
    vararg options: LinkOption
): Map<String, Any?>
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

readBytes

Получает все содержимое этого файла в виде массива байтов.

fun Path.readBytes(): ByteArray
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

reader

Возвращает новый InputStreamReader для чтения содержимого этого файла.

fun Path.reader(
    charset: Charset = Charsets.UTF_8, 
    vararg options: OpenOption
): InputStreamReader
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

readLines

Считывает содержимое файла как список строк.

fun Path.readLines(
    charset: Charset = Charsets.UTF_8
): List<String>
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

readSymbolicLink

Считывает целевой объект символической ссылки, расположенной по этому пути.

fun Path.readSymbolicLink(): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

readText

Получает все содержимое этого файла в виде строки, используя UTF-8 или указанную charset.

fun Path.readText(charset: Charset = Charsets.UTF_8): String
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

relativeTo

Вычисляет относительный путь для этого пути от базового пути base.

fun Path.relativeTo(base: Path): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

relativeToOrNull

Вычисляет относительный путь для этого пути от базового пути base.

fun Path.relativeToOrNull(base: Path): Path?
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

relativeToOrSelf

Вычисляет относительный путь для этого пути от базового пути base.

fun Path.relativeToOrSelf(base: Path): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

setAttribute

Устанавливает значение атрибута файла.

fun Path.setAttribute(
    attribute: String, 
    value: Any?, 
    vararg options: LinkOption
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

setLastModifiedTime

Устанавливает атрибут последнего изменения времени для файла, расположенного по этому пути.

fun Path.setLastModifiedTime(value: FileTime): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

setOwner

Устанавливает владельца файла на указанное value.

fun Path.setOwner(value: UserPrincipal): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

setPosixFilePermissions

Устанавливает права доступа к файлам POSIX для файла, расположенного по этому пути.

fun Path.setPosixFilePermissions(
    value: Set<PosixFilePermission>
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

useDirectoryEntries

Вызывает обратный вызов block с последовательностью всех записей в этом каталоге, при необходимости фильтруя их по совпадению с указанным шаблоном glob.

fun <T> Path.useDirectoryEntries(
    glob: String = "*", 
    block: (Sequence<Path>) -> T
): T
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

useLines

Вызывает обратный вызов block, передавая ему последовательность всех строк в этом файле, и закрывает чтец после завершения обработки.

fun <T> Path.useLines(
    charset: Charset = Charsets.UTF_8, 
    block: (Sequence<String>) -> T
): T
Требования к платформе и версии: JVM (1.7), JRE7 (1.7)

visitFileTree

Посещает эту директорию и все её содержимое с указанным визитором.

fun Path.visitFileTree(
    visitor: FileVisitor<Path>, 
    maxDepth: Int = Int.MAX_VALUE, 
    followLinks: Boolean = false)

Посещает эту директорию и всё её содержимое с FileVisitor, определённым в builderAction.

fun Path.visitFileTree(
    maxDepth: Int = Int.MAX_VALUE, 
    followLinks: Boolean = false, 
    builderAction: FileVisitorBuilder.() -> Unit)
Требования к платформе и версии: JVM (1.7), JRE7 (1.7)

walk

Возвращает последовательность путей для посещения этой директории и всего её содержимого.

fun Path.walk(vararg options: PathWalkOption): Sequence<Path>
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

writeBytes

Записывает массив байтов array в этот файл.

fun Path.writeBytes(
    array: ByteArray, 
    vararg options: OpenOption)
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

writeLines

Записывает указанную коллекцию последовательностей символов lines в файл, завершая каждую из них разделителем строк платформы.

fun Path.writeLines(
    lines: Iterable<CharSequence>, 
    charset: Charset = Charsets.UTF_8, 
    vararg options: OpenOption
): Path

Записывает указанную последовательность последовательностей символов lines в файл, завершая каждую из них разделителем строк платформы.

fun Path.writeLines(
    lines: Sequence<CharSequence>, 
    charset: Charset = Charsets.UTF_8, 
    vararg options: OpenOption
): Path
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

writer

Возвращает новый OutputStreamWriter для записи содержимого этого файла.

fun Path.writer(
    charset: Charset = Charsets.UTF_8, 
    vararg options: OpenOption
): OutputStreamWriter
Требования к платформе и версии: JVM (1.5), JRE7 (1.5)

writeText

Устанавливает содержимое этого файла как текст, закодированный с помощью UTF-8 или указанного кодирования.

fun Path.writeText(
    text: CharSequence, 
    charset: Charset = Charsets.UTF_8, 
    vararg options: OpenOption)

© 2010–2023 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API