Package Torello.HTML

Class HTMLTokException

  • All Implemented Interfaces:
    java.io.Serializable
    public class HTMLTokException
extends java.lang.IllegalArgumentException
    Used when an invalid, non-HTML, tag or token has been passed to a method.

    For instance, if a programmer accidentally passes the characters 'DVI', instead of 'DIV', to a method that accepts HTML tokens / tags, then this exception would throw.
    See Also:
    Serialized Form


    • Field Summary

       
      Serializable ID
      Modifier and Type Field
      static long serialVersionUID

    • Constructor Summary

      Constructors 
      Constructor Description
      HTMLTokException()
      Constructs an HTMLTokException with no detail message.
      HTMLTokException​(String message)
      Constructs an HTMLTokException with the specified detail message.
      HTMLTokException​(String message, Throwable cause)
      Constructs a new exception with the specified detail message and cause.
      HTMLTokException​(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).

    • Method Summary

       
      'static' Exception Check Methods
      Modifier and Type Method
      static void check​(String... htmlTags)

      • 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;

    • Constructor Detail

      • HTMLTokException

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public HTMLTokException​(java.lang.String message)
        Constructs an HTMLTokException with the specified detail message.
        Parameters:
        message - the detail message.

      • HTMLTokException

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public HTMLTokException​(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 into 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.)

      • HTMLTokException

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        public HTMLTokException​(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 nonexistent or unknown.)

    • Method Detail

      • check

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        public static void check​(java.lang.String... htmlTags)
        This just checks if the passed HTML tok(s) is a valid HTML-element, for instance: img, div, p, a, b, h1, h2, h3 etc...

        It throws an HTMLTokException if an "invalid-String" is passed.
        Parameters:
        htmlTags - This may be any Java String (or strings), but only Java-String's that are found to be valid HTML 4 or 5 tags will be accepted.

        NOTE: Obviously, the '...' notation means multiple tags may be tested. If one is found invalid, an exception is immediately thrown.
        Throws:
        HTMLTokException - if the value passed in the tok parameter is not found in the HTMLTags.isTag(tok); hashtable.
        Code:
        Exact Method Body:
         if (htmlTags.length == 0)
     throw new HTMLTokException
         ("You have passed zero arguments to the variable-length parameter 'htmlTags'");

 else if (htmlTags.length == 1)
 {
     if (htmlTags[0] == null)
         throw new NullPointerException(
             "You have passed null for the value of HTML Tag/Token here, " +
             "but this is not allowed."
         );

     if (! HTMLTags.isTag(htmlTags[0])) throw new HTMLTokException
         ("The HTML-Element provided isn't valid!  tok = [" + htmlTags[0] + "]");
 }

 else
 {
     String tok;
     for (int i=0; i < htmlTags.length; i++)

         if ((tok = htmlTags[i]) == null)
             throw new NullPointerException(
                 "You have passed multiple HTML Tokens, but one of them was null " +
                 "(param #" + i + ").  This is not allowed"
              );

         else if (! HTMLTags.isTag(tok))
             throw new HTMLTokException(
                 "You have passed multiple HTML Tokens, but one of them isn't valid! " +
                 "(param #" + i + "),  tok = [" + tok + "]"
             );
 }