1. Curso Superior de Tecnologia em Telemática
Programação Orientada a Objetos
Documentação da API J2SE
Copyright©2010
Prof. César Rocha – cesarocha@ifpb.edu.br

2. Roteiro
• Em poucos slides, apresentar alguns aspectos importantes
relacionados à consulta da documentação da API J2SE
– Onde encontrar a documentação da API? Quais são os arquivos e como
instalá-los? Integração da documentação J2SE no Eclipse, etc.
• A importância de consultar a documentação J2SE em projetos
– Componentes de uma classe e sua toda sua divisão interna
• Como gerar a própria documentação das suas classes
– O utilitário javadoc, a sintaxe de documentação, exemplos, ...
2

3. Documentação
• Aprender a usar a documentação é fundamental
– Baixe o arquivo contendo toda a documentação J2SE no site da SUN
• O download é separado do J2SE (ou seja: não vem integrado ao JDK)
• Como instalar a documentação Java?
– Descompacte o arquivo ZIP na raiz da sua instalação Java
• Será criado um subdiretório docs abaixo da raiz da instalação Java
• %JAVA_HOME%/docs/
– A documentação da API Java está em:
• $JAVA_HOME/docs/api/index.html
– Manuais, tutoriais sobre recursos da linguagem em:
• $JAVA_HOME/docs/index.html
3

4. Como utilizar a documentação?
Descrição da classe escolhida
na janela B
Se o método não for encontrado - hierarquia
na classe mostrada, procure nas - documentação detalhada,
superclasses (use as referências métodos, variáveis, etc.
cruzadas)
Lista de pacotes A
B C
Lista de classes e
interfaces do pacote
escolhido na Janela A
4

5. Como utilizar a documentação?(cont.)
5

6. Como utilizar a documentação?(cont.)
6

7. Como utilizar a documentação?(cont.)
• Lista de construtores, métodos e descrição geral da interface de uso
7

8. Integração com o Eclipse
• É possível agilizar a consulta na documentação J2SE dentro do Eclipse
– O “javadoc” das classes não vem ativado por padrão no Eclipse
• Entretanto, é fácil fazer o Eclipse “vasculhar” os arquivos html em busca de um
determinado método, construtor, classe, interface ou descrição de um membro
• No Eclipse, procure como o ambiente está referenciando a máquina
virtual java do seu computador
– Para tal, procure a opção Window>Preferences>Installed JRE's
– Clique nela e pressione o botão “Edit”
• Procure a biblioteca rt.jar (os .class da API) e a opção Javadoc Location
8

9. Integração com o Eclipse (cont.)
9

10. Gerando seu próprio javadoc...
Laboratório: criar o javadoc de suas classes e membros...
10

11. Para um melhor aproveitamento…
• Ao codificar exemplos mostrados em sala, procure verificar pontos de
dúvidas com o professor.
• Não estude apenas por slides (são apenas tópicos)!
• Mantenha em dia todas as questões das listas de exercícios e práticas
de laboratório.
• Não se acanhe! Procure-me (ou monitor da disciplina, quando houver
algum) e questione conceitos, listas, etc.
• Não deixe para começar a estudar em cima da hora.
11

12. Créditos para geração desta nota de aula
• [1] ROCHA, Helder da. Desenvolvimento de Aplicações com Java. Disponível em:
<http://www.argonavis.com.br/cursos/java/j100/index.html>
• [2] Booch, G.; Maksimchuk, R. A.; Engel, M. W.; Young, B.J. Object-Oriented-Analysis-
Design-Applications. 3rd.Ed. Addison Wesley, 2007
• [3] The Java Tutorial. Disponível em: http://java.sun.com/docs/books/tutorial/
• [4] PEREIRA, Frederico C. G.; Slides do Curso de Java. Disponível por WWW em
http://asterix.coinfo.cefetpb.edu.br/~fred
12

13. Bibliografia Complementar
• Bibliografia principal:
– (1) SIERRA, K.; BATES, B. Use a Cabeça JAVA. Editora Alta Books, 2ª ed. Rio de Janeiro 2007.
– (1)DEITEL, H. M. ; DEITEL, P. Java - Como programar. 6ª Edição, Prentice-Hall, 2005.
– FLANAGAN, D., Java in a Nutshell : A Desktop Quick Reference, O'Reilly & Associates,
1999 (bom para consultar a documentação)
• Bibliografia disponível para download (grátis):
– CAMPIONE, M. e WALRATH, K. The Java Tutorial: Object-Oriented Programming for
the Internet. Addison-Wesley (http://java.sun.com/docs/books/)
– (2) ECKEL, B., Thinking in Java. Prentice Hall. (http://www.mindview.net/Books/TIJ/)
13