package Torello.HTML;

/**
 * <CODE>InnerTagValueException - Documentation.</CODE><BR /><BR />
 * 
 * This class is not used internally.  Initially the intent was to check for "new-lines" in HTML
 * attribute-<B STYLE="color: red;">values</B>.  However after looking at some complex java-script
 * listeners, I saw that is actually allowed pretty readily.  Therefore attribute
 * <B STYLE="color: red;">values</B> may contain just about anything.  This package was written for
 * foreign-language news translations and higher-level {@code UTF-8} characters occur inside HTML
 * element inner-tag <B STYLE="color: red;">values</B> all the time.  I have not deleted this yet,
 * perhaps it could be used by a another programmer trying to set his own rules.
 */
public class InnerTagValueException extends IllegalArgumentException
{
    /** <EMBED CLASS="external-html" DATA-FILE-ID="SVUIDEX"> */
    public static final long serialVersionUID = 1;

    /** Constructs an {@code InnerTagValueException} with no detail message. */
    public InnerTagValueException()
    { super(); }

    /**
     * Constructs an {@code InnerTagValueException} with the specified detail message.
     * @param message the detail message.
     */
    public InnerTagValueException(String message)
    { super(message); }

    /**
     * Constructs a new exception with the specified detail message and cause.
     * <BR /><BR /><B>NOTE:</B> The detail message associated with cause is not automatically
     * incorporated in this exception's detail message.
     * @param message The detail message (which is saved for later retrieval by the
     * {@code Throwable.getMessage()} method).
     * @param cause the cause (which is saved for later retrieval by the {@code Throwable.getCause()}
     * method).  (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
     */
    public InnerTagValueException(String message, Throwable cause)
    { super(message, cause); }

    /**
     * Constructs a new exception with the specified cause and a detail message of
     * {@code (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.
     * @param cause The cause (which is saved for later retrieval by the {@code Throwable.getCause()}
     * method).  (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
     */
    public InnerTagValueException(Throwable cause)
    { super(cause); }

    /**
     * This merely performs a "new-line {@code ('\n')}" test.  If a new-line character is found, an
     * exception is thrown.
     * @param value Any Java-{@code String}, but this <B STYLE="color: red;">value</B> is intended to
     * be used in an HTML-Element Attribute-<B STYLE="color: red;">Value</B> Pair as the
     * attribute-<B STYLE="color: red;">value</B> (not the attribute-<B STYLE="color: red;">key</B>).
     * @throws InnerTagValueException If this new-line test fails, this exception is thrown.
     */
    public static void check(String value)
    {
        if (value.indexOf("\n") != -1) throw new InnerTagValueException(
            "The following inner-tag attribute-value contains the newline-character:\n" +
            value.replace("\n", "[\\n]") + "\n"
        );
    }

    /**
     * This performs the identical test as the other method by this same name, but allows for the
     * attribute-<B STYLE="color: red;">key</B> to be included in the Exception's "Error Message"
     * (for reporting purposes only)
     * @param value Any Java-{@code String}, but this <B STYLE="color: red;">value</B> is intended to\
     * be used in an HTML-Element Attribute-<B STYLE="color: red;">Value</B> Pair as the
     * attribute-<B STYLE="color: red;">value</B> (not the attribute-<B STYLE="color: red;">key</B>).
     * @param key This is the key associated with this value.  It is included for "error-reporting'
     * (the exception's Message {@code String}) only!
     * @see #check(String)
     * @throws InnerTagValueException If this new-line test fails, this exception is thrown.
     */
    public static void check(String value, String key)
    {
        if (value.indexOf("\n") != -1) throw new InnerTagValueException(
            "The following inner-tag attribute-value contains the newline-character:\n" +
            "key:\t" + key + "\n" +
            "value:\t" + value.replace("\n", "[\\n]") + "\n"
        );
    }
}