compact3

javax.tools

Интерфейс JavaFileManager

Все Суперинтерфейсы:

AutoCloseable, Closeable, Flushable, OptionChecker

Все Известные Подынтерфейсы:

StandardJavaFileManager

Все Известные Классы с реализацией:

ForwardingJavaFileManager

public interface JavaFileManager
extends Closeable, Flushable, OptionChecker

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

Создавая новый JavaFileObjects, файловый менеджер должен определить, где создать их. Например, если бы файловый менеджер управляет регулярными файлами на файловой системе, у него наиболее вероятно был бы текущий/рабочий каталог, чтобы использовать в качестве расположения значения по умолчанию, создавая или находя файлы. Много подсказок могут быть обеспечены для файлового менеджера как, туда, где создать файлы. Любой файловый менеджер мог бы хотеть игнорировать эти подсказки.

Некоторые методы в этом интерфейсе используют имена class. Такие имена class должны быть даны в виртуальной машине Java внутреннюю форму полностью определенного class и имен интерфейса. Для удобства '.' и '/' являются взаимозаменяемыми. Внутренняя форма определяется в главе четыре из Спецификации Виртуальной машины Java™.

Обсуждение: это означает, что имена "java/lang.package-info", "java/lang/package-info", "java.lang.package-информация", допустимы и эквивалентны. Сравнитесь с двоичным именем как определено в Спецификации языка Java™, раздел 13.1" Форма Двоичного файла".

Случай имен является существенным. Все имена должны быть обработаны как чувствительные к регистру. Например, у некоторых файловых систем есть нечувствительные к регистру, осведомленные о случае имена файлов. Объекты файла, представляющие такие файлы, должны заботиться, чтобы сохранить случай при использовании File.getCanonicalFile() или подобные средства. Если система не осведомлена о случае, объекты файла должны использовать другие средства сохранить случай.

Относительные имена: некоторые методы в этом интерфейсе используют относительные имена. Относительное имя является ненулем, непустой последовательностью сегментов пути, разделенных '/' '.' или '..' недопустимые сегменты пути. Допустимое относительное имя должно соответствовать "беспочвенное путем" правило RFC 3986, раздел 3.3. Неофициально, это должно быть истиной:

  URI.create(relativeName).normalize().getPath().equals(relativeName)

Все методы в этом интерфейсе могли бы бросить SecurityException.

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

Примечание реализации: последствие этого требования - то, что тривиальная реализация вывода к JarOutputStream не является достаточной реализацией. Таким образом, вместо того, чтобы создавать JavaFileObject, который возвращает JarOutputStream непосредственно, содержание должно кэшироваться пока не закрыто и затем записано JarOutputStream.

Если явно не позволено, все методы в этом интерфейсе могли бы бросить NullPointerException если дано a null параметр.

С тех пор:

1.6

См. Также:

JavaFileObject, FileObject

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

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

Модификатор и Тип	Интерфейс и Описание
static interface	JavaFileManager. Расположение Интерфейс для расположений объектов файла.

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

Модификатор и Тип	Метод и Описание
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, если они представляют тот же самый базовый объект.
Iterable<JavaFileObject>	list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) Списки все объекты файла, соответствующие данные критерии в данном расположении.

Методы, наследованные от интерфейса javax.tools. OptionChecker

isSupportedOption

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

getClassLoader

ClassLoader getClassLoader(JavaFileManager.Location location)

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

Параметры:

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

Возвраты:

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

Броски:

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

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

список

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

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

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

Параметры:

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

packageName - имя пакета

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

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

Возвраты:

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

Броски:

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

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

inferBinaryName

String inferBinaryName(JavaFileManager.Location location,
                       JavaFileObject file)

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

Параметры:

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

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

Возвраты:

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

Броски:

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

isSameFile

boolean isSameFile(FileObject a,
                   FileObject b)

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

Параметры:

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

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

Возвраты:

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

Броски:

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

handleOption

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

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

Параметры:

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

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

Возвраты:

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

Броски:

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

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

hasLocation

boolean hasLocation(JavaFileManager.Location location)

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

Параметры:

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

Возвраты:

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

getJavaFileForInput

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

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

Параметры:

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

className - имя class

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

Возвраты:

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

Броски:

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

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

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

getJavaFileForOutput

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

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

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

Параметры:

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

className - имя class

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

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

Возвраты:

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

Броски:

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

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

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

getFileForInput

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

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

Если возвращенный объект представляет источник или файл 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".

Параметры:

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

packageName - имя пакета

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

Возвраты:

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

Броски:

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

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

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

getFileForOutput

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

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

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

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

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

Параметры:

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

packageName - имя пакета

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

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

Возвраты:

объект файла

Броски:

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

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

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

сброс

void flush()
    throws IOException

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

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

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

Броски:

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

См. Также:

close()

близко

void close()
    throws IOException

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

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

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

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

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

Броски:

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

См. Также:

flush()