Class ParseException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    JavaDocHTMLParseException, SourceCodeParseException
    public abstract class ParseException
extends java.lang.RuntimeException
    Parent class for both SourceCodeParseException and JavaDocHTMLParseException.

    This exception throws when there are errors parsing Java Source Code, or HTML. This exception can be used to mask the internal JavaParser-Bridge Code Exceptions. In that case, retrieving the getCause() Throwable to review the Exception Cause Chain will produce the underlying JavaParser-Bridge Exception, or the problematic HTML Exception.

    An attempt is made to extract the signature of the entity that has caused the exception. If the signature is unknown at the time, this exception's signature convenience-file will simply read: "Signature was unavailable or could not be computed"
    See Also:
    Serialized Form


    • Field Summary

       
      Serializable ID
      Modifier and Type Field
      static long serialVersionUID
       
      'final' Exception Convenience Fields
      Modifier and Type Field
      String signature

    • Constructor Summary

      Constructors 
      Constructor
      ParseException​(String message, String signature)
      ParseException​(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;

      • 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 should guarantee to enforce and ensure that when an instance of this exception is thrown, the convenience field is not set 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.

        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 (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:
         public final String signature;

    • Constructor Detail

      • ParseException

        🡅  🡇  ⇈  ⮫ 
        public ParseException​(java.lang.String message,
                      java.lang.String signature)
        Constructs a new exception with the specified detail message, and one public, final parameter: parseString.
        Parameters:
        message - the detail message.
        signature - This is the "signature" of the entity that failed. Since there will be cases where a signature is not known, a null signature must be replaced with a message explaining so.

      • ParseException

        🡅  ⇈  ⮫ 
        public ParseException​(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: parseString.
        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. Since there will be cases where a signature is not known, a null signature must be replaced with a message explaining so.