1 /*
2  * Copyright (c) 1996, 2019, 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.security;
27 
28 /**
29  * This is the basic key exception.
30  *
31  * @see Key
32  * @see InvalidKeyException
33  * @see KeyManagementException
34  *
35  * @author Benjamin Renaud
36  * @since 1.1
37  */
38 
39 public class KeyException extends GeneralSecurityException {
40 
41     @java.io.Serial
42     private static final long serialVersionUID = -7483676942812432108L;
43 
44     /**
45      * Constructs a KeyException with no detail message. A detail
46      * message is a String that describes this particular exception.
47      */
KeyException()48     public KeyException() {
49         super();
50     }
51 
52     /**
53      * Constructs a KeyException with the specified detail message.
54      * A detail message is a String that describes this particular
55      * exception.
56      *
57      * @param msg the detail message.
58      */
KeyException(String msg)59     public KeyException(String msg) {
60         super(msg);
61     }
62 
63     /**
64      * Creates a {@code KeyException} with the specified
65      * detail message and cause.
66      *
67      * @param message the detail message (which is saved for later retrieval
68      *        by the {@link #getMessage()} method).
69      * @param cause the cause (which is saved for later retrieval by the
70      *        {@link #getCause()} method).  (A {@code null} value is permitted,
71      *        and indicates that the cause is nonexistent or unknown.)
72      * @since 1.5
73      */
KeyException(String message, Throwable cause)74     public KeyException(String message, Throwable cause) {
75         super(message, cause);
76     }
77 
78     /**
79      * Creates a {@code KeyException} with the specified cause
80      * and a detail message of {@code (cause==null ? null : cause.toString())}
81      * (which typically contains the class and detail message of
82      * {@code cause}).
83      *
84      * @param cause the cause (which is saved for later retrieval by the
85      *        {@link #getCause()} method).  (A {@code null} value is permitted,
86      *        and indicates that the cause is nonexistent or unknown.)
87      * @since 1.5
88      */
KeyException(Throwable cause)89     public KeyException(Throwable cause) {
90         super(cause);
91     }
92 }
93