org.extex.core.exception
Class GeneralException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.extex.core.exception.GeneralException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
BackendException, CatcodeException, HelpingException, InterpreterException, MainException, NotObservableException, PanicException, ScannerException, TypesetterException

public class GeneralException
extends java.lang.Exception

This is a base class for exceptions which carry an additional helping text and a processed indicator.

Exception-related rules

Version:
$Revision:5417 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Constructor Summary
GeneralException()
          Creates a new object with the default exit code of -1.
GeneralException(java.lang.String message)
          Creates a new object with the default exit code of -1.
GeneralException(java.lang.String message, java.lang.Throwable cause)
          Creates a new object with the default exit code of -1.
GeneralException(java.lang.Throwable cause)
          Creates a new object with the default exit code of -1.
 
Method Summary
 java.lang.String getHelp()
          Getter for further help information.
protected  Localizer getLocalizer()
          Getter for localizer.
 boolean isProcessed()
          Getter for processed.
 void setProcessed(boolean processed)
          Setter for processed.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GeneralException

public GeneralException()
Creates a new object with the default exit code of -1.


GeneralException

public GeneralException(java.lang.String message)
Creates a new object with the default exit code of -1.

Parameters:
message - the message

GeneralException

public GeneralException(java.lang.String message,
                        java.lang.Throwable cause)
Creates a new object with the default exit code of -1.

Parameters:
message - the message
cause - the cause for a chained exception

GeneralException

public GeneralException(java.lang.Throwable cause)
Creates a new object with the default exit code of -1.

Parameters:
cause - the cause for a chained exception
Method Detail

getHelp

public java.lang.String getHelp()
Getter for further help information.

Returns:
the help information

getLocalizer

protected Localizer getLocalizer()
Getter for localizer.

Returns:
the localizer.

isProcessed

public boolean isProcessed()
Getter for processed.

Returns:
the processed

setProcessed

public void setProcessed(boolean processed)
Setter for processed.

Parameters:
processed - the processed to set