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

    1   /*
    2    * Copyright (c) 1995, 2011, Oracle and/or its affiliates. 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.  Oracle designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
   22    * or visit www.oracle.com if you need additional information or have any
   23    * questions.
   24    */
   25   
   26   package java.lang;
   27   
   28   /**
   29    * An {@code Error} is a subclass of {@code Throwable}
   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} error, though a "normal" condition,
   33    * is also a subclass of {@code Error} because most applications
   34    * should not try to catch it.
   35    * <p>
   36    * A method is not required to declare in its {@code throws}
   37    * clause any subclasses of {@code Error} 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    * That is, {@code Error} and its subclasses are regarded as unchecked
   42    * exceptions for the purposes of compile-time checking of exceptions.
   43    *
   44    * @author  Frank Yellin
   45    * @see     java.lang.ThreadDeath
   46    * @jls 11.2 Compile-Time Checking of Exceptions
   47    * @since   JDK1.0
   48    */
   49   public class Error extends Throwable {
   50       static final long serialVersionUID = 4980196508277280342L;
   51   
   52       /**
   53        * Constructs a new error with {@code null} as its detail message.
   54        * The cause is not initialized, and may subsequently be initialized by a
   55        * call to {@link #initCause}.
   56        */
   57       public Error() {
   58           super();
   59       }
   60   
   61       /**
   62        * Constructs a new error with the specified detail message.  The
   63        * cause is not initialized, and may subsequently be initialized by
   64        * a call to {@link #initCause}.
   65        *
   66        * @param   message   the detail message. The detail message is saved for
   67        *          later retrieval by the {@link #getMessage()} method.
   68        */
   69       public Error(String message) {
   70           super(message);
   71       }
   72   
   73       /**
   74        * Constructs a new error with the specified detail message and
   75        * cause.  <p>Note that the detail message associated with
   76        * {@code cause} is <i>not</i> automatically incorporated in
   77        * this error's detail message.
   78        *
   79        * @param  message the detail message (which is saved for later retrieval
   80        *         by the {@link #getMessage()} method).
   81        * @param  cause the cause (which is saved for later retrieval by the
   82        *         {@link #getCause()} method).  (A {@code null} value is
   83        *         permitted, and indicates that the cause is nonexistent or
   84        *         unknown.)
   85        * @since  1.4
   86        */
   87       public Error(String message, Throwable cause) {
   88           super(message, cause);
   89       }
   90   
   91       /**
   92        * Constructs a new error with the specified cause and a detail
   93        * message of {@code (cause==null ? null : cause.toString())} (which
   94        * typically contains the class and detail message of {@code cause}).
   95        * This constructor is useful for errors that are little more than
   96        * wrappers for other throwables.
   97        *
   98        * @param  cause the cause (which is saved for later retrieval by the
   99        *         {@link #getCause()} method).  (A {@code null} value is
  100        *         permitted, and indicates that the cause is nonexistent or
  101        *         unknown.)
  102        * @since  1.4
  103        */
  104       public Error(Throwable cause) {
  105           super(cause);
  106       }
  107   
  108       /**
  109        * Constructs a new error with the specified detail message,
  110        * cause, suppression enabled or disabled, and writable stack
  111        * trace enabled or disabled.
  112        *
  113        * @param  message the detail message.
  114        * @param cause the cause.  (A {@code null} value is permitted,
  115        * and indicates that the cause is nonexistent or unknown.)
  116        * @param enableSuppression whether or not suppression is enabled
  117        *                          or disabled
  118        * @param writableStackTrace whether or not the stack trace should
  119        *                           be writable
  120        *
  121        * @since 1.7
  122        */
  123       protected Error(String message, Throwable cause,
  124                       boolean enableSuppression,
  125                       boolean writableStackTrace) {
  126           super(message, cause, enableSuppression, writableStackTrace);
  127       }
  128   }

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