Класс SimpleJavaFileObject

Все реализованные интерфейсы:
FileObject, JavaFileObject 
public class SimpleJavaFileObject
extends Object
implements JavaFileObject

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

С:
1.6

Вложенные классы

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

JavaFileObject.Kind

Поля

Модификатор и тип Поле Описание
protected JavaFileObject.Kind kind

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

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

Конструкторы

Модификатор Конструктор Описание
protected SimpleJavaFileObject​(URI uri, JavaFileObject.Kind kind)

Создает SimpleJavaFileObject заданного типа и с заданным URI.

Методы

Модификатор и тип Метод Описание
boolean delete()

Эта реализация ничего не делает.
Modifier getAccessLevel()

Эта реализация возвращает null.

CharSequence getCharContent​(boolean ignoreEncodingErrors)

Эта реализация всегда выбрасывает UnsupportedOperationException.
JavaFileObject.Kind getKind()

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

Эта реализация возвращает 0L.

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.

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

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

Методы, объявленные в интерфейсе javax.tools.FileObject

getName, toUri

Поля

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 - тип этого объекта файла

Методы

openInputStream

public InputStream openInputStream()
                            throws IOException

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

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

openOutputStream

public OutputStream openOutputStream()
                              throws IOException

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

Определено в:
openOutputStream в интерфейсе FileObject
Возвращает:
поток OutputStream
Выбрасывает:
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

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

Определено в:
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() и FileObject.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, 2020, 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/11/docs/api/java.compiler/javax/tools/SimpleJavaFileObject.html

Spec-Zone .ru
спецификации, руководства, описания, API