Class TextWritingException

All Implemented Interfaces:
Serializable

public class TextWritingException extends AbstractException
Exception type used provide information about any issue that might happen while writing to a given output.

It generally provides location and data information in case of a writing failure.

See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • recordCount

      private final long recordCount
    • recordData

      private final Object[] recordData
    • recordCharacters

      private final String recordCharacters
  • Constructor Details

    • TextWritingException

      private TextWritingException(String message, long recordCount, Object[] row, String recordCharacters, Throwable cause)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      message - message with details about the error
      recordCount - the number of records written until the error occurred
      row - the input row that was being written when the error occurred
      recordCharacters - the characters already written to the output record.
      cause - the cause of the error
    • TextWritingException

      public TextWritingException(String message, long recordCount, String recordCharacters, Throwable cause)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      message - message with details about the error
      recordCount - the number of records written until the error occurred
      recordCharacters - the characters already written to the output record.
      cause - the cause of the error
    • TextWritingException

      public TextWritingException(String message, long recordCount, Object[] row, Throwable cause)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      message - message with details about the error
      recordCount - the number of records written until the error occurred
      row - the input row that was being written when the error occurred
      cause - the cause of the error
    • TextWritingException

      public TextWritingException(String message)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      message - message with details about the error
    • TextWritingException

      public TextWritingException(Throwable cause)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      cause - the cause of the error
    • TextWritingException

      public TextWritingException(String message, long line, Object[] row)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      message - message with details about the error
      line - index of the line being written to the output when the error occurred
      row - the input row that was being written when the error occurred
    • TextWritingException

      public TextWritingException(String message, long line, String recordCharacters)
      Creates a new exception with information about an error that occurred when writing data to some output.
      Parameters:
      message - message with details about the error
      line - index of the line being written to the output when the error occurred
      recordCharacters - the characters already written to the output record.
  • Method Details

    • getRecordCount

      public long getRecordCount()
      Returns the number of records written before the exception occurred.
      Returns:
      the number of records written before the exception occurred.
    • getRecordData

      public Object[] getRecordData()
      Returns the data that failed to be written
      Returns:
      the data that failed to be written
    • getRecordCharacters

      public String getRecordCharacters()
      Returns the character data that failed to be written
      Returns:
      the character data that failed to be written
    • getDetails

      protected String getDetails()
      Description copied from class: AbstractException
      Subclasses must implement this method to return as much information as possible about the internal state of the parser/writer. Use AbstractException.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 AbstractException.getMessage() method to print out these details after the error message.
      Specified by:
      getDetails in class AbstractException
      Returns:
      a String describing the internal state of the parser/writer.
    • getErrorDescription

      protected String getErrorDescription()
      Description copied from class: AbstractException
      Returns a generic description of the error. The result of this method is used by AbstractException.getMessage() to print out a general description of the error before a detailed message of the root cause.
      Specified by:
      getErrorDescription in class AbstractException
      Returns:
      a generic description of the error.