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
public class TextParsingException extends RuntimeException
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 Details

    • extractedIndexes

      protected int[] extractedIndexes

    • errorContentLength

      protected int errorContentLength

  • Constructor Details

    • TextParsingException

      public TextParsingException(Context context, String message, Throwable cause)
      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
      message - message with details about the error
      cause - the cause of the error

    • TextParsingException

      public TextParsingException(ParsingContext context, String message)
      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
      message - message with details about the error

    • TextParsingException

      public TextParsingException(ParsingContext context, Throwable cause)
      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
      cause - the cause of the error

    • TextParsingException

      public TextParsingException(ParsingContext context)
      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

      protected void setContext(Context context)

    • getErrorDescription

      protected String getErrorDescription()
      Returns a generic description of the error. The result of this method is used by Throwable.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

      protected String getDetails()
      Subclasses must implement this method to return as much information as possible about the internal state of the parser/writer. Use printIfNotEmpty(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 the Throwable.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

      public final String 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

      public final String[] getHeaders()
      Returns the headers processed from the input, if any.
      Returns:
      the headers processed from the input, if any.

    • getMessage

      public final String getMessage()
      Returns a detailed message describing the error, and the internal state of the parser/writer.
      Overrides:
      getMessage in class Throwable
      Returns:
      a detailed message describing the error

    • updateMessage

      protected String updateMessage(String msg)
      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

      protected static String printIfNotEmpty(String previous, String description, Object o)

    • restrictContent

      public static String restrictContent(int errorContentLength, CharSequence content)

    • restrictContent

      public static Object[] restrictContent(int errorContentLength, Object[] content)

    • setErrorContentLength

      public void setErrorContentLength(int errorContentLength)

    • restrictContent

      protected String restrictContent(CharSequence content)

    • restrictContent

      protected String restrictContent(Object content)

    • restrictContent

      protected Object[] restrictContent(Object[] content)