Package com.univocity.parsers.common
Class TextParsingException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.univocity.parsers.common.TextParsingException
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DataProcessingException
Exception type used provide information about any issue that might happen while parsing from a given input.
It generally provides location information about where in the input a parsing error occurred.
- Author:
- Univocity Software Pty Ltd - parsers@univocity.com
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
protected int[]
-
Constructor Summary
ConstructorsConstructorDescriptionTextParsingException
(Context context, String message, Throwable cause) Creates a new exception with information about an error that occurred when parsing some input.TextParsingException
(ParsingContext context) Creates a new exception with information about an error that occurred when parsing some input.TextParsingException
(ParsingContext context, String message) Creates a new exception with information about an error that occurred when parsing some input.TextParsingException
(ParsingContext context, Throwable cause) Creates a new exception with information about an error that occurred when parsing some input. -
Method Summary
Modifier and TypeMethodDescriptionlong
Returns the location of the last character read from before the error occurred.int
Returns the column index where the exception occurred.protected String
Subclasses must implement this method to return as much information as possible about the internal state of the parser/writer.protected String
Returns a generic description of the error.final String[]
Returns the headers processed from the input, if any.long
Returns the line number where the exception occurred.final String
Returns a detailed message describing the error, and the internal state of the parser/writer.final String
Returns the last chunk of content parsed before the error took placelong
Returns the record number when the exception occurred.protected static String
printIfNotEmpty
(String previous, String description, Object o) static String
restrictContent
(int errorContentLength, CharSequence content) static Object[]
restrictContent
(int errorContentLength, Object[] content) protected String
restrictContent
(CharSequence content) protected String
restrictContent
(Object content) protected Object[]
restrictContent
(Object[] content) protected void
setContext
(Context context) void
setErrorContentLength
(int errorContentLength) protected String
updateMessage
(String msg) Allows subclasses to alter the exception message that should be displayed to end users.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
extractedIndexes
protected int[] extractedIndexes -
errorContentLength
protected int errorContentLength
-
-
Constructor Details
-
TextParsingException
Creates a new exception with information about an error that occurred when parsing some input.- Parameters:
context
- the context of the parser when an error occurredmessage
- message with details about the errorcause
- the cause of the error
-
TextParsingException
Creates a new exception with information about an error that occurred when parsing some input.- Parameters:
context
- the context of the parser when an error occurredmessage
- message with details about the error
-
TextParsingException
Creates a new exception with information about an error that occurred when parsing some input.- Parameters:
context
- the context of the parser when an error occurredcause
- the cause of the error
-
TextParsingException
Creates a new exception with information about an error that occurred when parsing some input.- Parameters:
context
- the context of the parser when an error occurred
-
-
Method Details
-
setContext
-
getErrorDescription
Returns a generic description of the error. The result of this method is used byThrowable.getMessage()
to print out a general description of the error before a detailed message of the root cause.- Returns:
- a generic description of the error.
-
getDetails
Subclasses must implement this method to return as much information as possible about the internal state of the parser/writer. UseprintIfNotEmpty(String, String, Object)
to create a comma-separated list of relevant properties and their (non null) values. The result of this method is used by theThrowable.getMessage()
method to print out these details after the error message.- Returns:
- a String describing the internal state of the parser/writer.
-
getRecordNumber
public long getRecordNumber()Returns the record number when the exception occurred.- Returns:
- the record number when the exception occurred.
-
getColumnIndex
public int getColumnIndex()Returns the column index where the exception occurred.- Returns:
- the column index where the exception occurred.
-
getLineIndex
public long getLineIndex()Returns the line number where the exception occurred.- Returns:
- the line number where the exception occurred.
-
getCharIndex
public long getCharIndex()Returns the location of the last character read from before the error occurred.- Returns:
- the location of the last character read from before the error occurred.
-
getParsedContent
Returns the last chunk of content parsed before the error took place- Returns:
- the last chunk of content parsed before the error took place
-
getHeaders
Returns the headers processed from the input, if any.- Returns:
- the headers processed from the input, if any.
-
getMessage
Returns a detailed message describing the error, and the internal state of the parser/writer.- Overrides:
getMessage
in classThrowable
- Returns:
- a detailed message describing the error
-
updateMessage
Allows subclasses to alter the exception message that should be displayed to end users. By default the original message is kept unchanged.- Parameters:
msg
- the original message- Returns:
- the updated message.
-
printIfNotEmpty
-
restrictContent
-
restrictContent
-
setErrorContentLength
public void setErrorContentLength(int errorContentLength) -
restrictContent
-
restrictContent
-
restrictContent
-