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

Этот документ API (Application Programming Interface) имеет страницы, соответствующие элементам панели навигации, описанным ниже.

Обзор

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

Пакет

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

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

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

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

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

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

• Сведения о месторождении
• Детализация конструктора
• Детали метода

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

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

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

• Объявление типа аннотации
• Описание типа аннотации
• Сводные данные необходимых элементов
• Дополнительные сводные данные элементов
• Детализация элемента

Enum

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

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

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

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

• При просмотре страницы «Обзор» при нажатии кнопки «Дерево» отображается иерархия для всех пакетов.
• При просмотре определенного пакета, класса или страницы интерфейса при нажатии кнопки «Дерево» отображается иерархия только для этого пакета.

Устаревший API

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

Индекс

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

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

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

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

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

Все классы

Ссылка «Все классы» показывает все классы и интерфейсы, кроме нестатических вложенных типов.

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

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

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

На странице «Постоянные значения полей» перечислены статические конечные поля и их значения.

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