Package com.univocity.parsers.common

Class TextWritingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.univocity.parsers.common.AbstractException

com.univocity.parsers.common.TextWritingException

All Implemented Interfaces:

java.io.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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	recordCharacters
private long	recordCount
private java.lang.Object[]	recordData
private static long	serialVersionUID

Fields inherited from class com.univocity.parsers.common.AbstractException

errorContentLength

Constructor Summary

Constructors

Modifier	Constructor	Description
	TextWritingException(java.lang.String message)	Creates a new exception with information about an error that occurred when writing data to some output.
	TextWritingException(java.lang.String message, long line, java.lang.Object[] row)	Creates a new exception with information about an error that occurred when writing data to some output.
private	TextWritingException(java.lang.String message, long recordCount, java.lang.Object[] row, java.lang.String recordCharacters, java.lang.Throwable cause)	Creates a new exception with information about an error that occurred when writing data to some output.
	TextWritingException(java.lang.String message, long recordCount, java.lang.Object[] row, java.lang.Throwable cause)	Creates a new exception with information about an error that occurred when writing data to some output.
	TextWritingException(java.lang.String message, long line, java.lang.String recordCharacters)	Creates a new exception with information about an error that occurred when writing data to some output.
	TextWritingException(java.lang.String message, long recordCount, java.lang.String recordCharacters, java.lang.Throwable cause)	Creates a new exception with information about an error that occurred when writing data to some output.
	TextWritingException(java.lang.Throwable cause)	Creates a new exception with information about an error that occurred when writing data to some output.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	getDetails()	Subclasses must implement this method to return as much information as possible about the internal state of the parser/writer.
protected java.lang.String	getErrorDescription()	Returns a generic description of the error.
java.lang.String	getRecordCharacters()	Returns the character data that failed to be written
long	getRecordCount()	Returns the number of records written before the exception occurred.
java.lang.Object[]	getRecordData()	Returns the data that failed to be written

Methods inherited from class com.univocity.parsers.common.AbstractException

getMessage, printIfNotEmpty, restrictContent, restrictContent, restrictContent, restrictContent, restrictContent, setErrorContentLength, updateMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

recordCount

private final long recordCount

recordData

private final java.lang.Object[] recordData

recordCharacters

private final java.lang.String recordCharacters

Constructor Detail

TextWritingException

private TextWritingException(java.lang.String message,
                             long recordCount,
                             java.lang.Object[] row,
                             java.lang.String recordCharacters,
                             java.lang.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(java.lang.String message,
                            long recordCount,
                            java.lang.String recordCharacters,
                            java.lang.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(java.lang.String message,
                            long recordCount,
                            java.lang.Object[] row,
                            java.lang.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(java.lang.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(java.lang.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(java.lang.String message,
                            long line,
                            java.lang.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(java.lang.String message,
                            long line,
                            java.lang.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 Detail

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 java.lang.Object[] getRecordData()

Returns the data that failed to be written

Returns:

the data that failed to be written

getRecordCharacters

public java.lang.String getRecordCharacters()

Returns the character data that failed to be written

Returns:

the character data that failed to be written

getDetails

protected java.lang.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 java.lang.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.