Package Torello.HTML.Tools.JavaDoc
Class SourceCodeParseException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- Torello.HTML.Tools.JavaDoc.ParseException
-
- Torello.HTML.Tools.JavaDoc.SourceCodeParseException
-
- All Implemented Interfaces:
java.io.Serializable
public class SourceCodeParseException extends ParseException
SourceCodeParseException - Documentation.
This class provides somepublic final
"inspection & convenience" fields which should guarantee to avoid havingnull
values when thisException
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.
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 an exception is thrown while parsing a source-code file, it will be wrapped with aSourceCodeParseException
. In that case, retrieving thegetCause() 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
Hi-Lited Source-Code:
- View Here: Torello/HTML/Tools/JavaDoc/SourceCodeParseException.java
- Open New Browser-Tab: Torello/HTML/Tools/JavaDoc/SourceCodeParseException.java
-
-
Field Summary
Fields Modifier and Type Field static long
serialVersionUID
String
signature
String
srcFileName
-
Constructor Summary
Constructors Constructor SourceCodeParseException(String message, String srcFileName, String signature)
SourceCodeParseException(String message, Throwable cause, String srcFileName, String signature)
-
-
-
Field Detail
-
serialVersionUID
public static final long serialVersionUID
This fulfils the SerialVersion UID requirement for all classes that implement Java'sinterface java.io.Serializable
. Using theSerializable
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'sjava.lang.Exception
andjava.lang.Error
classes implement theSerializable 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;
-
srcFileName
public final java.lang.String srcFileName
This field is provided to the user as a matter of convenience. All instantiations of thisException
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 isnull
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 particularException
, that analysis causes another exception throw (likeNullPointerException
) - BECAUSE THIS CONVENIENCE FIELD WAS LEFT NULL - would be an unnecessary source of headache.
This public final field contains the source-code file-name (as aString
) that, when a parse attempt was made, caused an exception to throw. If the name of the file was unavailable, a polite message indicating as such will be saved to this field.- Code:
- Exact Field Declaration Expression:
1
public final String srcFileName;
-
signature
public final java.lang.String signature
This field is provided to the user as a matter of convenience. All instantiations of thisException
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 isnull
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 particularException
, that analysis causes another exception throw (likeNullPointerException
) - BECAUSE THIS CONVENIENCE FIELD WAS LEFT NULL - would be an unnecessary source of headache.
Thispublic, 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
-
SourceCodeParseException
public SourceCodeParseException(java.lang.String message, java.lang.String srcFileName, java.lang.String signature)
Constructs a new exception with the specified detail message, and onepublic, final
parameter:srcFileName
.- Parameters:
message
- the detail message.srcFileName
- This public final field contains the source-code file-name (as aString
) that, when a parse attempt was made, generated an exception.signature
- This is the "signature" of the entity that failed.- See Also:
srcFileName
,signature
-
SourceCodeParseException
public SourceCodeParseException(java.lang.String message, java.lang.Throwable cause, java.lang.String srcFileName, java.lang.String signature)
Constructs a new exception with the specified detail message, cause-chain throwable, and onepublic, final
parameter:srcFileName
.- Parameters:
message
- The detail message (which is saved for later retrieval by theThrowable.getMessage()
method).cause
- the cause (which is saved for later retrieval by theThrowable.getCause()
method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)srcFileName
- This public final field contains the source-code file-name (as aString
) that, when a parse attempt was made, generated an exception.signature
- This is the "signature" of the entity that failed.- See Also:
srcFileName
,signature
-
-