001package Torello.HTML.Tools.JavaDoc;
002
003/**
004 * <CODE>JavaDocError - Documentation.</CODE><BR /><BR />
005 * 
006 * This class is used by the JavaDoc Package to identify when the JavaDoc Documentation
007 * Tool has generated a class that is either not well formatted HTML, or has seemed to 
008 * leave out one of the major sections or summaries on the HTML Page that it has generated.
009 * There have been situations that have come up when extremely complex documentation, sort of,
010 * forced JavaDoc to output a not-so-well-formatted HTML Page.  The resulting HTML Page that
011 * it output actually lacked a proper "Method Summary" section.  Generally, this should not
012 * happen, but if it does, please review the documentation that you have added to your classes.
013 * JavaDoc does not handle Code Documentation with HTML that has added "divider" (DIV) elements.
014 * Sometimes they will work, but occasionally there will be mistakes.
015 */
016public class JavaDocError extends Error
017{
018    /** <EMBED CLASS="external-html" DATA-FILE-ID="SVUIDEX">  */
019    public static final long serialVersionUID = 1;
020
021    /**
022     * Constructs a new {@code JavaDocError} with {@code 'null'} as its detail message. The 
023     * cause is not initialized, and may subsequently be initialized by a call to 
024     * {@code Throwable.initCause(java.lang.Throwable)}.
025     */
026    public JavaDocError()
027    { super(); }
028
029    /**
030     * Constructs a new {@code JavaDocError} with {@code null} as its detail message.  The 
031     * cause is  not initialized, and may subsequently be initialized by a call to 
032     * {@code Throwable.initCause(java.lang.Throwable)}.
033     * 
034     * @param message the detail message. The detail message is saved for later retrieval by 
035     * the {@code Throwable.getMessage()} method.
036     */
037    public JavaDocError(String message)
038    { super(message); }
039
040    /**
041     * Constructs a new {@code JavaDocError} with the specified detail message and cause.
042     * 
043     * <BR /><BR /><B>NOTE:</B> The detail message associated with cause is not 
044     * automatically incorporated in this error's detail message.
045     *
046     * @param message the detail message. The detail message is saved for later retrieval by 
047     * the {@code Throwable.getMessage()} method.
048     * 
049     * @param cause the cause (which is saved for later retrieval by the 
050     * {@code Throwable.getCause()} method). (A null value is permitted, and indicates that the
051     * cause is nonexistent or unknown.)
052     */
053    public JavaDocError(String message, Throwable cause)
054    { super(message, cause); }
055
056    /**
057     * Constructs a new {@code JavaDocError} with the specified cause and a detail message of 
058     * {@code (cause==null ? null : cause.toString())} (which typically contains the
059     * class and detail message of cause). This constructor is useful for errors that
060     * are little more than wrappers for other throwables.
061     * 
062     * @param cause the cause (which is saved for later retrieval by the 
063     * {@code Throwable.getCause()} method). (A null value is permitted, and indicates that 
064     * the cause is nonexistent or unknown.)
065     */
066    public JavaDocError(Throwable cause)
067    { super(cause); }
068}