net.n3.nanoxml
Class XMLException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          net.n3.nanoxml.XMLException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

XMLParseException, XMLValidationException

public class XMLException

extends Exception

An XMLException is thrown when an exception occurred while processing the XML data.

Version:

$Name: RELEASE_2_2_1 $, $Revision: 1.4 $

Author:

Marc De Scheemaecker

See Also:

Serialized Form

Constructor Summary

XMLException(Exception e)
Creates a new exception.

XMLException(String msg)
Creates a new exception.

XMLException(String systemID, int lineNr, Exception e)
Creates a new exception.

XMLException(String systemID, int lineNr, Exception e, String msg, boolean reportParams)
Creates a new exception.

XMLException(String systemID, int lineNr, String msg)
Creates a new exception.

Method Summary

protected void	finalize() Cleans up the object when it's destroyed.
Exception	getException() Returns the encapsulated exception, or null if no exception is encapsulated.
int	getLineNr() Returns the line number in the XML data where the exception occurred.
String	getSystemID() Returns the system ID of the XML data where the exception occurred.
void	printStackTrace() Dumps the exception stack to System.err.
void	printStackTrace(PrintStream stream) Dumps the exception stack to an output stream.
void	printStackTrace(PrintWriter writer) Dumps the exception stack to a print writer.
String	toString() Returns a string representation of the exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLException

public XMLException(String msg)

Creates a new exception.

Parameters:

msg - the message of the exception.

XMLException

public XMLException(Exception e)

Creates a new exception.

Parameters:

e - the encapsulated exception.

XMLException

public XMLException(String systemID,
                    int lineNr,
                    Exception e)

Creates a new exception.

Parameters:

systemID - the system ID of the XML data where the exception occurred

lineNr - the line number in the XML data where the exception occurred.

e - the encapsulated exception.

XMLException

public XMLException(String systemID,
                    int lineNr,
                    String msg)

Creates a new exception.

Parameters:

systemID - the system ID of the XML data where the exception occurred

lineNr - the line number in the XML data where the exception occurred.

msg - the message of the exception.

XMLException

public XMLException(String systemID,
                    int lineNr,
                    Exception e,
                    String msg,
                    boolean reportParams)

Creates a new exception.

Parameters:

systemID - the system ID from where the data came

lineNr - the line number in the XML data where the exception occurred.

e - the encapsulated exception.

msg - the message of the exception.

reportParams - true if the systemID, lineNr and e params need to be appended to the message

Method Detail

finalize

protected void finalize()
                 throws Throwable

Cleans up the object when it's destroyed.

Throws:

Throwable

getSystemID

public String getSystemID()

Returns the system ID of the XML data where the exception occurred. If there is no system ID known, null is returned.

getLineNr

public int getLineNr()

Returns the line number in the XML data where the exception occurred. If there is no line number known, -1 is returned.

getException

public Exception getException()

Returns the encapsulated exception, or null if no exception is encapsulated.

printStackTrace

public void printStackTrace(PrintWriter writer)

Dumps the exception stack to a print writer.

Parameters:

writer - the print writer

printStackTrace

public void printStackTrace(PrintStream stream)

Dumps the exception stack to an output stream.

Parameters:

stream - the output stream

printStackTrace

public void printStackTrace()

Dumps the exception stack to System.err.

toString

public String toString()

Returns a string representation of the exception.