gnu.text
Class SyntaxException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by gnu.text.SyntaxException
All Implemented Interfaces:
java.io.Serializable

public class SyntaxException
extends java.lang.Exception

Used to signal a non-recoverable (fatal) syntax error. Can also be used to signal a syntax error from embedded parsers, such as an eval or execute method, or well-formedness errors when reading an XML document.

See Also:
Serialized Form

Field Summary
 int maxToPrint
           
 
Constructor Summary
SyntaxException(SourceMessages messages)
           
SyntaxException(java.lang.String header, SourceMessages messages)
           
 
Method Summary
 void clear()
           
 java.lang.String getHeader()
          If non-null, an extra one-line message printed before the messages.
 java.lang.String getMessage()
           
 SourceMessages getMessages()
           
 void printAll(java.io.PrintWriter out, int max)
           
 void setHeader(java.lang.String header)
          Set the header returned by getHeader.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, 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

maxToPrint

public int maxToPrint
Constructor Detail

SyntaxException

public SyntaxException(SourceMessages messages)

SyntaxException

public SyntaxException(java.lang.String header,
                       SourceMessages messages)
Method Detail

getHeader

public final java.lang.String getHeader()
If non-null, an extra one-line message printed before the messages. Can be used to provide extra context.


setHeader

public final void setHeader(java.lang.String header)
Set the header returned by getHeader.


getMessages

public SourceMessages getMessages()

printAll

public void printAll(java.io.PrintWriter out,
                     int max)

clear

public void clear()

getMessage

public java.lang.String getMessage()
Overrides:
getMessage in class java.lang.Throwable