org.cdmckay.coffeedom.input
Class CoffeeDOMParseException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.cdmckay.coffeedom.CoffeeDOMException
                  extended by org.cdmckay.coffeedom.input.CoffeeDOMParseException
All Implemented Interfaces:
Serializable

public class CoffeeDOMParseException
extends CoffeeDOMException

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

Author:
Laurent Bihanic
See Also:
Serialized Form

Constructor Summary
CoffeeDOMParseException(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.
CoffeeDOMParseException(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
 int getColumnNumber()
          Returns the column number of the end of the text where the parse error occurred.
 int getLineNumber()
          Returns the line number of the end of the text where the parse error occurred.
 Document getPartialDocument()
          Returns the partial document that was successfully built before the error occurred.
 String getPublicId()
          Returns the public identifier of the entity where the parse error occurred.
 String getSystemId()
          Returns the system identifier of the entity where the parse error occurred.
 
Methods inherited from class org.cdmckay.coffeedom.CoffeeDOMException
getCause, getMessage, initCause, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CoffeeDOMParseException

public CoffeeDOMParseException(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.

CoffeeDOMParseException

public CoffeeDOMParseException(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

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.

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.

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.


Copyright © 2011. All Rights Reserved.