Класс SimpleJavaFileObject

java.lang.Object

javax.tools.SimpleJavaFileObject

Все реализуемые интерфейсы:: FileObject, JavaFileObject

public class SimpleJavaFileObject extends Object implements JavaFileObject

Предоставляет простые реализации большинства методов в JavaFileObject. Этот класс предназначен для наследования и использования в качестве основы для реализации JavaFileObject. Подклассы могут переопределять реализацию и спецификацию любого метода этого класса, при условии соблюдения общего контракта JavaFileObject.

С тех пор:: 1.6

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в интерфейсе javax.tools.JavaFileObject

JavaFileObject.Kind

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected final JavaFileObject.Kind`	`kind`	Тип этого объекта файла.
`protected final URI`	`uri`	URI для этого объекта файла.

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

SimpleJavaFileObject(URI uri,
 JavaFileObject.Kind kind)

Модификатор	Конструктор	Описание
`protected`	Создает SimpleJavaFileObject заданного типа с заданным URI.

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

Модификатор и тип	Метод	Описание
`boolean`	`delete()`	Эта реализация ничего не делает.
`Modifier`	`getAccessLevel()`	Эта реализация возвращает `null`.
`CharSequence`	`getCharContent(boolean ignoreEncodingErrors)`	Эта реализация всегда бросает UnsupportedOperationException.
`JavaFileObject.Kind`	`getKind()`	Возвращает тип этого объекта файла.
`long`	`getLastModified()`	Эта реализация возвращает `0L`.
`String`	`getName()`	Возвращает удобочитаемое имя для этого объекта файла.
`NestingKind`	`getNestingKind()`	Эта реализация возвращает `null`.
`boolean`	`isNameCompatible(String simpleName, JavaFileObject.Kind kind)`	Эта реализация сравнивает путь своего URI с заданным простым именем.
`InputStream`	`openInputStream()`	Эта реализация всегда бросает UnsupportedOperationException.
`OutputStream`	`openOutputStream()`	Эта реализация всегда бросает UnsupportedOperationException.
`Reader`	`openReader(boolean ignoreEncodingErrors)`	Оборачивает результат getCharContent(boolean) в Reader.
`Writer`	`openWriter()`	Оборачивает результат openOutputStream в Writer.
`URI`	`toUri()`	Возвращает URI, идентифицирующий этот объект файла.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

uri

protected final URI uri

URI этого объекта файла.

kind

protected final JavaFileObject.Kind kind

Тип этого объекта файла.

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

SimpleJavaFileObject

protected SimpleJavaFileObject(URI uri, JavaFileObject.Kind kind)

Создаёт объект SimpleJavaFileObject заданного типа и URI.

Параметры:: uri - URI этого объекта файла; kind - тип этого объекта файла

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

toUri

public URI toUri()

Описание, скопированное из интерфейса: FileObject

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

Определено в:: toUri в интерфейсе FileObject
Возвращает:: URI

getName

public String getName()

Описание, скопированное из интерфейса: FileObject

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


 "BobsApp\Test.java"

, в то время как метод toUri может вернуть


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

Определено в:: getName в интерфейсе FileObject
Возвращает:: удобочитаемое имя

openInputStream

public InputStream openInputStream() throws IOException

Эта реализация всегда вызывает UnsupportedOperationException. Подклассы могут изменить это поведение, пока контракт FileObject соблюдается.

Определено в:: openInputStream в интерфейсе FileObject
Возвращает:: поток ввода
Исключения:: IOException - если произошла ошибка ввода/вывода

openOutputStream

public OutputStream openOutputStream() throws IOException

Определено в:: openOutputStream в интерфейсе FileObject
Возвращает:: поток вывода
Исключения:: IOException - если произошла ошибка ввода/вывода

openReader

public Reader openReader(boolean ignoreEncodingErrors) throws IOException

Оборачивает результат getCharContent(boolean) в объект Reader. Подклассы могут изменить это поведение, пока контракт FileObject соблюдается.

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

getCharContent

public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException

Определено в:: getCharContent в интерфейсе FileObject
Параметры:: ignoreEncodingErrors - игнорировать ошибки кодирования, если true
Возвращает:: объект CharSequence, если доступен; null в противном случае
Исключения:: IOException - если произошла ошибка ввода/вывода

openWriter

public Writer openWriter() throws IOException

Оборачивает результат openOutputStream в объект Writer. Подклассы могут изменить это поведение, пока контракт FileObject соблюдается.

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

getLastModified

public long getLastModified()

Эта реализация возвращает 0L. Подклассы могут изменить это поведение, пока контракт FileObject соблюдается.

Определено в:: getLastModified в интерфейсе FileObject
Возвращает:: 0L

delete

public boolean delete()

Эта реализация ничего не делает. Подклассы могут изменить это поведение, пока контракт FileObject соблюдается.

Определено в:: delete в интерфейсе FileObject
Возвращает:: false

getKind

public JavaFileObject.Kind getKind()

Описание, скопированное из интерфейса: JavaFileObject

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

Определено в:: getKind в интерфейсе JavaFileObject
Возвращает:: this.kind

isNameCompatible

public boolean isNameCompatible(String simpleName, JavaFileObject.Kind kind)

Эта реализация сравнивает путь своего URI с заданным простым именем. Этот метод возвращает true, если заданный тип равен типу этого объекта, и если путь равен simpleName + kind.extension или заканчивается на


 "/" + simpleName + kind.extension

Этот метод вызывает getKind() и toUri() и не обращается к полям uri и kind напрямую.

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

Определено в:: isNameCompatible в интерфейсе JavaFileObject
Параметры:: simpleName - простое имя класса; kind - тип
Возвращает:: true если этот объект файла совместим; false в противном случае

getNestingKind

public NestingKind getNestingKind()

Эта реализация возвращает null. Подклассы могут изменить это поведение, пока контракт JavaFileObject соблюдается.

Определено в:: getNestingKind в интерфейсе JavaFileObject
Возвращает:: тип вложенности или null если тип вложенности неизвестен

getAccessLevel

public Modifier getAccessLevel()

Эта реализация возвращает null. Подклассы могут изменить это поведение, пока контракт JavaFileObject соблюдается.

Определено в:: getAccessLevel в интерфейсе JavaFileObject
Возвращает:: уровень доступа

© 1993, 2023, 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/21/docs/api/java.compiler/javax/tools/SimpleJavaFileObject.html