Top Description Fields Constructors Methods
com.opencsv.exceptions

public Class CsvConstraintViolationException

extends CsvFieldAssignmentException
Class Inheritance

This exception is thrown when logical connections between data fields would be violated by the imported data.

This can be for constraints like making certain a number is in a certain range, or it can even be thrown by code using opencsv when constraints outside of opencsv would be violated. An example of the latter is importing into a database when one of the field in the CSV is supposed to contain the primary key for a foreign table, but the foreign key cannot be satisfied.

This exception is not currently used by opencsv itself, since opencsv has no concept of what data consistency means in the context of the application using it. It is meant more for custom converters.

Author
Andrew Rucker Jones
Since
3.8

Field Summary

Modifier and TypeField and Description
private static final long
private final transient Object

Constructor Summary

AccessConstructor and Description
public
CsvConstraintViolationException()

Default constructor, in case no further information is necessary or available.

public
CsvConstraintViolationException(Object
The offending source object
sourceObject
)

Constructor for setting the source object that triggered the constraint violation.

public
CsvConstraintViolationException(String
Human-readable error text
message
)

Constructor with a simple text.

public
CsvConstraintViolationException(Object
The offending source object
sourceObject
,
String
Human-readable error text
message
)

Constructor for setting the source object and an error message.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

The source object that triggered the constraint violation
getSourceObject
()

Gets the object that would have caused a constraint violation.

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.opencsv.exceptions.CsvException.serialVersionUID.

sourceObjectback to summary
private final transient Object sourceObject

Constructor Detail

CsvConstraintViolationExceptionback to summary
public CsvConstraintViolationException()

Default constructor, in case no further information is necessary or available.

CsvConstraintViolationExceptionback to summary
public CsvConstraintViolationException(Object sourceObject)

Constructor for setting the source object that triggered the constraint violation.

Parameters
sourceObject:Object

The offending source object

CsvConstraintViolationExceptionback to summary
public CsvConstraintViolationException(String message)

Constructor with a simple text.

Parameters
message:String

Human-readable error text

CsvConstraintViolationExceptionback to summary
public CsvConstraintViolationException(Object sourceObject, String message)

Constructor for setting the source object and an error message.

Parameters
sourceObject:Object

The offending source object

message:String

Human-readable error text

Method Detail

getSourceObjectback to summary
public Object getSourceObject()

Gets the object that would have caused a constraint violation. sourceObject is marked transient, because java.lang.Object is not java.io.Serializable. If for any reason this exception is serialized and deserialized, this method will subsequently return null.

Returns:Object

The source object that triggered the constraint violation