langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocletException.java
author jjg
Mon, 22 Aug 2016 16:32:40 -0700
changeset 40587 1c355ea550ed
permissions -rw-r--r--
8164130: Simplify doclet IOException handling Reviewed-by: bpatel, ksrini
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
40587
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     1
/*
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     4
 *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    10
 *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    15
 * accompanied this code).
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    16
 *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    20
 *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    23
 * questions.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    24
 */
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    25
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    26
package jdk.javadoc.internal.doclets.toolkit;
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    27
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    28
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    29
/**
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    30
 * Supertype for all checked doclet exceptions.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    31
 *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    32
 * <p><b>This is NOT part of any supported API.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    33
 * If you write code that depends on this, you do so at your own risk.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    34
 * This code and its internal interfaces are subject to change or
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    35
 * deletion without notice.</b>
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    36
 *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    37
 * @apiNote This is primarily intended for the benefit of the builder API
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    38
 *  in {@code jdk.javadoc.internal.doclets.toolkit.builders}.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    39
 */
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    40
public class DocletException extends Exception {
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    41
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    42
    private static final long serialVersionUID = 1L;
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    43
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    44
    /**
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    45
     * Creates a DocletException with a given detail message.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    46
     *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    47
     * The message may or may not be intended for presentation to the end user.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    48
     *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    49
     * @param message the detail message.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    50
     */
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    51
    protected DocletException(String message) {
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    52
        super(message);
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    53
        if (message == null || message.isEmpty()) {
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    54
            throw new IllegalArgumentException();
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    55
        }
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    56
    }
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    57
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    58
    /**
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    59
     * Creates a DocletException with a given detail message and underlying cause.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    60
     *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    61
     * The message may or may not be intended for presentation to the end user.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    62
     *
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    63
     * @param message the detail message.
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    64
     * @param cause the underlying cause
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    65
     */
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    66
    protected DocletException(String message, Throwable cause) {
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    67
        super(message, cause);
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    68
        if (message == null || message.isEmpty()) {
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    69
            throw new IllegalArgumentException();
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    70
        }
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    71
    }
1c355ea550ed 8164130: Simplify doclet IOException handling
jjg
parents:
diff changeset
    72
}