API Help (cliente do App Engine para Google Cloud Storage 0.6 API)

Como a documentação desta API está organizada

A documentação desta API (Interface de programação do aplicativo) apresenta páginas referentes aos itens da barra de navegação, descritos a seguir.
  • Visão geral

    A página Visão geral é a primeira página da documentação desta API. Ela fornece uma lista de todos os pacotes com um resumo de cada um. Ela também pode conter uma descrição geral do conjunto de pacotes.

  • Pacote

    Cada pacote apresenta uma página contendo uma lista de classes e interfaces, com um resumo de cada. Nessa página, podem estar incluídas seis categorias:

    • interfaces (itálico)
    • classes
    • enums
    • exceções
    • erros
    • tipos de anotação
  • Classe/interface

    Cada classe, interface, classe aninhada e interface aninhada tem sua própria página separada. Cada uma dessas páginas apresenta três seções, que consistem em uma descrição da 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 da classe/interface
    • descrição da classe/interface
    • resumo da classe aninhada
    • resumo do campo
    • resumo do construtor
    • resumo do método
    • detalhes do campo
    • detalhes do construtor
    • detalhes do método

    Cada entrada de resumo contém a primeira frase da descrição detalhada desse item. As entradas de resumo estão em ordem alfabética. Já 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
  • Enum

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

    • declaração do enum
    • descrição do enum
    • resumo da constante de enum
    • detalhes da constante de enum
  • Uso

    Cada interface, classe e pacote documentado tem sua própria página Uso. Ela descreve quais pacotes, classes, métodos, construtores e campos usam alguma parte da classe ou do pacote especificado. A página Uso de uma classe ou interface A inclui subclasses de A, campos declarados como A, métodos que retornam A e métodos e construtores com parâmetros do tipo A. Para acessar a página, vá até o pacote, a classe ou a interface e clique no link "Usar" na barra de navegação.

  • Árvore (hierarquia de classes)

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

    • Ao exibir a página de visão geral, se você clicar em "Árvore" será mostrada a hierarquia de todos os pacotes.
    • Ao exibir a página de um determinado pacote, classe ou interface, se você clicar em "Árvore", será mostrada a hierarquia apenas desse pacote.
  • API obsoleta

    A página API obsoleta lista todas as APIs que ficaram obsoletas. Não é recomendável usar uma API que tenha ficado obsoleta (em geral, devido a aprimoramentos). Normalmente, uma API substituta é usada. As APIs obsoletas poderão ser removidas nas implementações futuras.

  • Índice

    O Índice contém uma lista alfabética de todos os campos, métodos, construtores, interfaces e classes.

  • Anterior/próxima

    Estes links encaminham você para a classe, a interface, o pacote ou a página relacionada seguinte ou anterior.

  • Frames/sem frames

    Estes links exibem e ocultam os frames HTML. Todas as páginas estão disponíveis com ou sem frames.

  • Todas as classes

    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 externalizável tem uma descrição de seus métodos e campos de serialização. Essa informação é do interesse de re-implementadores, mas não de desenvolvedores que usam a API. Embora não haja um link na barra de navegação, é possível receber essa informação indo para qualquer classe serializada e clicando em "Formulário serializado" na seção "Veja também" da descrição da classe.

  • Valores de campo constante

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

Este arquivo de ajuda aplica-se à documentação da API gerada por meio do doclet padrão.

Copyright © 2016 Google. Todos os direitos reservados.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente padrão do App Engine para Java