Интерфейс FileObject

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

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

public interface FileObject

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

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

Если явно не разрешено, все методы в этом интерфейсе могут вызывать исключение 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, 2021, 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/17/docs/api/java.compiler/javax/tools/FileObject.html