001package Torello.Java;
002
003/**
004 * This class is meant to inform a user that some code-exeuction path has a reached a point where
005 * the developer has not finished writing the Java that needs to run in order to complete whatever
006 * instructions the user is expecting to be run.
007 * 
008 * <BR /><BR />In essence, this is an <I><B>"I'm not finished with this part, yet."</B></I>
009 * Which, generally, is something everyone has been through.  There are times when this is better
010 * than returning bogus or dummy values.
011 */
012public class ToDoException extends RuntimeException
013{
014    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUIDEX>  */
015    public static final long serialVersionUID = 1;
016
017    /** Constructs a {@code ToDoException} with no detail message. */
018    public ToDoException()
019    { super(); }
020
021    /**
022     * Constructs a {@code ToDoException} with the specified detail message.
023     * @param message the detail message.
024     */
025    public ToDoException(String message)
026    { super(message); }
027
028    /**
029     * Constructs a new {@code ToDoException} with the specified detail message and cause.
030     * 
031     * <BR /><BR /><B CLASS=JDDescLabel>NOTE:</B>
032     * 
033     * <BR /><BR />The detail message associated with cause is not automatically incorporated into
034     * this exception's detail message.
035     * 
036     * @param message The detail message (which is saved for later retrieval by the
037     * {@code Throwable.getMessage()} method).
038     * 
039     * @param cause the cause (which is saved for later retrieval by the
040     * {@code Throwable.getCause()} method).  (A null value is permitted, and indicates that the
041     * cause is nonexistent or unknown.)
042     */
043    public ToDoException(String message, Throwable cause)
044    { super(message, cause); }
045
046    /**
047     * Constructs a new {@code ToDoException} with the specified cause and a detail message
048     * of {@code (cause==null ? null : cause.toString())} (which typically contains the class and
049     * detail message of cause).  This constructor is useful for exceptions that are little more
050     * than wrappers for other throwables.
051     * 
052     * @param cause The cause (which is saved for later retrieval by the
053     * {@code Throwable.getCause()} method).  (A null value is permitted, and indicates that the
054     * cause is nonexistent or unknown.)
055     */
056    public ToDoException(Throwable cause)
057    { super(cause); }
058}