001package Torello.HTML.Tools.JavaDoc;
002
003/**
004 * Exception when parsing a Java Doc Generated HTML Web-Page File.
005 * 
006 * <BR /><BR /><EMBED CLASS="external-html" DATA-FILE-ID="EXPM">
007 * 
008 * <BR /><BR />If parsing an HTML-file causes an exception to throw, that exception will be wrapped
009 * with a {@code JavaDocHTMLParseException}.  In that case, retrieving the
010 * {@code getCause()} Throwable to review the Exception Cause Chain will produce the underlying
011 * JavaParser-Bridge Exception, or HTML Reader Exception.
012 */
013public class JavaDocHTMLParseException extends ParseException
014{
015    /** <EMBED CLASS="external-html" DATA-FILE-ID="SVUIDEX">  */
016    public static final long serialVersionUID = 1;
017
018    /**
019     * Constructs a new exception with the specified detail message, and one {@code public, final} 
020     * parameter: {@code srcFileName}.
021     * 
022     * @param message the detail message.
023     * 
024     * @param signature This is the "signature" of the entity that failed.
025     * 
026     * @see ParseException#signature
027     */
028    public JavaDocHTMLParseException(String message, String signature)
029    { super(message, signature); }
030
031    /**
032     * Constructs a new exception with the specified detail message, cause-chain throwable, and
033     * one {@code public, final} parameter: {@code srcFileName}.
034     * 
035     * @param message The detail message (which is saved for later retrieval by the
036     * {@code Throwable.getMessage()} method).
037     * 
038     * @param cause the cause (which is saved for later retrieval by the
039     * {@code Throwable.getCause()} method). 
040     * (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
041     * 
042     * @param signature This is the "signature" of the entity that failed.
043     * 
044     * @see ParseException#signature
045     */
046    public JavaDocHTMLParseException(String message, Throwable cause, String signature)
047    { super(message, cause, signature); }
048}