DOCUMENTATION COMMENTS

Example

18.5

@exception IndexOutOfBoundsException

the matrix is too large

@exception UnflangedWidgetException the widget does not

have a flange, or its flange has size zero

@exception java.io.FileNotFoundException the file

does not exist

The information in an

@exception

 paragraph should consist of the name of

an exception class (which may be a simple name or a qualified name) followed by

a short description of the circumstances that cause the exception to be thrown.

A documentation comment may contain more than one

@exception

 tag.

18.5   Example

Here, as an example, is a version of the source code for the class

Object

 of the

package

java.lang

, including its documentation comments.

/*

 * @(#)Object.java 1.37 96/06/26

 *

 * Copyright (c) 1994, 1995, 1996 Sun Microsystems, Inc.

 * All Rights Reserved.

 *

 * Permission to use, copy, modify, and distribute this

 * software and its documentation for NON COMMERCIAL purposes

 * and without fee is hereby granted provided that this

 * copyright notice appears in all copies. Please refer to

 * the file "copyright.html" for further important copyright

 * and licensing information.

 *

 * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE

 * SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED,

 * INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF

 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR

 * NON INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES

 * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR

 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.

 */

package java.lang;

/**

 * The root of the Class hierarchy.  Every Class in the

 * system has Object as its ultimate parent.  Every variable

 * and method defined here is available in every Object.

 * @see

Class

 * @version

1.37, 26 Jun 1996

 */

423