Как Этот Документ API Организуется

У этого API (Прикладной программный интерфейс) документ есть страницы, соответствующие элементам в панели навигации, описанной следующим образом.

Краткий обзор

Страница Краткого обзора является первой полосой этого документа API и обеспечивает список всех пакетов со сводкой для каждого. Эта страница может также содержать полное описание набора пакетов.

Пакет

У каждого пакета есть страница, которая содержит список ее классов и интерфейсов со сводкой для каждого. Эта страница может содержать шесть категорий:

• Интерфейсы (курсив)
• Классы
• Перечисления
• Исключения
• Ошибки
• Типы аннотации

Класс/Интерфейс

У каждого класса, интерфейса, вложенного класса и вложенного интерфейса есть своя собственная отдельная страница. У каждой из этих страниц есть три раздела, состоящие из описания класса/интерфейса, сводных таблиц, и детализированных задействованных описаний:

• Схема наследования классов
• Прямые Подклассы
• Все Известные Подынтерфейсы
• Все Известные Классы с реализацией
• Объявление класса/интерфейса
• Описание класса/интерфейса

• Вложенная Сводка Класса
• Полевая Сводка
• Сводка конструктора
• Сводка метода

• Полевая Деталь
• Деталь конструктора
• Деталь метода

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

Тип аннотации

У каждого типа аннотации есть свое собственное, разделяют страницу следующими разделами:

• Описание типа аннотации
• Описание Типа аннотации
• Необходимая Сводка Элемента
• Дополнительная Сводка Элемента
• Деталь элемента

Перечисление

У каждого перечисления есть свое собственное, разделяют страницу следующими разделами:

• Перечислимое объявление
• Перечислимое описание
• Перечислимая Постоянная Сводка
• Перечислимая Постоянная Деталь

Использование

У каждого задокументированного пакета, класса и интерфейса есть своя собственная страница Использования. Эта страница описывает то, что упаковывает, классы, методы, конструкторы и поля используют любую часть данного класса или пакета. Учитывая класс или интерфейс A, его страница Использования включает подклассы A, поля, объявленные как A, методы, которые возвращают A, и методы и конструкторов с параметрами типа A. Можно получить доступ к этой странице первым движением к пакету, классу или интерфейсу, затем щелкая по ссылке "Использования" в панели навигации.

Дерево (Иерархия классов)

Есть страница Иерархии классов для всех пакетов плюс иерархия для каждого пакета. Каждая страница иерархии содержит список классов и список интерфейсов. Классы организуются структурой наследования, запускающейся с java.lang.Object. Интерфейсы не наследовались от java.lang.Object.

• Когда просмотр страницы Краткого обзора, щелчок "по Дереву" выводят на экран иерархию для всех пакетов.
• Когда просмотр определенного пакета, класса или интерфейсной страницы, щелчок по "Tree" выводят на экран иерархию для только того пакета.

Устаревший API

Осуждаемая страница API перечисляет весь API, который был осужден. Устаревший API не рекомендуется для использования, обычно из-за улучшений, и заменяющий API обычно дается. Осуждаемые API могут быть удалены в будущих реализациях.

Индекс

Индекс содержит алфавитный список всех классов, интерфейсов, конструкторов, методов, и полей.

Предыдущий/Следующий

Эти ссылки берут Вас к следующему или предыдущему классу, интерфейсу, пакету, или связанной странице.

Фреймы фреймов/Нет

Эти ссылки показывают и скрывают фреймы HTML. Все страницы доступны с или без фреймов.

Все Классы

Вся ссылка Классов показывает все классы и интерфейсы кроме нестатических вложенных типов.

Сериализированная Форма

У каждого сериализуемого или externalizable класса есть описание его полей сериализации и методов. Эта информация представляет интерес для переконструкторов, не разработчикам, использующим API. В то время как нет никакой ссылки в панели навигации, можно добраться до этой информации, идя в любой сериализированный класс, и щелчок "Сериализированная Форма" в "Видит также" раздел описания класса.

Постоянные Значения полей

<href = "constant-values.html"> Постоянные Значения полей </a> страница перечисляет статические заключительные поля и их значения.

Этот справочный файл применяется к сгенерированному использованию документации API стандарта doclet.