Интерфейс FileObject

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

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

public interface FileObject

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

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

С:: 1.6

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

Модификатор и тип	Метод	Описание
`boolean`	`delete()`	Удаляет этот объект файла.
`CharSequence`	`getCharContent(boolean ignoreEncodingErrors)`	Возвращает символьное содержимое этого объекта файла, если доступно.
`long`	`getLastModified()`	Возвращает время последнего изменения этого объекта файла.
`String`	`getName()`	Возвращает имя этого объекта файла в удобном для пользователя формате.
`InputStream`	`openInputStream()`	Возвращает поток ввода для этого объекта файла.
`OutputStream`	`openOutputStream()`	Возвращает поток вывода для этого объекта файла.
`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

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

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

openOutputStream

OutputStream openOutputStream() throws IOException

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

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

openReader

Reader openReader(boolean ignoreEncodingErrors) throws IOException

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

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

getCharContent

CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException

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

Параметры:: ignoreEncodingErrors - игнорировать ошибки кодирования, если true
Возвращает:: a 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://download.java.net/java/early_access/jdk24/docs/api/java.compiler/javax/tools/FileObject.html