Save This Page
Home » openjdk-7 » java » lang » [javadoc | source]
    1   /*
    2    * Copyright 1995-2000 Sun Microsystems, Inc.  All Rights Reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Sun designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Sun in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
   22    * CA 95054 USA or visit www.sun.com if you need additional information or
   23    * have any questions.
   24    */
   25   
   26   package java.lang;
   27   
   28   /**
   29    * An <code>Error</code> is a subclass of <code>Throwable</code>
   30    * that indicates serious problems that a reasonable application
   31    * should not try to catch. Most such errors are abnormal conditions.
   32    * The <code>ThreadDeath</code> error, though a "normal" condition,
   33    * is also a subclass of <code>Error</code> because most applications
   34    * should not try to catch it.
   35    * <p>
   36    * A method is not required to declare in its <code>throws</code>
   37    * clause any subclasses of <code>Error</code> that might be thrown
   38    * during the execution of the method but not caught, since these
   39    * errors are abnormal conditions that should never occur.
   40    *
   41    * @author  Frank Yellin
   42    * @see     java.lang.ThreadDeath
   43    * @since   JDK1.0
   44    */
   45   public class Error extends Throwable {
   46       static final long serialVersionUID = 4980196508277280342L;
   47   
   48       /**
   49        * Constructs a new error with <code>null</code> as its detail message.
   50        * The cause is not initialized, and may subsequently be initialized by a
   51        * call to {@link #initCause}.
   52        */
   53       public Error() {
   54           super();
   55       }
   56   
   57       /**
   58        * Constructs a new error with the specified detail message.  The
   59        * cause is not initialized, and may subsequently be initialized by
   60        * a call to {@link #initCause}.
   61        *
   62        * @param   message   the detail message. The detail message is saved for
   63        *          later retrieval by the {@link #getMessage()} method.
   64        */
   65       public Error(String message) {
   66           super(message);
   67       }
   68   
   69       /**
   70        * Constructs a new error with the specified detail message and
   71        * cause.  <p>Note that the detail message associated with
   72        * <code>cause</code> is <i>not</i> automatically incorporated in
   73        * this error's detail message.
   74        *
   75        * @param  message the detail message (which is saved for later retrieval
   76        *         by the {@link #getMessage()} method).
   77        * @param  cause the cause (which is saved for later retrieval by the
   78        *         {@link #getCause()} method).  (A <tt>null</tt> value is
   79        *         permitted, and indicates that the cause is nonexistent or
   80        *         unknown.)
   81        * @since  1.4
   82        */
   83       public Error(String message, Throwable cause) {
   84           super(message, cause);
   85       }
   86   
   87       /**
   88        * Constructs a new error with the specified cause and a detail
   89        * message of <tt>(cause==null ? null : cause.toString())</tt> (which
   90        * typically contains the class and detail message of <tt>cause</tt>).
   91        * This constructor is useful for errors that are little more than
   92        * wrappers for other throwables.
   93        *
   94        * @param  cause the cause (which is saved for later retrieval by the
   95        *         {@link #getCause()} method).  (A <tt>null</tt> value is
   96        *         permitted, and indicates that the cause is nonexistent or
   97        *         unknown.)
   98        * @since  1.4
   99        */
  100       public Error(Throwable cause) {
  101           super(cause);
  102       }
  103   }

Save This Page
Home » openjdk-7 » java » lang » [javadoc | source]