compact3

javax.tools

Класс ForwardingJavaFileManager <М. расширяет JavaFileManager>

java.lang. Объект

javax.tools. ForwardingJavaFileManager <M>

Введите Параметры:

M - вид файлового менеджера, переданного этим объектом

Все Реализованные Интерфейсы:

Closeable, Flushable, AutoCloseable, JavaFileManager, OptionChecker

public class ForwardingJavaFileManager<M extends JavaFileManager>
extends Object
implements JavaFileManager

Вперед звонки в данный файловый менеджер. Подклассы этого class могли бы переопределить некоторые из этих методов и могли бы также обеспечить дополнительные поля и методы.

С тех пор:

1.6

Вложенная Сводка Класса

Вложенные классы/интерфейсы, наследованные от интерфейса javax.tools. JavaFileManager

JavaFileManager. Расположение

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
protected M	fileManager Файловый менеджер, к которому делегируются все методы.

Сводка конструктора

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

Модификатор	Конструктор и Описание
protected	ForwardingJavaFileManager(M fileManager) Создает новый экземпляр ForwardingJavaFileManager.

Сводка метода

Модификатор и Тип	Метод и Описание
void	close() Высвобождает любые средства, открытые этим файловым менеджером прямо или косвенно.
void	flush() Сбросы любые ресурсы, открытые для вывода этим файловым менеджером прямо или косвенно.
ClassLoder	getClassLoader(JavaFileManager.Location location) Получает загрузчик class для того, чтобы он загрузил плагины из данного расположения.
FileObject	getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) Получает объект файла для ввода, представляющего указанное относительное имя в указанном пакете в данном расположении.
FileObject	getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) Получает объект файла для вывода, представляющего указанное относительное имя в указанном пакете в данном расположении.
JavaFileObject	getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) Получает объект файла для ввода, представляющего указанный class указанного вида в данном расположении.
JavaFileObject	getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) Получает объект файла для вывода, представляющего указанный class указанного вида в данном расположении.
boolean	handleOption(String current, Iterator<String> remaining) Дескрипторы одна опция.
boolean	hasLocation(JavaFileManager.Location location) Определяет, известно ли расположение этому файловому менеджеру.
Строка	inferBinaryName(JavaFileManager.Location location, JavaFileObject file) Выводит двоичное имя файла, основанного на объектах на расположении.
boolean	isSameFile(FileObject a, FileObject b) Сравнивает два объекта файла, и возвратите true, если они представляют тот же самый базовый объект.
int	isSupportedOption(String option) Определяет, поддерживается ли данная опция и если так, число параметров, опция берет.
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) Списки все объекты файла, соответствующие данные критерии в данном расположении.

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

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

Полевая Деталь

fileManager

protected final M extends JavaFileManager fileManager

Файловый менеджер, к которому делегируются все методы.

Деталь конструктора

ForwardingJavaFileManager

protected ForwardingJavaFileManager(M fileManager)

Создает новый экземпляр ForwardingJavaFileManager.

Параметры:

fileManager - делегируйте к этому файловому менеджеру

Деталь метода

getClassLoader

public ClassLoader getClassLoader(JavaFileManager.Location location)

Описание скопировало с интерфейса: JavaFileManager

Получает загрузчик class для того, чтобы он загрузил плагины из данного расположения. Например, чтобы загрузить процессоры аннотации, компилятор запросит загрузчик class на ANNOTATION_PROCESSOR_PATH расположение.

Определенный:

getClassLoader в интерфейсе JavaFileManager

Параметры:

location - расположение

Возвраты:

загрузчик class для данного расположения; или null если загрузка плагинов от данного расположения отключается или если расположение не известно

Броски:

SecurityException - если загрузчик class не может быть создан в текущем контексте защиты

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

список

public Iterable<JavaFileObject> list(JavaFileManager.Location location,
                                     String packageName,
                                     Set<JavaFileObject.Kind> kinds,
                                     boolean recurse)
                              throws IOException

Описание скопировало с интерфейса: JavaFileManager

Списки все объекты файла, соответствующие данные критерии в данном расположении. Объекты файла списка в "подпакетах", если рекурсивно вызывают, являются истиной.

Отметьте: даже если данное расположение неизвестно этому файловому менеджеру, оно, возможно, не возвращается null. Кроме того, неизвестное расположение, возможно, не вызывает исключение.

Определенный:

list в интерфейсе JavaFileManager

Параметры:

location - расположение

packageName - имя пакета

