Java Documentation
Dr. Safwan Qasem
King Saud University
College of Computer and Information Sciences
Computer Science Deptment
Java online documentation
2
Java provide a very big collection of ready-to-use
classes to perform a very wide programming tasks:
String
manipulation, Math computations, File I/O,
Database access, Networking, Data transfer, …
Graphical user interface building, 2D and 3D graphics,
game development
…
In the scope of this course it is not possible to see all
the classes and tools that may be needed by an
advanced programmer.
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java online documentation
3
In this presentation, we present the detailed on-line
java documentation. A student should be able to:
Know what a specific, package, class or method does.
Search for any classes that may fit his specific
programming needs.
Find all the available parameters and methods of a
specific class.
Find the exact syntax of a method to be used.
…
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java technology Network
[Link]
4
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java technology Network
[Link]
5
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
[Link]
6
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
[Link]
7
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
Programmer guide and tutorials
8
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
Java API Documentation
9
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java API Documentation
[Link]
10
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
[Link]
11
Java
Classes
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
[Link]
12
Packages
Names
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Documentation
[Link]
13
Packages
Description
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Package View
14
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Package View
15
One line description
Package [Link]
Contains all of the classes for creating user interfaces and for painting graphics and images.
Interface Summary
Adjustable The interface for objects which have an adjustable numeric value contained within a bounded
range of values.
Composite The Composite interface, along with CompositeContext, defines the methods to compose a draw
primitive with the underlying graphics area.
ItemSelectable The interface for objects which contain a set of items for which zero or more can be
selected.
MenuContainer The super class of all menu related containers.
…..
Class Summary
Button This class creates a labeled button.
Checkbox A check box is a graphical component that can be in either an "on" (true) or "off" (false) state.
CheckboxGroup The CheckboxGroup class is used to group together a set of Checkbox buttons.
CheckboxMenuItem This class represents a check box that can be included in a menu.
Choice The Choice class presents a pop-up menu of choices.
Component A component is an object having a graphical representation that can be displayed on the
screen and that can interact with the user.
…..
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Package View
16
Enum Summary
[Link] Enumeration of the common ways the baseline of a component
can change as the size changes.
[Link] Represents an action type (BROWSE, EDIT, OPEN…).
…
Exception Summary
FontFormatException Thrown by method createFont in the Font class to indicate that the specified font
is bad.
IllegalComponentStateException Signals that an AWT component is not in an appropriate state for the
requested operation.
…
Error Summary
AWTError Thrown when a serious Abstract Window Toolkit error has occurred.
Package <package name> Description
Contains all of the classes for creating user interfaces and for painting graphics and images. A user
interface object such as a button or a scrollbar is called, in AWT terminology, a component. The
Component class is the root of all AWT components. See Component for a detailed description of
properties that all AWT components share.….
Additional Specification
refers to some additional tutorials and documentation.
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Class View (example Class Math)
17
Package
[Link] => [Link]
Description
The class Math contains methods for performing basic numeric operations such as the elementary
exponential, logarithm, square root, and trigonometric functions.
Field Summary
static double E
The double value that is closer than any other to e, the base of the natural logarithms.
static double PI
The double value that is closer than any other to pi, the ratio of the circumference of a circle to
its diameter.
Method Summary
static double abs(double a)
Returns the absolute value of a double value.
static float abs(float a)
Returns the absolute value of a float value.
static int abs(int a)
Returns the absolute value of an int value.
static long abs(long a)
Returns the absolute value of a long value.
……
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Method details (example float abs(float a) )
18
abs
public static float abs(float a)
Returns the absolute value of a float value. If the argument is not negative, the argument is
returned. If the argument is negative, the negation of the argument is returned. Special
cases:
If the argument is positive zero or negative zero, the result is positive zero.
If the argument is infinite, the result is positive infinity.
If the argument is NaN, the result is NaN.
In other words, the result is the same as the value of the expression:
[Link](0x7fffffff & [Link](a))
Parameters: a - the argument whose absolute value is to be determined
Returns: the absolute value of the argument.
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
Java Code samples
[Link]
19
Code Samples is a collection of code snippets exemplifying the Java
programming language and other languages. Example code comes from
various published documents on [Link], and are also provided by the
developer community. They are organized by topic.
Java Platform, Standard Edition (Java SE)
Language Syntax
Numbers and Math Operations
Life Cycle of An Object
Reading and Writing Data
Classes and Inheritance
Reflection
Threaded Programs
Swing and GUI Programming
Multi-Media
Error Handling
Internationalization
Dr. Safwan Qasem, 2010 KSU-CCIS-CS
