langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocletException.java
changeset 40587 1c355ea550ed
equal deleted inserted replaced
40519:e17429a7e843 40587:1c355ea550ed
       
     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 
       
    26 package jdk.javadoc.internal.doclets.toolkit;
       
    27 
       
    28 
       
    29 /**
       
    30  * Supertype for all checked doclet exceptions.
       
    31  *
       
    32  * <p><b>This is NOT part of any supported API.
       
    33  * If you write code that depends on this, you do so at your own risk.
       
    34  * This code and its internal interfaces are subject to change or
       
    35  * deletion without notice.</b>
       
    36  *
       
    37  * @apiNote This is primarily intended for the benefit of the builder API
       
    38  *  in {@code jdk.javadoc.internal.doclets.toolkit.builders}.
       
    39  */
       
    40 public class DocletException extends Exception {
       
    41 
       
    42     private static final long serialVersionUID = 1L;
       
    43 
       
    44     /**
       
    45      * Creates a DocletException with a given detail message.
       
    46      *
       
    47      * The message may or may not be intended for presentation to the end user.
       
    48      *
       
    49      * @param message the detail message.
       
    50      */
       
    51     protected DocletException(String message) {
       
    52         super(message);
       
    53         if (message == null || message.isEmpty()) {
       
    54             throw new IllegalArgumentException();
       
    55         }
       
    56     }
       
    57 
       
    58     /**
       
    59      * Creates a DocletException with a given detail message and underlying cause.
       
    60      *
       
    61      * The message may or may not be intended for presentation to the end user.
       
    62      *
       
    63      * @param message the detail message.
       
    64      * @param cause the underlying cause
       
    65      */
       
    66     protected DocletException(String message, Throwable cause) {
       
    67         super(message, cause);
       
    68         if (message == null || message.isEmpty()) {
       
    69             throw new IllegalArgumentException();
       
    70         }
       
    71     }
       
    72 }