Class JavaDocHTMLParseException

  • All Implemented Interfaces:
    java.io.Serializable

    public class JavaDocHTMLParseException
    extends ParseException
    JavaDocHTMLParseException - Documentation.

    This class provides some public final "inspection & convenience" fields which are guaranteed not to be null when this Exception is thrown by an internal method to the HTML Node-Search package. 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.

    This exception throws when there are errors parsing a '.java' source code file. This exception is used while the internal JavaParser-Bridge is running. If while parsing an HTML-file there is an exception thrown, it will be wrapped with JavaDocHTMLParseException. In that case, retrieving the getCause() Throwable to review the Exception Cause Chain will produce the underlying JavaParser-Bridge Exception. This exception maintains two 'public' String fields that have the signature of the constructor, field or method that was being parsed when the exception threw; and also the name of the source-code file that had a problem.
    See Also:
    Serialized Form



    • 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:
        1
        public static final long serialVersionUID = 1;
        
      • jdHTMLFileName

        public final java.lang.String jdHTMLFileName
        This field is provided to the user as a matter of convenience. All instantiations of this Exception are guaranteed to enforce and ensure that when an instance of this exception is thrown, the convenience field will not be null. If this package is extended, it is up to the programmer/user to make sure not to leave this field null when using one of these constructors. This constructor will not check whether a convenience field is null or not, when constructing the exception.

        IMPORTANT: All this is really trying to explain is that, when debugging your code, if in the analysis of a particular Exception, that analysis causes another exception throw (like NullPointerException) - BECAUSE THIS CONVENIENCE FIELD WAS LEFT NULL - would be an unnecessary source of headache.

        This public final field contains the java-doc generated HTML file-name (as a String) that, when a parse attempt was made, caused an exception to throw.
        Code:
        Exact Field Declaration Expression:
        1
        public final String jdHTMLFileName;
        
      • signature

        public final java.lang.String signature
        This field is provided to the user as a matter of convenience. All instantiations of this Exception are guaranteed to enforce and ensure that when an instance of this exception is thrown, the convenience field will not be null. If this package is extended, it is up to the programmer/user to make sure not to leave this field null when using one of these constructors. This constructor will not check whether a convenience field is null or not, when constructing the exception.

        IMPORTANT: All this is really trying to explain is that, when debugging your code, if in the analysis of a particular Exception, that analysis causes another exception throw (like NullPointerException) - BECAUSE THIS CONVENIENCE FIELD WAS LEFT NULL - would be an unnecessary source of headache.

        This public, final String should contain the exact method, constructor or field-variable that was being parsed when the exception threw. In the event that this information is unknown, a polite message indicating as such will be saved to this field.
        Code:
        Exact Field Declaration Expression:
        1
        public final String signature;
        
    • Constructor Detail

      • JavaDocHTMLParseException

        public JavaDocHTMLParseException​(java.lang.String message,
                                         java.lang.String jdHTMLFileName,
                                         java.lang.String signature)
        Constructs a new exception with the specified detail message, and one public, final parameter: srcFileName.
        Parameters:
        message - the detail message.
        jdHTMLFileName - This public final field contains the source-code file-name (as a String) that, when a parse attempt was made, generated an exception.
        signature - This is the "signature" of the entity that failed.
        See Also:
        jdHTMLFileName, signature
      • JavaDocHTMLParseException

        public JavaDocHTMLParseException​(java.lang.String message,
                                         java.lang.Throwable cause,
                                         java.lang.String jdHTMLFileName,
                                         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.)
        jdHTMLFileName - This public final field contains the source-code file-name (as a String) that, when a parse attempt was made, generated an exception.
        signature - This is the "signature" of the entity that failed.
        See Also:
        jdHTMLFileName, signature