Como esse documento da API está organizado

Este documento de API (Interface de Programação de Aplicativos) tem páginas correspondentes aos itens na barra de navegação, descritos a seguir.

Visão geral

A página Visão geral é a página inicial desse documento de API e fornece uma lista de todos os pacotes com um resumo para cada um. Esta página também pode conter uma descrição geral do conjunto de pacotes.

Pacote

Cada pacote tem uma página que contém uma lista de suas classes e interfaces, com um resumo de cada uma. Essas páginas podem conter seis categorias:

• Interfaces
• Aulas
• Enumerações
• Exceções
• Errors
• Tipos de anotação

Classe ou Interface

Cada classe, interface, classe aninhada e interface aninhada tem sua própria página separada. Cada uma dessas páginas tem três seções que consistem em uma descrição de classe/interface, tabelas de resumo e descrições detalhadas de membros:

• Diagrama de herança de classes
• Subclasses diretas
• Todas as subinterfaces conhecidas
• Todas as classes de implementação conhecidas
• Declaração de classe ou interface
• Descrição da classe ou interface

• Resumo da classe aninhada
• Resumo do campo
• Resumo da propriedade
• Resumo do construtor
• Resumo do método

• Detalhes do campo
• Detalhes da propriedade
• Detalhes do construtor
• Detalhes do método

Cada entrada de resumo contém a primeira frase da descrição detalhada desse item. As entradas resumidas estão em ordem alfabética, enquanto as descrições detalhadas estão na ordem em que aparecem no código fonte. Isso preserva os agrupamentos lógicos estabelecidos pelo programador.

Tipo de anotação

Cada tipo de anotação tem sua própria página separada com as seguintes seções:

• Declaração do tipo de anotação
• Descrição do tipo de anotação
• Resumo do elemento necessário
• Resumo do elemento opcional
• Detalhes do elemento

enumeração

Cada enumeração tem sua própria página separada com as seguintes seções:

• Declaração Enum
• Descrição da enumeração
• Resumo da constante enumeração
• Detalhes da constante enumeração

Árvore (hierarquia de classes)

Há uma página de hierarquia de classes para todos os pacotes, além de uma hierarquia para cada pacote. Cada página de hierarquia contém uma lista de classes e uma lista de interfaces. As classes são organizadas pela estrutura de herança, começando com java.lang.Object. As interfaces não herdam de java.lang.Object.

• Ao visualizar a página Visão geral, clicar em "Árvore" exibe a hierarquia de todos os pacotes.
• Ao visualizar um determinado pacote, classe ou página de interface, clicar em "Árvore" exibe a hierarquia somente desse pacote.

API obsoleta

A página API obsoleta lista todas as API que foram descontinuadas. Uma API obsoleta não é recomendada para uso, geralmente devido a melhorias, e uma API de substituição geralmente é fornecida. API obsoletas podem ser removidas em implementações futuras.

Index

O Índice contém um índice alfabético de todas as classes, interfaces, construtores, métodos e campos, bem como listas de todos os pacotes e todas as classes.

Todas as turmas

O link Todas as Classes mostra todas as classes e interfaces, exceto tipos aninhados não estáticos.

Formulário serializado

Cada classe serializável ou externamente tem uma descrição de seus campos e métodos de serialização. Essas informações são do interesse dos re-implementadores, não dos desenvolvedores que usam a API. Embora não haja um link na barra de navegação, você pode obter essas informações acessando qualquer classe serializada e clicando em "Formulário serializado" na seção "Consulte também" da descrição da classe.

Valores de campo constantes

A página Valores de Campo Constantes lista os campos finais estáticos e seus valores.

Pesquisa

Você pode pesquisar definições de módulos, pacotes, tipos, campos, métodos e outros termos definidos na API, usando parte ou todo o nome. Abreviações "camelo" são suportadas: por exemplo, "InpStr" encontrará "InputStream" e "InputStreamReader".

Este arquivo de ajuda se aplica à documentação da API gerada pelo doclet padrão.