Class HiLiteError

  • All Implemented Interfaces:
    java.io.Serializable

    public class HiLiteError
    extends java.lang.Error
    HiLiteError - Documentation.

    This class is used by the JavaDoc Package to identify when the JavaDoc HiLiter Tool has run into a problem. The nature of these problems stems from improper HTML in the code-comments. An extremely detailed error message explaining how to fix the error in the source code that is having hilited code sections added to it is provided by all places where this error is thrown.
    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

      • HiLiteError

        public HiLiteError()
        Constructs a new HiLiteError with 'null' as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
      • HiLiteError

        public HiLiteError​(java.lang.String message)
        Constructs a new HiLiteError with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
        Parameters:
        message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.
      • HiLiteError

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

        NOTE: The detail message associated with cause is not automatically incorporated in this error's detail message.
        Parameters:
        message - the detail message. The detail message 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.)
      • HiLiteError

        public HiLiteError​(java.lang.Throwable cause)
        Constructs a new HiLiteError 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 errors 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.)