Package Torello.HTML

Class ClosingTagNodeException

  • All Implemented Interfaces:
    java.io.Serializable

    public class ClosingTagNodeException
    extends java.lang.RuntimeException
    ClosingTagNodeException - Documentation.

    This method is used to indicate that a programmer is trying to write attributes to a closing-version of a TagNode. Valid HTML does not allow "Inner Tags" or "Attributes" to be inserted into HTML Elements that begin with the forward-slash (ASCII Character: '/'). The class TagNode has quite a few methods that facilitate saving Inner-Tag Key / Value Pairs to the text-String of a TagNode. In cases where one, mistakenly, is attempting to perform such an insert on a closing version of the element, then this exception must throw.
    See Also:
    Serialized Form



    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method
      static void check​(TagNode tn)
      • 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;
        
    • Constructor Detail

      • ClosingTagNodeException

        public ClosingTagNodeException()
        Constructs a ClosingTagNodeException with no detail message.
      • ClosingTagNodeException

        public ClosingTagNodeException​(java.lang.String message)
        Constructs a ClosingTagNodeException with the specified detail message.
        Parameters:
        message - the detail message.
      • ClosingTagNodeException

        public ClosingTagNodeException​(java.lang.String message,
                                       java.lang.Throwable cause)
        Constructs a new exception with the specified detail message and cause.

        NOTE: The detail message associated with cause is not automatically incorporated in this exception's detail message.
        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 non-existent or unknown.)
      • ClosingTagNodeException

        public ClosingTagNodeException​(java.lang.Throwable cause)
        Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables.
        Parameters:
        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 non-existent or unknown.)
    • Method Detail

      • check

        public static void check​(TagNode tn)
        Checks the input TagNode parameter to ensure that it is a 'Closing HTML Element.' This can be verified by inspecting the public final boolean 'isClosing' field. If the TagNode input does not represent a 'Closing HTML Element', then this exception shall throw.
        Parameters:
        tn - Any HTML TagNode element
        Throws:
        ClosingTagNodeException - This throws if tn.isclosing is FALSE. Exits gracefully otherwise.
        Code:
        Exact Method Body:
        1
        2
        3
        4
        5
        6
        7
        8
         if (! tn.isClosing) return;
        
         throw new ClosingTagNodeException(
             "You have attempted to add, modify, delete, or update the inner-tag key-value pair information " +
             "for this particular HTML Element.  Unfortunately, the value of 'isClosing' for this TagNode is " +
             "TRUE, and therefore may not possess any attribute key-value pairs at all.  NOTE: The '.tok' " +
             "field for this TagNode is: [" + tn.tok + "], and the '.str' field is: [" + tn.str + "]"
         );