Spec-Zone.ru › Kotlin 1.9

Расширения для java.io.File

kotlin-stdlib / kotlin.io / java.io.File
Требования к платформе и версии: JVM (1.0)

appendBytes

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

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

appendText

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

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

bufferedReader

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

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

bufferedWriter

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

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

copyRecursively

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

fun File.copyRecursively(
    target: File, 
    overwrite: Boolean = false, 
    onError: (File, IOException) -> OnErrorAction = { _, exception -> throw exception }
): Boolean
Требования к платформе и версии: JVM (1.0)

copyTo

Копирует этот файл в указанный целевой файл.

fun File.copyTo(
    target: File, 
    overwrite: Boolean = false, 
    bufferSize: Int = DEFAULT_BUFFER_SIZE
): File
Требования к платформе и версии: JVM (1.0)

deleteRecursively

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

fun File.deleteRecursively(): Boolean
Требования к платформе и версии: JVM (1.0)

endsWith

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

fun File.endsWith(other: File): Boolean

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

fun File.endsWith(other: String): Boolean
Требования к платформе и версии: JVM (1.0)

расширение

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

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

forEachBlock

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

fun File.forEachBlock(
    action: (buffer: ByteArray, bytesRead: Int) -> Unit)

Считывает файл по блокам байтов и вызывает action для каждого считанного блока. Эта функция передает массив байтов и количество байтов в массиве функции action.

fun File.forEachBlock(
    blockSize: Int, 
    action: (buffer: ByteArray, bytesRead: Int) -> Unit)
Требования к платформе и версии: JVM (1.0)

forEachLine

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

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

inputStream

Создает новый FileInputStream для этого файла и возвращает его.

fun File.inputStream(): FileInputStream
Требования к платформе и версии: JVM (1.0)

путь с неизменными разделителями

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

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

имеет корневой путь

Определяет, имеет ли этот файл корень или представляет собой относительный путь.

val File.isRooted: Boolean
Требования к платформе и версии: JVM (1.0)

имя без расширения

Возвращает имя файла без расширения.

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

нормализовать

Удаляет все . и разрешает все возможные .. в имени файла. Например, File("/foo/./bar/gav/../baaz").normalize() это File("/foo/bar/baaz").

fun File.normalize(): File
Требования к платформе и версии: JVM (1.0)

outputStream

Создаёт новый FileOutputStream для этого файла и возвращает его.

fun File.outputStream(): FileOutputStream
Требования к платформе и версии: JVM (1.0)

printWriter

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

fun File.printWriter(
    charset: Charset = Charsets.UTF_8
): PrintWriter
Требования к платформе и версии: JVM (1.0)

readBytes

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

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

reader

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

fun File.reader(
    charset: Charset = Charsets.UTF_8
): InputStreamReader
Требования к платформе и версии: JVM (1.0)

readLines

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

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

readText

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

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

relativeTo

Вычисляет относительный путь к этому файлу от файла base. Обратите внимание, что файл base рассматривается как директория. Если этот файл совпадает с файлом base, то будет возвращён файл File с путём пустым.

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

relativeToOrNull

Вычисляет относительный путь к этому файлу от файла base. Обратите внимание, что файл base рассматривается как директория. Если этот файл совпадает с файлом base, то будет возвращён файл File с путём пустым.

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

relativeToOrSelf

Вычисляет относительный путь к этому файлу от файла base. Обратите внимание, что файл base рассматривается как директория. Если этот файл совпадает с файлом base, то будет возвращён файл File с путём пустым.

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

resolve

Добавляет файл relative к этому, рассматривая этот как директорию. Если relative имеет корень, возвращает relative обратно. Например, File("/foo/bar").resolve(File("gav")) это File("/foo/bar/gav"). Эта функция дополняет relativeTo, поэтому f.resolve(g.relativeTo(f)) == g должно быть всегда true за исключением случаев разных корней.

fun File.resolve(relative: File): File

Добавляет имя relative к этому, рассматривая этот как директорию. Если relative имеет корень, возвращает relative обратно. Например, File("/foo/bar").resolve("gav") это File("/foo/bar/gav").

fun File.resolve(relative: String): File
Требования к платформе и версии: JVM (1.0)

resolveSibling

Добавляет файл relative к родительской директории этого. Если relative имеет корень или у этого нет родительской директории, возвращает relative обратно. Например, File("/foo/bar").resolveSibling(File("gav")) это File("/foo/gav").

fun File.resolveSibling(relative: File): File

Добавляет имя relative к родительской директории этого. Если relative имеет корень или у этого нет родительской директории, возвращает relative обратно. Например, File("/foo/bar").resolveSibling("gav") это File("/foo/gav").

fun File.resolveSibling(relative: String): File
Требования к платформе и версии: JVM (1.0)

startsWith

Определяет, принадлежит ли этот файл тому же корню, что и other, и начинается ли с всех компонентов other в том же порядке. Таким образом, если other имеет N компонентов, первые N компонентов this должны быть такими же, как у other.

fun File.startsWith(other: File): Boolean
fun File.startsWith(other: String): Boolean
Требования к платформе и версии: JVM (1.0)

toRelativeString

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

fun File.toRelativeString(base: File): String
Требования к платформе и версии: JVM (1.0)

useLines

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

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

walk

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

fun File.walk(
    direction: FileWalkDirection = FileWalkDirection.TOP_DOWN
): FileTreeWalk
Требования к платформе и версии: JVM (1.0)

walkBottomUp

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

fun File.walkBottomUp(): FileTreeWalk
Требования к платформе и версии: JVM (1.0)

walkTopDown

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

fun File.walkTopDown(): FileTreeWalk
Требования к платформе и версии: JVM (1.0)

writeBytes

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

fun File.writeBytes(array: ByteArray)
Требования к платформе и версии: JVM (1.0)

writer

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

fun File.writer(
    charset: Charset = Charsets.UTF_8
): OutputStreamWriter
Требования к платформе и версии: JVM (1.0)

writeText

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

fun File.writeText(
    text: String, 
    charset: Charset = Charsets.UTF_8)

© 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/java.io.-file/index.html

Spec-Zone.ru

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