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;
027
028
029/**
030 * Supertype for all checked doclet exceptions.
031 *
032 * @apiNote This is primarily intended for the benefit of the builder API
033 *  in {@code org.jdrupes.mdoclet.internal.doclets.toolkit.builders}.
034 */
035public class DocletException extends Exception {
036
037    private static final long serialVersionUID = 1L;
038
039    /**
040     * Creates a DocletException with a given detail message.
041     *
042     * The message may or may not be intended for presentation to the end user.
043     *
044     * @param message the detail message.
045     */
046    protected DocletException(String message) {
047        super(message);
048        if (message == null || message.isEmpty()) {
049            throw new IllegalArgumentException();
050        }
051    }
052
053    /**
054     * Creates a DocletException with a given detail message and underlying cause.
055     *
056     * The message may or may not be intended for presentation to the end user.
057     *
058     * @param message the detail message.
059     * @param cause the underlying cause
060     */
061    protected DocletException(String message, Throwable cause) {
062        super(message, cause);
063        if (message == null || message.isEmpty()) {
064            throw new IllegalArgumentException();
065        }
066    }
067}