Class ParsingException
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ValidityException
The generic superclass for all the checked exceptions thrown in XOM. The general principle followed is that anything that could plausibly be detected by testing such as using spaces in an element name is a runtime exception. Exceptions that depend on environmental conditions, such as might occur when parsing an external file, are checked exceptions, because these depend on variable input, and thus problems may not all be detected during testing.
- Version:
- 1.1b3
- Author:
- Elliotte Rusty Harold
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionParsingException
(String message) Creates a newParsingException
with a detail message.ParsingException
(String message, int lineNumber, int columnNumber) Creates a newParsingException
with a detail message and line and column numbers.ParsingException
(String message, int lineNumber, int columnNumber, Throwable cause) Creates a newParsingException
with a detail message, line and column numbers, and an underlying exception.ParsingException
(String message, String uri, int lineNumber, int columnNumber) Creates a newParsingException
with a detail message and line and column numbers.ParsingException
(String message, String uri, int lineNumber, int columnNumber, Throwable cause) Creates a newParsingException
with a detail message, line and column numbers, and an underlying exception.ParsingException
(String message, String uri, Throwable cause) Creates a newParsingException
with a detail message and an underlying root cause.ParsingException
(String message, Throwable cause) Creates a newParsingException
with a detail message and an underlying root cause. -
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Returns the underlying exception that caused this exception.int
Returns the approximate column number of the construct that caused this exception.int
Returns the approximate row number of the construct that caused this exception.getURI()
Returns the system ID (generally a URL) of the document that caused this exception.final Throwable
Sets the root cause of this exception.toString()
Returns a string suitable for display to the developer summarizing what went wrong where.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace
-
Constructor Details
-
ParsingException
Creates a new
ParsingException
with a detail message and an underlying root cause.- Parameters:
message
- a string indicating the specific problemcause
- the original cause of this exception
-
ParsingException
Creates a new
ParsingException
with a detail message and an underlying root cause.- Parameters:
message
- a string indicating the specific problemuri
- the URI of the document that caused this exceptioncause
- the original cause of this exception
-
ParsingException
Creates a new
ParsingException
with a detail message and line and column numbers.- Parameters:
message
- a string indicating the specific problemlineNumber
- the approximate line number where the problem occurscolumnNumber
- the approximate column number where the problem occurs
-
ParsingException
Creates a new
ParsingException
with a detail message and line and column numbers.- Parameters:
message
- a string indicating the specific problemuri
- the URI of the document that caused this exceptionlineNumber
- the approximate line number where the problem occurscolumnNumber
- the approximate column number where the problem occurs
-
ParsingException
public ParsingException(String message, String uri, int lineNumber, int columnNumber, Throwable cause) Creates a new
ParsingException
with a detail message, line and column numbers, and an underlying exception.- Parameters:
message
- a string indicating the specific problemuri
- the URI of the document that caused this exceptionlineNumber
- the approximate line number where the problem occurscolumnNumber
- the approximate column number where the problem occurscause
- the original cause of this exception
-
ParsingException
Creates a new
ParsingException
with a detail message, line and column numbers, and an underlying exception.- Parameters:
message
- a string indicating the specific problemlineNumber
- the approximate line number where the problem occurscolumnNumber
- the approximate column number where the problem occurscause
- the original cause of this exception
-
ParsingException
Creates a new
ParsingException
with a detail message.- Parameters:
message
- a string indicating the specific problem
-
-
Method Details
-
getLineNumber
public int getLineNumber()Returns the approximate row number of the construct that caused this exception. If the row number is not known, -1 is returned.
- Returns:
- row number where the exception occurred
-
getColumnNumber
public int getColumnNumber()Returns the approximate column number of the construct that caused this exception. If the column number is not known, -1 is returned.
- Returns:
- column number where the exception occurred
-
getURI
Returns the system ID (generally a URL) of the document that caused this exception. If this is not known, for instance because the document was parsed from a raw input stream or from a string, it returns null.
- Returns:
- the URI of the document that caused this exception
-
initCause
Sets the root cause of this exception. This may only be called once. Subsequent calls throw an
IllegalStateException
.This method is unnecessary in Java 1.4 where it could easily be inherited from the superclass. However, including it here allows this method to be used in Java 1.3 and earlier.
- Overrides:
initCause
in classThrowable
- Parameters:
cause
- the root cause of this exception- Returns:
- this
XMLException
- Throws:
IllegalArgumentException
- if the cause is this exception (An exception cannot be its own cause.)IllegalStateException
- if this method is called twice
-
getCause
Returns the underlying exception that caused this exception.
-
toString
Returns a string suitable for display to the developer summarizing what went wrong where.
-