org.jdom.input

Class JDOMParseException

public class JDOMParseException extends JDOMException

Thrown during parse errors, with information about where the parse error occurred as well as access to the partially built document.

Version: $Revision: 1.7 $, $Date: 2004/02/17 02:29:24 $

Author: Laurent Bihanic

Constructor Summary
JDOMParseException(String message, Throwable cause)
This will create a parse Exception with the given message and wrap the Exception that cause a document parse to fail.
JDOMParseException(String message, Throwable cause, Document partialDocument)
This will create a parse Exception with the given message and the partial document and wrap the Exception that cause a document parse to fail.
Method Summary
intgetColumnNumber()
Returns the column number of the end of the text where the parse error occurred.
intgetLineNumber()
Returns the line number of the end of the text where the parse error occurred.
DocumentgetPartialDocument()
Returns the partial document that was successfully built before the error occurred.
StringgetPublicId()
Returns the public identifier of the entity where the parse error occurred.
StringgetSystemId()
Returns the system identifier of the entity where the parse error occurred.

Constructor Detail

JDOMParseException

public JDOMParseException(String message, Throwable cause)
This will create a parse Exception with the given message and wrap the Exception that cause a document parse to fail.

Parameters: message String message indicating the problem that occurred. cause Throwable that caused this to be thrown.

JDOMParseException

public JDOMParseException(String message, Throwable cause, Document partialDocument)
This will create a parse Exception with the given message and the partial document and wrap the Exception that cause a document parse to fail.

Parameters: message String message indicating the problem that occurred. cause Throwable that caused this to be thrown. partialDocument Document the portion of the input XML document that was successfully built.

Method Detail

getColumnNumber

public int getColumnNumber()
Returns the column number of the end of the text where the parse error occurred.

The first column in a line is position 1.

Returns: an integer representing the column number, or -1 if the information is not available.

getLineNumber

public int getLineNumber()
Returns the line number of the end of the text where the parse error occurred.

The first line in the document is line 1.

Returns: an integer representing the line number, or -1 if the information is not available.

getPartialDocument

public Document getPartialDocument()
Returns the partial document that was successfully built before the error occurred.

Returns: the partial document or null if none.

getPublicId

public String getPublicId()
Returns the public identifier of the entity where the parse error occurred.

Returns: a string containing the public identifier, or null if the information is not available.

getSystemId

public String getSystemId()
Returns the system identifier of the entity where the parse error occurred.

Returns: a string containing the system identifier, or null if the information is not available.

Copyright © 2004 Jason Hunter, Brett McLaughlin. All Rights Reserved.