Класс 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 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`.
`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.
`String`	`toString()` Возвращает строковое представление объекта.
`URI`	`toUri()` Возвращает URI, идентифицирующий этот объект файла.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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()

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

toString

public String toString()

Описание скопировано из класса: Object

Возвращает строковое представление объекта. В общем случае, метод toString возвращает строку, которая "текстово представляет" этот объект. Результат должен быть кратким, но информативным представлением, легко читаемым человеком. Рекомендуется переопределять этот метод во всех подклассах.

Метод toString для класса Object возвращает строку, состоящую из имени класса, экземпляром которого является объект, символа "@" и шестнадцатеричного представления хэш-кода объекта. Другими словами, этот метод возвращает строку, равную значению:

getClass().getName() + '@' + Integer.toHexString(hashCode())

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта.

© 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.