Package Torello.HTML.Tools.JavaDoc
Class EmbedTagException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- Torello.HTML.Tools.JavaDoc.EmbedTagException
-
- All Implemented Interfaces:
java.io.Serializable
public class EmbedTagException extends java.lang.RuntimeException
EmbedTagException - Documentation.
- See Also:
EmbedTag
, Serialized Form
Hi-Lited Source-Code:
- View Here: Torello/HTML/Tools/JavaDoc/EmbedTagException.java
- Open New Browser-Tab: Torello/HTML/Tools/JavaDoc/EmbedTagException.java
-
-
Field Summary
Fields Modifier and Type Field HTMLNode
embedTag
static long
serialVersionUID
-
Constructor Summary
Constructors Constructor EmbedTagException(HTMLNode embedTag)
EmbedTagException(HTMLNode embedTag, String message)
-
-
-
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;
-
embedTag
public final HTMLNode embedTag
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 HTMLNode
should contain the tag that has caused the exception.- See Also:
EmbedTag
- Code:
- Exact Field Declaration Expression:
1
public final HTMLNode embedTag;
-
-
Constructor Detail
-
EmbedTagException
public EmbedTagException(HTMLNode embedTag)
Constructs anEmbedTagException
with no detail message.- Parameters:
embedTag
- The tag that has caused the exception
-
EmbedTagException
public EmbedTagException(HTMLNode embedTag, java.lang.String message)
Constructs anEmbedTagException
, providing the offending tag, and a detail message about what went wrong.- Parameters:
embedTag
- The tag that caused the exception to throw.
-
-