Package Torello.HTML.Tools.JavaDoc

Class JavaDocHTMLParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

Torello.HTML.Tools.JavaDoc.ParseException

Torello.HTML.Tools.JavaDoc.JavaDocHTMLParseException

All Implemented Interfaces:

java.io.Serializable

public class JavaDocHTMLParseException
extends ParseException

Exception when parsing a Java Doc Generated HTML Web-Page File.

This class provides some public final "inspection & convenience" fields which should guarantee to avoid having null values when this Exception is thrown by an internal method. If as a programmer, you intended to extend use of this class, make sure to pass valid-information & valid-data, to the constructors of this class.

If parsing an HTML-file causes an exception to throw, that exception will be wrapped with a JavaDocHTMLParseException. In that case, retrieving the getCause() Throwable to review the Exception Cause Chain will produce the underlying JavaParser-Bridge Exception, or HTML Reader Exception.

See Also:

Serialized Form

Hi-Lited Source-Code:

• View Here: Torello/HTML/Tools/JavaDoc/JavaDocHTMLParseException.java
• Open New Browser-Tab: Torello/HTML/Tools/JavaDoc/JavaDocHTMLParseException.java

File Size: 1,930 Bytes Line Count: 48 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
static long	serialVersionUID

Fields inherited from class Torello.HTML.Tools.JavaDoc.ParseException

signature

Constructor Summary

Constructors

Constructor
JavaDocHTMLParseException(String message, String signature)
JavaDocHTMLParseException(String message, Throwable cause, String signature)

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫

public static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

Note that Java's java.lang.Exception and java.lang.Error classes implement the Serializable interface, and a warning-free build expects this field be defined here.

See Also:

Constant Field Values

Code:

Exact Field Declaration Expression:

 public static final long serialVersionUID = 1;

Constructor Detail

JavaDocHTMLParseException

🡅 🡇 ⇈ ⮫

public JavaDocHTMLParseException(java.lang.String message,
                                 java.lang.String signature)

Constructs a new exception with the specified detail message, and one public, final parameter: srcFileName.

Parameters:

message - the detail message.

signature - This is the "signature" of the entity that failed.

See Also:

ParseException.signature

JavaDocHTMLParseException

🡅 ⇈ ⮫

public JavaDocHTMLParseException(java.lang.String message,
                                 java.lang.Throwable cause,
                                 java.lang.String signature)

Constructs a new exception with the specified detail message, cause-chain throwable, and one public, final parameter: srcFileName.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

signature - This is the "signature" of the entity that failed.

See Also:

ParseException.signature