jdk/src/share/classes/java/lang/ClassNotFoundException.java
author darcy
Wed, 15 Jul 2009 12:08:55 -0700
changeset 3311 a219a6c036a6
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
6857789: (reflect) Create common superclass of reflective exceptions Reviewed-by: martin
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1995-2004 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * Thrown when an application tries to load in a class through its
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * string name using:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * <li>The <code>forName</code> method in class <code>Class</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <li>The <code>findSystemClass</code> method in class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *     <code>ClassLoader</code> .
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <li>The <code>loadClass</code> method in class <code>ClassLoader</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * but no definition for the class with the specified name could be found.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <p>As of release 1.4, this exception has been retrofitted to conform to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * the general purpose exception-chaining mechanism.  The "optional exception
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * that was raised while loading the class" that may be provided at
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * construction time and accessed via the {@link #getException()} method is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * now known as the <i>cause</i>, and may be accessed via the {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * Throwable#getCause()} method, as well as the aforementioned "legacy method."
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * @author  unascribed
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * @see     java.lang.Class#forName(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @see     java.lang.ClassLoader#findSystemClass(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @see     java.lang.ClassLoader#loadClass(java.lang.String, boolean)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * @since   JDK1.0
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 */
3311
a219a6c036a6 6857789: (reflect) Create common superclass of reflective exceptions
darcy
parents: 2
diff changeset
    53
public class ClassNotFoundException extends ReflectiveOperationException {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * use serialVersionUID from JDK 1.1.X for interoperability
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     private static final long serialVersionUID = 9176873029745254542L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * This field holds the exception ex if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * ClassNotFoundException(String s, Throwable ex) constructor was
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * used to instantiate the object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * @serial
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    private Throwable ex;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * Constructs a <code>ClassNotFoundException</code> with no detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    public ClassNotFoundException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        super((Throwable)null);  // Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * Constructs a <code>ClassNotFoundException</code> with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * specified detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * @param   s   the detail message.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    public ClassNotFoundException(String s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
        super(s, null);  //  Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * Constructs a <code>ClassNotFoundException</code> with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * specified detail message and optional exception that was
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * raised while loading the class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * @param s the detail message
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     * @param ex the exception that was raised while loading the class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
    public ClassNotFoundException(String s, Throwable ex) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
        super(s, null);  //  Disallow initCause
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
        this.ex = ex;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     * Returns the exception that was raised if an error occurred while
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * attempting to load the class. Otherwise, returns <tt>null</tt>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * <p>This method predates the general-purpose exception chaining facility.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * The {@link Throwable#getCause()} method is now the preferred means of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * obtaining this information.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * @return the <code>Exception</code> that was raised while loading a class
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
    public Throwable getException() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
        return ex;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
     * Returns the cause of this exception (the exception that was raised
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
     * if an error occurred while attempting to load the class; otherwise
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
     * <tt>null</tt>).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     * @return  the cause of this exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * @since   1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
    public Throwable getCause() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
        return ex;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
}