1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

package Torello.HTML.Tools.JavaDoc;

/**
 * <CODE>JavaDocError - Documentation.</CODE><BR /><BR />
 * 
 * This class is used by the JavaDoc Package to identify when the JavaDoc Documentation
 * Tool has generated a class that is either not well formatted HTML, or has seemed to 
 * leave out one of the major sections or summaries on the HTML Page that it has generated.
 * There have been situations that have come up when extremely complex documentation, sort of,
 * forced JavaDoc to output a not-so-well-formatted HTML Page.  The resulting HTML Page that
 * it output actually lacked a proper "Method Summary" section.  Generally, this should not
 * happen, but if it does, please review the documentation that you have added to your classes.
 * JavaDoc does not handle Code Documentation with HTML that has added "divider" (DIV) elements.
 * Sometimes they will work, but occasionally there will be mistakes.
 */
public class JavaDocError extends Error
{
    /** <EMBED CLASS="external-html" DATA-FILE-ID="SVUIDEX">  */
    public static final long serialVersionUID = 1;

    /**
     * Constructs a new {@code JavaDocError} with {@code 'null'} as its detail message. The 
     * cause is not initialized, and may subsequently be initialized by a call to 
     * {@code Throwable.initCause(java.lang.Throwable)}.
     */
    public JavaDocError()
    { super(); }

    /**
     * Constructs a new {@code JavaDocError} with {@code null} as its detail message.  The 
     * cause is  not initialized, and may subsequently be initialized by a call to 
     * {@code Throwable.initCause(java.lang.Throwable)}.
     * 
     * @param message the detail message. The detail message is saved for later retrieval by 
     * the {@code Throwable.getMessage()} method.
     */
    public JavaDocError(String message)
    { super(message); }

    /**
     * Constructs a new {@code JavaDocError} with the specified detail message and cause.
     * 
     * <BR /><BR /><B>NOTE:</B> The detail message associated with cause is not 
     * automatically incorporated in this error's detail message.
     *
     * @param message the detail message. The detail message is saved for later retrieval by 
     * the {@code Throwable.getMessage()} method.
     * 
     * @param cause the cause (which is saved for later retrieval by the 
     * {@code Throwable.getCause()} method). (A null value is permitted, and indicates that the
     * cause is nonexistent or unknown.)
     */
    public JavaDocError(String message, Throwable cause)
    { super(message, cause); }

    /**
     * Constructs a new {@code JavaDocError} with the specified cause and a detail message of 
     * {@code (cause==null ? null : cause.toString())} (which typically contains the
     * class and detail message of cause). This constructor is useful for errors that
     * are little more than wrappers for other throwables.
     * 
     * @param cause the cause (which is saved for later retrieval by the 
     * {@code Throwable.getCause()} method). (A null value is permitted, and indicates that 
     * the cause is nonexistent or unknown.)
     */
    public JavaDocError(Throwable cause)
    { super(cause); }
}