kinds - возвратите объекты только этих видов

recurse - если истина включает "подпакеты"

Возвраты:

Повторяемый из объектов файла, соответствующих данные критерии

Броски:

IOException - если ошибка ввода-вывода произошла, или если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

inferBinaryName

public String inferBinaryName(JavaFileManager.Location location,
                              JavaFileObject file)

Описание скопировало с интерфейса: JavaFileManager

Выводит двоичное имя файла, основанного на объектах на расположении. Двоичное возвращенное имя не могло бы быть допустимым двоичным именем согласно Спецификации языка Java™.

Определенный:

inferBinaryName в интерфейсе JavaFileManager

Параметры:

location - расположение

file - объект файла

Возвраты:

двоичное имя или null объект файла не находится в данном расположении

Броски:

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

isSameFile

public boolean isSameFile(FileObject a,
                          FileObject b)

Описание скопировало с интерфейса: JavaFileManager

Сравнивает два объекта файла, и возвратите true, если они представляют тот же самый базовый объект.

Определенный:

isSameFile в интерфейсе JavaFileManager

Параметры:

a - объект файла

b - объект файла

Возвраты:

истина, если данные объекты файла представляют тот же самый базовый объект

Броски:

IllegalArgumentException - если любой из параметров создавался с другим файловым менеджером, и этот файловый менеджер не поддерживает внешние объекты файла

handleOption

public boolean handleOption(String current,
                            Iterator<String> remaining)

Описание скопировало с интерфейса: JavaFileManager

Дескрипторы одна опция. Если current опция к этому файловому менеджеру, от которого она использует любые параметры той опции remaining и возвратите true, иначе возвратите false.

Определенный:

handleOption в интерфейсе JavaFileManager

Параметры:

current - текущая опция

remaining - оставление опциями

Возвраты:

истина, если эта опция была обработана этим файловым менеджером, ложь иначе

Броски:

IllegalArgumentException - если эта опция к этому файловому менеджеру используется неправильно

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

hasLocation

public boolean hasLocation(JavaFileManager.Location location)

Описание скопировало с интерфейса: JavaFileManager

Определяет, известно ли расположение этому файловому менеджеру.

Определенный:

hasLocation в интерфейсе JavaFileManager

Параметры:

location - расположение

Возвраты:

истина, если расположение известно

isSupportedOption

public int isSupportedOption(String option)

Описание скопировало с интерфейса: OptionChecker

Определяет, поддерживается ли данная опция и если так, число параметров, опция берет.

Определенный:

isSupportedOption в интерфейсе OptionChecker

Параметры:

option - опция

Возвраты:

число параметров, которые данная опция берет или-1, если опция не поддерживается

getJavaFileForInput

public JavaFileObject getJavaFileForInput(JavaFileManager.Location location,
                                          String className,
                                          JavaFileObject.Kind kind)
                                   throws IOException

Описание скопировало с интерфейса: JavaFileManager

Получает объект файла для ввода, представляющего указанный class указанного вида в данном расположении.

Определенный:

getJavaFileForInput в интерфейсе JavaFileManager

Параметры:

location - расположение

className - имя class

kind - вид файла, должен быть один из SOURCE или CLASS

Возвраты:

объект файла, мог бы возвратиться null если файл не существует

Броски:

IllegalArgumentException - если расположение не известно этому файловому менеджеру, и файловый менеджер не поддерживает неизвестные расположения, или если вид не допустим

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

IOException - если ошибка ввода-вывода произошла, или если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

getJavaFileForOutput

public JavaFileObject getJavaFileForOutput(JavaFileManager.Location location,
                                           String className,
                                           JavaFileObject.Kind kind,
                                           FileObject sibling)
                                    throws IOException

Описание скопировало с интерфейса: JavaFileManager

Получает объект файла для вывода, представляющего указанный class указанного вида в данном расположении.

Дополнительно, этот файловый менеджер мог бы рассмотреть одноуровневый элемент как подсказку для того, куда поместить вывод. Точная семантика этой подсказки является неуказанной. Компилятор JDK, javac, например, поместит файлы class в те же самые каталоги как порождающий исходные файлы, если выходной каталог файла class не будет обеспечен. Чтобы облегчить это поведение, javac мог бы обеспечить инициирующий исходный файл как одноуровневый элемент, вызывая этот метод.

Определенный:

getJavaFileForOutput в интерфейсе JavaFileManager

Параметры:

location - расположение

className - имя class

