Как этот документ API организован

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

Обзор

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

Пакет

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

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

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

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

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

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

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

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

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

Каждый тип аннотации имеет свое собственное, разделяют страницу следующими разделами:

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

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

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

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

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

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

• Когда просматривание страницы Overview, нажатие на "Tree" отображают иерархию для всех пакетов.
• Когда просмотр конкретного пакета, класса или интерфейсной страницы, нажатие на "Tree" отображают иерархию только для того пакета.

API устаревший

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

Индекс

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

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

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

Системы координат систем координат/Нет

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

Все классы

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

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

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

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

Страница Constant Field Values перечисляет статические итоговые поля и их значения.

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