001/*
002 * Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package org.jdrupes.mdoclet.internal.doclets.toolkit.util;
027
028import org.jdrupes.mdoclet.internal.doclets.toolkit.DocletException;
029
030
031/**
032 * An exception with a user-friendly detail message.
033 */
034public class SimpleDocletException extends DocletException {
035
036    private static final long serialVersionUID = 1L;
037
038    /**
039     * Creates an exception with a user-friendly detail message.
040     *
041     * @param message a localized detail message, suitable for direct presentation to the end user
042     */
043    public SimpleDocletException(String message) {
044        super(message);
045    }
046
047    /**
048     * Creates an exception with a user-friendly detail message, and underlying cause.
049     * The cause may be used for debugging but in normal use, should not be presented to the user.
050     *
051     * @param message a localized detail message, suitable for direct presentation to the end user
052     * @param cause the underlying cause for the exception
053     */
054    public SimpleDocletException(String message, Throwable cause) {
055        super(message, cause);
056    }
057}