1/*
2 * Copyright (c) 2016, 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
26package jdk.javadoc.internal.doclets.toolkit.util;
27
28import jdk.javadoc.internal.doclets.toolkit.DocletException;
29
30
31/**
32 * An exception with a user-friendly detail message.
33 *
34 * <p><b>This is NOT part of any supported API.
35 * If you write code that depends on this, you do so at your own risk.
36 * This code and its internal interfaces are subject to change or
37 * deletion without notice.</b>
38 */
39public class SimpleDocletException extends DocletException {
40
41    private static final long serialVersionUID = 1L;
42
43    /**
44     * Creates an exception with a user-friendly detail message.
45     *
46     * @param message a localized detail message, suitable for direct presentation to the end user
47     */
48    public SimpleDocletException(String message) {
49        super(message);
50    }
51
52    /**
53     * Creates an exception with a user-friendly detail message, and underlying cause.
54     * The cause may be used for debugging but in normal use, should not be presented to the user.
55     *
56     * @param message a localized detail message, suitable for direct presentation to the end user
57     * @param cause the underlying cause for the exception
58     */
59    public SimpleDocletException(String message, Throwable cause) {
60        super(message, cause);
61    }
62}
63