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