Package Torello.Java

Class ToDoException

  • All Implemented Interfaces:
    java.io.Serializable

    public class ToDoException
    extends java.lang.RuntimeException
    ToDoException - Documentation.

    This class needs to be lumped in under the general category of "Assertions" when used. It is meant to inform a user that some code-exeuction path has a reached a point where the developer has not finished writing the Java that needs to run in order to complete whatever instructions the user is expecting to run.

    In essence, this is an "I'm not finished with this part, yet." Which, generally, is something everyone has been through. There are times when this is better than returning bogus or dummy values.
    See Also:
    Serialized Form




    • Method Summary

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • serialVersionUID

        public static final long serialVersionUID
        This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

        Note that Java's java.lang.Exception and java.lang.Error classes implement the Serializable interface, and a warning-free build expects this field be defined here.
        See Also:
        Constant Field Values
        Code:
        Exact Field Declaration Expression:
        1
        public static final long serialVersionUID = 1;
        
    • Constructor Detail

      • ToDoException

        public ToDoException()
        Constructs a ToDoException with no detail message.
      • ToDoException

        public ToDoException​(java.lang.String message)
        Constructs a ToDoException with the specified detail message.
        Parameters:
        message - the detail message.
      • ToDoException

        public ToDoException​(java.lang.String message,
                             java.lang.Throwable cause)
        Constructs a new ToDoException with the specified detail message and cause.

        NOTE: The detail message associated with cause is not automatically incorporated in this exception's detail message.
        Parameters:
        message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method).
        cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
      • ToDoException

        public ToDoException​(java.lang.Throwable cause)
        Constructs a new ToDoException with the specified cause and a detail message of (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.
        Parameters:
        cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)