001package Torello.Java;
002
003/**
004 * This is an exception that occurs when parsing Java Method & Constructor Bodies for the 
005 * JavaDoc Code-HiLiting Application; and it indicates that the method or constructor body passed
006 * to the code-hiliting mechanism is not properly formatted.
007 */
008 public class CallableBodyException extends IllegalArgumentException
009{
010    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUIDEX>  */
011    public static final long serialVersionUID = 1;
012
013    /** Constructs a {@code CallableBodyException} with no detail message. */
014    public CallableBodyException()
015    { super(); }
016
017    /**
018     * Constructs a {@code CallableBodyException} with the specified detail 
019     * {@code 'message'}.
020     * 
021     * @param message A detailed message explaining the error that has occurred.
022     */
023    public CallableBodyException(String message)
024    { super(message); }
025
026    /**
027     * Constructs an {@code CallableBodyException} with the specified detail 
028     * {@code 'message'} and {@code 'cause'}.
029     * 
030     * <BR /><BR /><B CLASS=JDDescLabel>NOTE:</B>
031     * 
032     * <BR /><BR />The detail message associated with cause is not automatically incorporated into
033     * this exception's detail message.
034     * 
035     * @param message the detail message (which is saved for later retrieval by the
036     * {@code Throwable.getMessage()} method).
037     * 
038     * @param cause cause - the cause (which is saved for later retrieval by the
039     * {@code Throwable.getCause()} method). (A null value is permitted, and indicates that the
040     * {@code 'cause'} is nonexistent or unknown.)
041     */
042    public CallableBodyException(String message, Throwable cause)
043    { super(message, cause); }
044
045    /**
046     * Constructs a new exception with the specified {@code 'cause'} and a detail 
047     * {@code 'message'} of {@code (cause==null ? null : cause.toString())}
048     * (which typically contains the class and detail message of cause).
049     * 
050     * @param cause cause - the cause (which is saved for later retrieval by the
051     * {@code Throwable.getCause()} method).  (A null value is permitted, and indicates that the
052     * {@code cause} is nonexistent or unknown.)
053     */
054    public CallableBodyException(Throwable cause)
055    { super(cause); }
056}