001package Torello.Java;
002
003/**
004 * General purpose exception used for poorly formatted {@code String's}, or for any {@code String}
005 * that does not meet some (or any) expected design, protocol, format or criteria.
006 */
007public class StringFormatException extends RuntimeException
008{
009    /** <EMBED CLASS="external-html" DATA-FILE-ID="SVUIDEX">  */
010    public static final long serialVersionUID = 1;
011
012    /** Constructs a {@code StringFormatException} with no detail message. */
013    public StringFormatException()
014    { super(); }
015
016    /**
017     * Constructs a {@code StringFormatException} with the specified detail message.
018     * 
019     * @param message the detail message.
020     */
021    public StringFormatException(String message)
022    { super(message); }
023
024    /**
025     * Constructs a new {@code StringFormatException} with the specified detail message and cause.
026     * 
027     * <BR /><BR /><B>NOTE:</B> The detail message associated with cause is not automatically
028     * incorporated in this exception's detail message.
029     * 
030     * @param message The detail message (which is saved for later retrieval by the
031     * {@code Throwable.getMessage()} method).
032     * 
033     * @param cause the cause (which is saved for later retrieval by the
034     * {@code Throwable.getCause()} method).  (A null value is permitted, and indicates that the
035     * cause is nonexistent or unknown.)
036     */
037    public StringFormatException(String message, Throwable cause)
038    { super(message, cause); }
039
040    /**
041     * Constructs a new {@code StringFormatException} with the specified cause and a detail message
042     * of {@code (cause==null ? null : cause.toString())} (which typically contains the class and
043     * detail message of cause).  This constructor is useful for exceptions that are little more
044     * than wrappers for other throwables.
045     * 
046     * @param cause The cause (which is saved for later retrieval by the
047     * {@code Throwable.getCause()} method).  (A null value is permitted, and indicates that the
048     * cause is nonexistent or unknown.)
049     */
050    public StringFormatException(Throwable cause)
051    { super(cause); }
052}