kind - вид файла, должен быть один из SOURCE или CLASS

sibling - объект файла, который будет использоваться в качестве подсказки для размещения; мог бы быть null

Возвраты:

объект файла для вывода

Броски:

IllegalArgumentException - если одноуровневый элемент не известен этому файловому менеджеру, или если расположение не известно этому файловому менеджеру, и файловый менеджер не поддерживает неизвестные расположения, или если вид не допустим

IllegalStateException - JavaFileManager.close() вызвали, и этот файловый менеджер не может быть вновь открыт

IOException - если ошибка ввода-вывода произошла, или если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

getFileForInput

public FileObject getFileForInput(JavaFileManager.Location location,
                                  String packageName,
                                  String relativeName)
                           throws IOException

Описание скопировало с интерфейса: JavaFileManager

Получает объект файла для ввода, представляющего указанное относительное имя в указанном пакете в данном расположении.

Если возвращенный объект представляет источник или файл class, это должен быть экземпляр JavaFileObject.

Неофициально, объект файла, возвращенный этим методом, располагается в связи расположения, имени пакета, и относительного имени. Например, чтобы определить местоположение файла свойств "resources/compiler.properties" в пакете "com.sun.tools.javac" в расположении SOURCE_PATH, как этот метод можно было бы вызвать так:

getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

Если вызов выполнялся на Windows с набором SOURCE_PATH к "C:\Documents and Settings\UncleBob\src\share\classes", допустимым результатом был бы объект файла представление файла "C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties".

Определенный:

getFileForInput в интерфейсе JavaFileManager

Параметры:

location - расположение

packageName - имя пакета

relativeName - относительное имя

Возвраты:

объект файла, мог бы возвратиться null если файл не существует

Броски:

IllegalArgumentException - если расположение не известно этому файловому менеджеру, и файловый менеджер не поддерживает неизвестные расположения, или если relativeName не допустимо

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

IOException - если ошибка ввода-вывода произошла, или если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

getFileForOutput

public FileObject getFileForOutput(JavaFileManager.Location location,
                                   String packageName,
                                   String relativeName,
                                   FileObject sibling)
                            throws IOException

Описание скопировало с интерфейса: JavaFileManager

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

Дополнительно, этот файловый менеджер мог бы рассмотреть одноуровневый элемент как подсказку для того, куда поместить вывод. Точная семантика этой подсказки является неуказанной. Компилятор JDK, javac, например, поместит файлы class в те же самые каталоги как порождающий исходные файлы, если выходной каталог файла class не будет обеспечен. Чтобы облегчить это поведение, javac мог бы обеспечить инициирующий исходный файл как одноуровневый элемент, вызывая этот метод.

Если возвращенный объект представляет источник или файл class, это должен быть экземпляр JavaFileObject.

Неофициально, объект файла, возвращенный этим методом, располагается в связи расположения, имени пакета, и относительного имени или рядом с одноуровневым параметром. См. getFileForInput для примера.

Определенный:

getFileForOutput в интерфейсе JavaFileManager

Параметры:

location - расположение

packageName - имя пакета

relativeName - относительное имя

sibling - объект файла, который будет использоваться в качестве подсказки для размещения; мог бы быть null

Возвраты:

объект файла

Броски:

IllegalArgumentException - если одноуровневый элемент не известен этому файловому менеджеру, или если расположение не известно этому файловому менеджеру, и файловый менеджер не поддерживает неизвестные расположения, или если relativeName не допустимо

IllegalStateException - если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

IOException - если ошибка ввода-вывода произошла, или если JavaFileManager.close() был вызван и этот файловый менеджер не может быть вновь открыт

сброс

public void flush()
           throws IOException

Описание скопировало с интерфейса: JavaFileManager

Сбросы любые ресурсы, открытые для вывода этим файловым менеджером прямо или косвенно. Сбрасывание закрытого файлового менеджера не имеет никакого эффекта.

Определенный:

flush в интерфейсе Flushable

Определенный:

flush в интерфейсе JavaFileManager

Броски:

IOException - если ошибка ввода-вывода произошла

См. Также:

JavaFileManager.close()

близко

public void close()
           throws IOException

Описание скопировало с интерфейса: JavaFileManager

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

Определенный:

close в интерфейсе Closeable

Определенный:

close в интерфейсе AutoCloseable

Определенный:

close в интерфейсе JavaFileManager

Броски:

IOException - если ошибка ввода-вывода произошла

См. Также:

JavaFileManager.flush()