Интерфейс FileObject

Все известные подинтерфейсы:: JavaFileObject

Все известные реализующие классы:: ForwardingFileObject, ForwardingJavaFileObject, SimpleJavaFileObject

public interface FileObject

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

Если это явно не разрешено, все методы этого интерфейса могут выбросить NullPointerException, если им передан аргумент null.

Начиная с версии:: 1.6

Краткое описание методов

Модификатор и тип	Метод	Описание
`boolean`	`delete()`	Удаляет этот файловый объект.
`CharSequence`	`getCharContent(boolean ignoreEncodingErrors)`	Возвращает текстовое содержимое этого файлового объекта, если оно доступно.
`long`	`getLastModified()`	Возвращает время последнего изменения этого файлового объекта.
`String`	`getName()`	Возвращает удобочитаемое имя этого файлового объекта.
`InputStream`	`openInputStream()`	Возвращает InputStream для этого файлового объекта.
`OutputStream`	`openOutputStream()`	Возвращает OutputStream для этого файлового объекта.
`Reader`	`openReader(boolean ignoreEncodingErrors)`	Возвращает средство чтения для этого объекта.
`Writer`	`openWriter()`	Возвращает Writer для этого файлового объекта.
`URI`	`toUri()`	Возвращает URI, идентифицирующий этот файловый объект.

Подробное описание методов

toUri

URI toUri()

Возвращает URI, идентифицирующий этот файловый объект.

Возвращает:: URI

getName

String getName()

Возвращает удобочитаемое имя этого файлового объекта. Точное возвращаемое значение не определено, однако реализации должны стремиться сохранять имена в том виде, в каком их указал пользователь. Например, если пользователь вводит имя файла "BobsApp\Test.java" в командной строке, этот метод должен возвращать


"BobsApp\Test.java"

, тогда как метод toUri может возвращать


file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java

Возвращает:: удобочитаемое имя

openInputStream

InputStream openInputStream() throws IOException

Возвращает InputStream для этого файлового объекта.

Возвращает:: InputStream
Выбрасывает:: IllegalStateException — если этот файловый объект открыт для записи и не поддерживает чтение; UnsupportedOperationException — если этот тип файлового объекта не поддерживает доступ к байтам; IOException — если произошла ошибка ввода-вывода

openOutputStream

OutputStream openOutputStream() throws IOException

Возвращает OutputStream для этого файлового объекта.

Возвращает:: OutputStream
Выбрасывает:: IllegalStateException — если этот файловый объект открыт для чтения и не поддерживает запись; UnsupportedOperationException — если этот тип файлового объекта не поддерживает доступ к байтам; IOException — если произошла ошибка ввода-вывода

openReader

Reader openReader(boolean ignoreEncodingErrors) throws IOException

Возвращает средство чтения для этого объекта. Возвращаемое средство чтения заменяет байты, которые не удается декодировать, символом замены по умолчанию. Кроме того, средство чтения может сообщить о диагностической ошибке, если ignoreEncodingErrors не равно true.

Параметры:: ignoreEncodingErrors — игнорировать ошибки кодировки, если значение true
Возвращает:: Reader
Выбрасывает:: IllegalStateException — если этот файловый объект открыт для записи и не поддерживает чтение; UnsupportedOperationException — если этот тип файлового объекта не поддерживает доступ к символам; IOException — если произошла ошибка ввода-вывода

getCharContent

CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException

Возвращает текстовое содержимое этого файлового объекта, если оно доступно. Любой байт, который не удается декодировать, заменяется символом замены по умолчанию. Кроме того, может быть сообщено о диагностической ошибке, если ignoreEncodingErrors не равно true.

Параметры:: ignoreEncodingErrors — игнорировать ошибки кодировки, если значение true
Возвращает:: CharSequence, если доступна; null в противном случае
Выбрасывает:: IllegalStateException — если этот файловый объект открыт для записи и не поддерживает чтение; UnsupportedOperationException — если этот тип файлового объекта не поддерживает доступ к символам; IOException — если произошла ошибка ввода-вывода

openWriter

Writer openWriter() throws IOException

Возвращает Writer для этого файлового объекта.

Возвращает:: Writer
Выбрасывает:: IllegalStateException — если этот файловый объект открыт для чтения и не поддерживает запись; UnsupportedOperationException — если этот тип файлового объекта не поддерживает доступ к символам; IOException — если произошла ошибка ввода-вывода

getLastModified

long getLastModified()

Возвращает время последнего изменения этого файлового объекта. Время измеряется в миллисекундах с начала эпохи (00:00:00 GMT, 1 января 1970 года).

Возвращает:: время последнего изменения этого файлового объекта; или 0, если файловый объект не существует, произошла ошибка ввода-вывода либо операция не поддерживается

delete

boolean delete()

Удаляет этот файловый объект. В случае ошибки возвращает false.

Возвращает:: true тогда и только тогда, когда этот файловый объект успешно удален; в противном случае false

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.compiler/javax/tools/FileObject.html